Package org.opencms.ade.containerpage.shared

Class CmsFormatterConfig

java.lang.Object
org.opencms.ade.containerpage.shared.CmsFormatterConfig
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public class CmsFormatterConfig extends Object implements com.google.gwt.user.client.rpc.IsSerializable
Formatter configuration data.

  • Field Details

  • Constructor Details

  • Method Details

    • getSettingsKeyForContainer

      public static String getSettingsKeyForContainer(String containerName)
      Returns the formatter configuration settings key for the given container name.

      Parameters:
      containerName - the container name
      Returns:
      the settings key

    • getCssResources

      public Set<String> getCssResources()
      Returns the required CSS resources.

      Returns:
      the CSS resources

    • getDescription

      public String getDescription()
      Gets the description.

      Returns:
      the description

    • getId

      public String getId()
      Returns the formatter configuration id.

      Returns:
      the configuration id

    • getInlineCss

      public String getInlineCss()
      Returns the inline CSS.

      Returns:
      the inline CSS

    • getJspRootPath

      public String getJspRootPath()
      Returns the formatter root path.

      Returns:
      the formatter root path

    • getKey

      public String getKey()

    • getKeyOrId

      public String getKeyOrId()

    • getLabel

      public String getLabel()
      Returns the formatter label.

      Returns:
      the label

    • getNestedFormatterPrefixes

      public Map<String,String> getNestedFormatterPrefixes()
      Returns the nested formatters prefixes and their labels.

      Returns:
      the nested formatters prefixes and their labels

    • getSettingConfig

      public Map<String,CmsXmlContentProperty> getSettingConfig()
      Returns the settings configuration.

      Returns:
      the settings configuration

    • hasInlineCss

      public boolean hasInlineCss()
      Returns if the formatter has inline CSS.

      Returns:
      true if the formatter has inline CSS

    • setCssResources

      public void setCssResources(Set<String> cssResources)
      Sets the required CSS resources.

      Parameters:
      cssResources - the CSS resources

    • setDescription

      public void setDescription(String description)
      Sets the description.

      Parameters:
      description - the description

    • setInlineCss

      public void setInlineCss(String inlineCss)
      Sets the inline CSS.

      Parameters:
      inlineCss - the inline CSS

    • setJspRootPath

      public void setJspRootPath(String jspRootPath)
      Sets the formatter root path.

      Parameters:
      jspRootPath - the formatter root path

    • setKey

      public void setKey(String key)

    • setLabel

      public void setLabel(String label)
      Sets the formatter label.

      Parameters:
      label - the label

    • setNestedFormatterPrefixes

      public void setNestedFormatterPrefixes(Map<String,String> nestedFormatterPrefixes)
      Sets the nested formatters prefixes and their labels.

      Parameters:
      nestedFormatterPrefixes - the nested formatters prefixes and their labels to set

    • setSettingConfig

      public void setSettingConfig(Map<String,CmsXmlContentProperty> settingConfig)
      Sets the settings configuration.

      Parameters:
      settingConfig - the settings configuration