org.opencms.ade.containerpage.shared

类 CmsFormatterConfig

java.lang.Object

org.opencms.ade.containerpage.shared.CmsFormatterConfig

所有已实现的接口:

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.

字段概要

字段

限定符和类型	字段和说明
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.

构造器概要

构造器

限定符	构造器和说明
protected	CmsFormatterConfig() Constructor for serialization only.
	CmsFormatterConfig(java.lang.String id) Constructor.

方法概要

方法

限定符和类型	方法和说明
java.util.Set<java.lang.String>	getCssResources() Returns the required CSS resources.
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	getLabel() Returns the formatter label.
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	setInlineCss(java.lang.String inlineCss) Sets the inline CSS.
void	setJspRootPath(java.lang.String jspRootPath) Sets the formatter root path.
void	setLabel(java.lang.String label) Sets the formatter label.
void	setSettingConfig(java.util.Map<java.lang.String,CmsXmlContentProperty> settingConfig) Sets the settings configuration.

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

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

字段详细资料

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.

另请参阅:

常量字段值

SCHEMA_FORMATTER_ID

public static final java.lang.String SCHEMA_FORMATTER_ID

Id used for schema based formatters.

另请参阅:

常量字段值

构造器详细资料

CmsFormatterConfig

public CmsFormatterConfig(java.lang.String id)

Constructor.

参数:

id - the formatter id

CmsFormatterConfig

protected CmsFormatterConfig()

Constructor for serialization only.

方法详细资料

getSettingsKeyForContainer

public static java.lang.String getSettingsKeyForContainer(java.lang.String containerName)

Returns the formatter configuration settings key for the given container name.

参数:

containerName - the container name

返回:

the settings key

getCssResources

public java.util.Set<java.lang.String> getCssResources()

Returns the required CSS resources.

返回:

the CSS resources

getId

public java.lang.String getId()

Returns the formatter configuration id.

返回:

the configuration id

getInlineCss

public java.lang.String getInlineCss()

Returns the inline CSS.

返回:

the inline CSS

getJspRootPath

public java.lang.String getJspRootPath()

Returns the formatter root path.

返回:

the formatter root path

getLabel

public java.lang.String getLabel()

Returns the formatter label.

返回:

the label

getSettingConfig

public java.util.Map<java.lang.String,CmsXmlContentProperty> getSettingConfig()

Returns the settings configuration.

返回:

the settings configuration

hasInlineCss

public boolean hasInlineCss()

Returns if the formatter has inline CSS.

返回:

true if the formatter has inline CSS

setCssResources

public void setCssResources(java.util.Set<java.lang.String> cssResources)

Sets the required CSS resources.

参数:

cssResources - the CSS resources

setInlineCss

public void setInlineCss(java.lang.String inlineCss)

Sets the inline CSS.

参数:

inlineCss - the inline CSS

setJspRootPath

public void setJspRootPath(java.lang.String jspRootPath)

Sets the formatter root path.

参数:

jspRootPath - the formatter root path

setLabel

public void setLabel(java.lang.String label)

Sets the formatter label.

参数:

label - the label

setSettingConfig

public void setSettingConfig(java.util.Map<java.lang.String,CmsXmlContentProperty> settingConfig)

Sets the settings configuration.

参数:

settingConfig - the settings configuration