org.opencms.workplace.editors
Class CmsWorkplaceEditorConfiguration

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

public class CmsWorkplaceEditorConfiguration
extends 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.

Since:

6.0.0

Version:

$Revision: 1.14 $

Author:

Andreas Zahner

Field Summary

static String	DOCUMENT_NODE Name of the root document node.
protected static String	N_AGENT Name of the single user agent node.
protected static String	N_CLASS Name of the resource type class node.
protected static String	N_LABEL Name of the editor label node.
protected static String	N_MAPTO Name of the resource type subnode mapto.
protected static String	N_NAME Name of the resource type subnode name.
protected static String	N_RANKING Name of the resource type subnode ranking.
protected static String	N_RESOURCETYPES Name of the resourcetypes node.
protected static String	N_TYPE Name of the resource type node.
protected static String	N_USERAGENTS Name of the useragents node.
protected static String	N_WIDGETEDITOR Name of the widgeteditor node.

Constructor Summary

CmsWorkplaceEditorConfiguration(byte[] xmlData, String editorUri)
Constructor with xml data String.

Method Summary

List	getBrowserPattern() Returns the list of compiled browser patterns.
String	getEditorLabel() Returns the editor label key used for the localized nice name.
String	getEditorUri() Returns the editor workplace URI.
String	getMappingForResourceType(String resourceType) Returns the mapping for the given resource type.
float	getRankingForResourceType(String resourceType) Returns the ranking value for the given resource type.
Map	getResourceTypes() Returns the valid resource types of the editor.
List	getUserAgentsRegEx() Returns the valid user agents regular expressions of the editor.
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(String currentBrowser) Tests if the current browser is matching the configuration.
boolean	matchesResourceType(String resourceType) Returns if the configuration is suitable for the given resource type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENT_NODE

public static final String DOCUMENT_NODE

Name of the root document node.

See Also:

Constant Field Values

N_AGENT

protected static final String N_AGENT

Name of the single user agent node.

See Also:

Constant Field Values

N_CLASS

protected static final String N_CLASS

Name of the resource type class node.

See Also:

Constant Field Values

N_LABEL

protected static final String N_LABEL

Name of the editor label node.

See Also:

Constant Field Values

N_MAPTO

protected static final String N_MAPTO

Name of the resource type subnode mapto.

See Also:

Constant Field Values

N_NAME

protected static final String N_NAME

Name of the resource type subnode name.

See Also:

Constant Field Values

N_RANKING

protected static final String N_RANKING

Name of the resource type subnode ranking.

See Also:

Constant Field Values

N_RESOURCETYPES

protected static final String N_RESOURCETYPES

Name of the resourcetypes node.

See Also:

Constant Field Values

N_TYPE

protected static final String N_TYPE

Name of the resource type node.

See Also:

Constant Field Values

N_USERAGENTS

protected static final String N_USERAGENTS

Name of the useragents node.

See Also:

Constant Field Values

N_WIDGETEDITOR

protected static final String N_WIDGETEDITOR

Name of the widgeteditor node.

See Also:

Constant Field Values

Constructor Detail

CmsWorkplaceEditorConfiguration

public CmsWorkplaceEditorConfiguration(byte[] xmlData,
                                       String editorUri)

Constructor with xml data String.

Parameters:

xmlData - the XML data String containing the information about the editor

editorUri - the editor workplace URI

Method Detail

getBrowserPattern

public List getBrowserPattern()

Returns the list of compiled browser patterns.

Returns:

the list of compiled browser patterns

getEditorLabel

public String getEditorLabel()

Returns the editor label key used for the localized nice name.

Returns:

the editor label key used for the localized nice name

getEditorUri

public String getEditorUri()

Returns the editor workplace URI.

Returns:

the editor workplace URI

getMappingForResourceType

public String getMappingForResourceType(String resourceType)

Returns the mapping for the given resource type.

Parameters:

resourceType - the resource type name to check

Returns:

the mapping or null, if no mapping is specified

getRankingForResourceType

public float getRankingForResourceType(String resourceType)

Returns the ranking value for the given resource type.

Parameters:

resourceType - the current resource type

Returns:

the ranking (the higher the better)

getResourceTypes

public Map 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

Returns:

the valid resource types of the editor

getUserAgentsRegEx

public List getUserAgentsRegEx()

Returns the valid user agents regular expressions of the editor.

Returns:

the valid user agents regular expressions of the editor

getWidgetEditor

public String getWidgetEditor()

Returns the widget editor class for rich text editing.

Returns:

the widget editor class for rich text editing

isValidConfiguration

public boolean isValidConfiguration()

Returns if the current configuration is valid.

Returns:

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.

Returns:

true if the editor is usable as a widget editor for rich text editing, otherwise false

matchesBrowser

public boolean matchesBrowser(String currentBrowser)

Tests if the current browser is matching the configuration.

Parameters:

currentBrowser - the users browser String to test

Returns:

true if the browser matches the configuration, otherwise false

matchesResourceType

public boolean matchesResourceType(String resourceType)

Returns if the configuration is suitable for the given resource type.

Parameters:

resourceType - the resource type to check

Returns:

true if the configuration matches the resource type