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 java.lang.Object implements com.google.gwt.user.client.rpc.IsSerializable
Formatter configuration data.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FORMATTER_SETTINGS_KEY
Key for the formatter configuration id setting.static java.lang.String
SCHEMA_FORMATTER_ID
Id used for schema based formatters.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsFormatterConfig()
Constructor for serialization only.CmsFormatterConfig(java.lang.String id)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<java.lang.String>
getCssResources()
Returns the required CSS resources.java.lang.String
getDescription()
Gets the description.java.lang.String
getId()
Returns the formatter configuration id.java.lang.String
getInlineCss()
Returns the inline CSS.java.lang.String
getJspRootPath()
Returns the formatter root path.java.lang.String
getKey()
java.lang.String
getKeyOrId()
java.lang.String
getLabel()
Returns the formatter label.java.util.Map<java.lang.String,java.lang.String>
getNestedFormatterPrefixes()
Returns the nested formatters prefixes and their labels.java.util.Map<java.lang.String,CmsXmlContentProperty>
getSettingConfig()
Returns the settings configuration.static java.lang.String
getSettingsKeyForContainer(java.lang.String containerName)
Returns the formatter configuration settings key for the given container name.boolean
hasInlineCss()
Returns if the formatter has inline CSS.void
setCssResources(java.util.Set<java.lang.String> cssResources)
Sets the required CSS resources.void
setDescription(java.lang.String description)
Sets the description.void
setInlineCss(java.lang.String inlineCss)
Sets the inline CSS.void
setJspRootPath(java.lang.String jspRootPath)
Sets the formatter root path.void
setKey(java.lang.String key)
void
setLabel(java.lang.String label)
Sets the formatter label.void
setNestedFormatterPrefixes(java.util.Map<java.lang.String,java.lang.String> nestedFormatterPrefixes)
Sets the nested formatters prefixes and their labels.void
setSettingConfig(java.util.Map<java.lang.String,CmsXmlContentProperty> settingConfig)
Sets the settings configuration.
-
-
-
Field Detail
-
FORMATTER_SETTINGS_KEY
public static final java.lang.String FORMATTER_SETTINGS_KEY
Key for the formatter configuration id setting. Append the container name to the key, to store container depending values.- See Also:
- Constant Field Values
-
SCHEMA_FORMATTER_ID
public static final java.lang.String SCHEMA_FORMATTER_ID
Id used for schema based formatters.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsFormatterConfig
public CmsFormatterConfig(java.lang.String id)
Constructor.- Parameters:
id
- the formatter id
-
CmsFormatterConfig
protected CmsFormatterConfig()
Constructor for serialization only.
-
-
Method Detail
-
getSettingsKeyForContainer
public static java.lang.String getSettingsKeyForContainer(java.lang.String containerName)
Returns the formatter configuration settings key for the given container name.- Parameters:
containerName
- the container name- Returns:
- the settings key
-
getCssResources
public java.util.Set<java.lang.String> getCssResources()
Returns the required CSS resources.- Returns:
- the CSS resources
-
getDescription
public java.lang.String getDescription()
Gets the description.- Returns:
- the description
-
getId
public java.lang.String getId()
Returns the formatter configuration id.- Returns:
- the configuration id
-
getInlineCss
public java.lang.String getInlineCss()
Returns the inline CSS.- Returns:
- the inline CSS
-
getJspRootPath
public java.lang.String getJspRootPath()
Returns the formatter root path.- Returns:
- the formatter root path
-
getKey
public java.lang.String getKey()
-
getKeyOrId
public java.lang.String getKeyOrId()
-
getLabel
public java.lang.String getLabel()
Returns the formatter label.- Returns:
- the label
-
getNestedFormatterPrefixes
public java.util.Map<java.lang.String,java.lang.String> getNestedFormatterPrefixes()
Returns the nested formatters prefixes and their labels.- Returns:
- the nested formatters prefixes and their labels
-
getSettingConfig
public java.util.Map<java.lang.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(java.util.Set<java.lang.String> cssResources)
Sets the required CSS resources.- Parameters:
cssResources
- the CSS resources
-
setDescription
public void setDescription(java.lang.String description)
Sets the description.- Parameters:
description
- the description
-
setInlineCss
public void setInlineCss(java.lang.String inlineCss)
Sets the inline CSS.- Parameters:
inlineCss
- the inline CSS
-
setJspRootPath
public void setJspRootPath(java.lang.String jspRootPath)
Sets the formatter root path.- Parameters:
jspRootPath
- the formatter root path
-
setKey
public void setKey(java.lang.String key)
-
setLabel
public void setLabel(java.lang.String label)
Sets the formatter label.- Parameters:
label
- the label
-
setNestedFormatterPrefixes
public void setNestedFormatterPrefixes(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,CmsXmlContentProperty> settingConfig)
Sets the settings configuration.- Parameters:
settingConfig
- the settings configuration
-
-