Package org.opencms.workplace.editors

Class 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.

    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsWorkplaceEditorConfiguration​(byte[] xmlData, java.lang.String editorUri, java.lang.String name)
      Constructor with xml data String.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsWorkplaceEditorConfiguration

        public CmsWorkplaceEditorConfiguration​(byte[] xmlData,
                                       java.lang.String editorUri,
                                       java.lang.String name)
        Constructor with xml data String.

        Parameters:
        xmlData - the XML data String containing the information about the editor
        editorUri - the editor workplace URI
        name - the editor configuration name

    • Method Detail

      • getBrowserPattern

        public java.util.List<java.util.regex.Pattern> getBrowserPattern()
        Returns the list of compiled browser patterns.

        Returns:
        the list of compiled browser patterns

      • getEditorLabel

        public java.lang.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 java.lang.String getEditorUri()
        Returns the editor workplace URI.

        Returns:
        the editor workplace URI

      • getMappingForResourceType

        public java.lang.String getMappingForResourceType​(java.lang.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

      • getName

        public java.lang.String getName()
        Gets the name of the editor configuration (usually the folder name under /system/workplace/editors).

        Returns:
        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.

        Returns:
        the editor parameter map

      • getRankingForResourceType

        public float getRankingForResourceType​(java.lang.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 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

        Returns:
        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.

        Returns:
        the valid user agents regular expressions of the editor

      • getWidgetEditor

        public java.lang.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​(java.lang.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​(java.lang.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