org.opencms.xml.containerpage

接口 I_CmsFormatterBean

所有已知实现类:

CmsFormatterBean, CmsSchemaFormatterBeanWrapper

public interface I_CmsFormatterBean

Interface representing a configured formatter.

方法概要

方法

限定符和类型	方法和说明
java.util.Set<java.lang.String>	getContainerTypes() Returns the formatter container type.
java.util.Set<java.lang.String>	getCssHeadIncludes() Gets the CSS head includes.
java.lang.String	getId() Returns the id of this formatter.
java.lang.String	getInlineCss() Gets the inline CSS snippets.
java.lang.String	getInlineJavascript() Gets the inline JS snippets.
java.util.List<java.lang.String>	getJavascriptHeadIncludes() Gets the Javascript head includes.
java.lang.String	getJspRootPath() Returns the root path of the formatter JSP in the OpenCms VFS.
CmsUUID	getJspStructureId() Returns the structure id of the JSP resource for this formatter.
java.lang.String	getLocation() Returns the location this formatter was defined in.
int	getMaxWidth() Returns the maximum formatter width.
int	getMinWidth() Returns the minimum formatter width.
java.lang.String	getNiceName() Gets the nice name for this formatter.
int	getRank() Gets the rank.
java.lang.String	getResourceTypeName() Gets the resource type name.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getSettings() Gets the defined settings.
boolean	isAutoEnabled() Returns true if the formatter is automatically enabled.
boolean	isDetailFormatter() Returns true if the formatter can be used for detail views.
boolean	isFromFormatterConfigFile() Returns true if the formatter is from a formatter configuration file.
boolean	isMatchAll() Returns true if this formatter should match all type/width combinations.
boolean	isPreviewFormatter() Indicates if this formatter is to be used as preview in the ADE gallery GUI.
boolean	isSearchContent() Returns true in case an XML content formatted with this formatter should be included in the online full text search.
boolean	isTypeFormatter() Returns true in case this formatter is based on type information.
void	setJspStructureId(CmsUUID structureId) Sets the JSP structure id.

方法详细资料

getContainerTypes

java.util.Set<java.lang.String> getContainerTypes()

Returns the formatter container type.

If this is "*", then the formatter is a width based formatter.

返回:

the formatter container type

getCssHeadIncludes

java.util.Set<java.lang.String> getCssHeadIncludes()

Gets the CSS head includes.

返回:

the CSS head includes

getId

java.lang.String getId()

Returns the id of this formatter.

This method may return null because the id is not always defined for formatters, e.g. for those formatters declared in a schema.

返回:

the formatter id

getInlineCss

java.lang.String getInlineCss()

Gets the inline CSS snippets.

返回:

the inline CSS snippets

getInlineJavascript

java.lang.String getInlineJavascript()

Gets the inline JS snippets.

返回:

the inline JS snippets

getJavascriptHeadIncludes

java.util.List<java.lang.String> getJavascriptHeadIncludes()

Gets the Javascript head includes.

返回:

the head includes

getJspRootPath

java.lang.String getJspRootPath()

Returns the root path of the formatter JSP in the OpenCms VFS.

返回:

the root path of the formatter JSP in the OpenCms VFS.

getJspStructureId

CmsUUID getJspStructureId()

Returns the structure id of the JSP resource for this formatter.

返回:

the structure id of the JSP resource for this formatter

getLocation

java.lang.String getLocation()

Returns the location this formatter was defined in.

This will be an OpenCms VFS root path, either to the XML schema XSD, or the configuration file this formatter was defined in, or to the JSP that makes up this formatter.

返回:

the location this formatter was defined in

getMaxWidth

int getMaxWidth()

Returns the maximum formatter width.

If this is not set, then Integer.MAX_VALUE is returned.

返回:

the maximum formatter width

getMinWidth

int getMinWidth()

Returns the minimum formatter width.

If this is not set, then -1 is returned.

返回:

the minimum formatter width

getNiceName

java.lang.String getNiceName()

Gets the nice name for this formatter.

返回:

the nice name for this formatter

getRank

int getRank()

Gets the rank.

返回:

the rank

getResourceTypeName

java.lang.String getResourceTypeName()

Gets the resource type name.

返回:

the resource type name

getSettings

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

Gets the defined settings.

返回:

the defined settings

isAutoEnabled

boolean isAutoEnabled()

Returns true if the formatter is automatically enabled.

返回:

true if the formatter is automatically enabled

isDetailFormatter

boolean isDetailFormatter()

Returns true if the formatter can be used for detail views.

返回:

true if the formatter can be used for detail views

isFromFormatterConfigFile

boolean isFromFormatterConfigFile()

Returns true if the formatter is from a formatter configuration file.

返回:

formatter f

isMatchAll

boolean isMatchAll()

Returns true if this formatter should match all type/width combinations.

返回:

true if this formatter should match all type/width combinations

isPreviewFormatter

boolean isPreviewFormatter()

Indicates if this formatter is to be used as preview in the ADE gallery GUI.

返回:

true if this formatter is to be used as preview in the ADE gallery GUI

isSearchContent

boolean isSearchContent()

Returns true in case an XML content formatted with this formatter should be included in the online full text search.

返回:

true in case an XML content formatted with this formatter should be included in the online full text search

isTypeFormatter

boolean isTypeFormatter()

Returns true in case this formatter is based on type information.

返回:

true in case this formatter is based on type information

setJspStructureId

void setJspStructureId(CmsUUID structureId)

Sets the JSP structure id.

参数:

structureId - the jsp structure id