CmsWorkplaceEditorConfiguration

java.lang.Object
- org.opencms.workplace.editors.CmsWorkplaceEditorConfiguration

```
public class CmsWorkplaceEditorConfiguration
extends java.lang.Object
```
Single editor configuration object.
Holds all necessary information about an OpenCms editor which is stored in the "editor_configuration.xml" file in each editor folder.
Provides methods to get the editor information for the editor manager.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`protected static java.lang.String`	`A_NAME` Name of the name attribute.
`static java.lang.String`	`DOCUMENT_NODE` Name of the root document node.
`protected static java.lang.String`	`N_AGENT` Name of the single user agent node.
`protected static java.lang.String`	`N_CLASS` Name of the resource type class node.
`protected static java.lang.String`	`N_LABEL` Name of the editor label node.
`protected static java.lang.String`	`N_MAPTO` Name of the resource type subnode mapto.
`protected static java.lang.String`	`N_NAME` Name of the resource type subnode name.
`protected static java.lang.String`	`N_PARAM` Name of the param node.
`protected static java.lang.String`	`N_PARAMS` Name of the params node.
`protected static java.lang.String`	`N_RANKING` Name of the resource type subnode ranking.
`protected static java.lang.String`	`N_RESOURCETYPES` Name of the resourcetypes node.
`protected static java.lang.String`	`N_TYPE` Name of the resource type node.
`protected static java.lang.String`	`N_USERAGENTS` Name of the useragents node.
`protected static java.lang.String`	`N_WIDGETEDITOR` Name of the widgeteditor node.

构造器概要

构造器
构造器和说明
`CmsWorkplaceEditorConfiguration(byte[] xmlData, java.lang.String editorUri, java.lang.String name)` Constructor with xml data String.

方法概要

方法
限定符和类型	方法和说明
`java.util.List<java.util.regex.Pattern>`	`getBrowserPattern()` Returns the list of compiled browser patterns.
`java.lang.String`	`getEditorLabel()` Returns the editor label key used for the localized nice name.
`java.lang.String`	`getEditorUri()` Returns the editor workplace URI.
`java.lang.String`	`getMappingForResourceType(java.lang.String resourceType)` Returns the mapping for the given resource type.
`java.lang.String`	`getName()` Gets the name of the editor configuration (usually the folder name under /system/workplace/editors).
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()` Gets the map of additional editor parameters.
`float`	`getRankingForResourceType(java.lang.String resourceType)` Returns the ranking value for the given resource type.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getResourceTypes()` Returns the valid resource types of the editor.
`java.util.List<java.lang.String>`	`getUserAgentsRegEx()` Returns the valid user agents regular expressions of the editor.
`java.lang.String`	`getWidgetEditor()` Returns the widget editor class for rich text editing.
`boolean`	`isValidConfiguration()` Returns if the current configuration is valid.
`boolean`	`isWidgetEditor()` Returns if the editor is usable as a widget editor for rich text editing.
`boolean`	`matchesBrowser(java.lang.String currentBrowser)` Tests if the current browser is matching the configuration.
`boolean`	`matchesResourceType(java.lang.String resourceType)` Returns if the configuration is suitable for the given resource type.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DOCUMENT_NODE
```
public static final java.lang.String DOCUMENT_NODE
```
    Name of the root document node.
    
    另请参阅:
    常量字段值
  - A_NAME
```
protected static final java.lang.String A_NAME
```
    Name of the name attribute.
    
    另请参阅:
    常量字段值
  - N_AGENT
```
protected static final java.lang.String N_AGENT
```
    Name of the single user agent node.
    
    另请参阅:
    常量字段值
  - N_CLASS
```
protected static final java.lang.String N_CLASS
```
    Name of the resource type class node.
    
    另请参阅:
    常量字段值
  - N_LABEL
```
protected static final java.lang.String N_LABEL
```
    Name of the editor label node.
    
    另请参阅:
    常量字段值
  - N_MAPTO
```
protected static final java.lang.String N_MAPTO
```
    Name of the resource type subnode mapto.
    
    另请参阅:
    常量字段值
  - N_NAME
```
protected static final java.lang.String N_NAME
```
    Name of the resource type subnode name.
    
    另请参阅:
    常量字段值
  - N_PARAM
```
protected static final java.lang.String N_PARAM
```
    Name of the param node.
    
    另请参阅:
    常量字段值
  - N_PARAMS
```
protected static final java.lang.String N_PARAMS
```
    Name of the params node.
    
    另请参阅:
    常量字段值
  - N_RANKING
```
protected static final java.lang.String N_RANKING
```
    Name of the resource type subnode ranking.
    
    另请参阅:
    常量字段值
  - N_RESOURCETYPES
```
protected static final java.lang.String N_RESOURCETYPES
```
    Name of the resourcetypes node.
    
    另请参阅:
    常量字段值
  - N_TYPE
```
protected static final java.lang.String N_TYPE
```
    Name of the resource type node.
    
    另请参阅:
    常量字段值
  - N_USERAGENTS
```
protected static final java.lang.String N_USERAGENTS
```
    Name of the useragents node.
    
    另请参阅:
    常量字段值
  - N_WIDGETEDITOR
```
protected static final java.lang.String N_WIDGETEDITOR
```
    Name of the widgeteditor node.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsWorkplaceEditorConfiguration
```
public CmsWorkplaceEditorConfiguration(byte[] xmlData,
                               java.lang.String editorUri,
                               java.lang.String name)
```
    Constructor with xml data String.
    
    参数:
    xmlData - the XML data String containing the information about the editor
    editorUri - the editor workplace URI
    name - the editor configuration name
- 方法详细资料
  - getBrowserPattern
```
public java.util.List<java.util.regex.Pattern> getBrowserPattern()
```
    Returns the list of compiled browser patterns.
    
    返回:
    the list of compiled browser patterns
  - getEditorLabel
```
public java.lang.String getEditorLabel()
```
    Returns the editor label key used for the localized nice name.
    
    返回:
    the editor label key used for the localized nice name
  - getEditorUri
```
public java.lang.String getEditorUri()
```
    Returns the editor workplace URI.
    
    返回:
    the editor workplace URI
  - getMappingForResourceType
```
public java.lang.String getMappingForResourceType(java.lang.String resourceType)
```
    Returns the mapping for the given resource type.
    
    参数:
    resourceType - the resource type name to check
    
    返回:
    the mapping or null, if no mapping is specified
  - getName
```
public java.lang.String getName()
```
    Gets the name of the editor configuration (usually the folder name under /system/workplace/editors).
    
    返回:
    the name of the editor configuration
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Gets the map of additional editor parameters.
    
    返回:
    the editor parameter map
  - getRankingForResourceType
```
public float getRankingForResourceType(java.lang.String resourceType)
```
    Returns the ranking value for the given resource type.
    
    参数:
    resourceType - the current resource type
    
    返回:
    the ranking (the higher the better)
  - getResourceTypes
```
public java.util.Map<java.lang.String,java.lang.String[]> getResourceTypes()
```
    Returns the valid resource types of the editor.
    A single map item has the resource type name as key, the value is a String array with two entries:
    - Entry 0: the ranking for the resource type
    - Entry 1: the mapping to another resource type or null
    返回:
    the valid resource types of the editor
  - getUserAgentsRegEx
```
public java.util.List<java.lang.String> getUserAgentsRegEx()
```
    Returns the valid user agents regular expressions of the editor.
    
    返回:
    the valid user agents regular expressions of the editor
  - getWidgetEditor
```
public java.lang.String getWidgetEditor()
```
    Returns the widget editor class for rich text editing.
    
    返回:
    the widget editor class for rich text editing
  - isValidConfiguration
```
public boolean isValidConfiguration()
```
    Returns if the current configuration is valid.
    
    返回:
    true if no configuration errors were found, otherwise false
  - isWidgetEditor
```
public boolean isWidgetEditor()
```
    Returns if the editor is usable as a widget editor for rich text editing.
    
    返回:
    true if the editor is usable as a widget editor for rich text editing, otherwise false
  - matchesBrowser
```
public boolean matchesBrowser(java.lang.String currentBrowser)
```
    Tests if the current browser is matching the configuration.
    
    参数:
    currentBrowser - the users browser String to test
    
    返回:
    true if the browser matches the configuration, otherwise false
  - matchesResourceType
```
public boolean matchesResourceType(java.lang.String resourceType)
```
    Returns if the configuration is suitable for the given resource type.
    
    参数:
    resourceType - the resource type to check
    
    返回:
    true if the configuration matches the resource type

类 CmsWorkplaceEditorConfiguration

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DOCUMENT_NODE

A_NAME

N_AGENT

N_CLASS

N_LABEL

N_MAPTO

N_NAME

N_PARAM

N_PARAMS

N_RANKING

N_RESOURCETYPES

N_TYPE

N_USERAGENTS

N_WIDGETEDITOR

构造器详细资料

CmsWorkplaceEditorConfiguration

方法详细资料

getBrowserPattern

getEditorLabel

getEditorUri

getMappingForResourceType

getName

getParameters

getRankingForResourceType

getResourceTypes

getUserAgentsRegEx

getWidgetEditor

isValidConfiguration

isWidgetEditor

matchesBrowser

matchesResourceType