org.opencms.xml.containerpage

类 CmsFormatterBean

java.lang.Object

org.opencms.xml.containerpage.CmsFormatterBean

所有已实现的接口:

I_CmsFormatterBean

public class CmsFormatterBean
extends java.lang.Object
implements I_CmsFormatterBean

A bean containing formatter configuration data as strings.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_CONFIGURATION_RANK Default rank for formatters from formatter configuration files.
static int	DEFAULT_SCHEMA_RANK Default rank for formatters defined in schema.
static java.lang.String	PREVIEW_TYPE Default formatter type constant.
static int	PREVIEW_WIDTH The width of the preview window for the formatters.
static java.lang.String	WILDCARD_TYPE Wildcard formatter type for width based formatters.

构造器概要

构造器

构造器和说明
CmsFormatterBean(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, int minWidth, int maxWidth, boolean preview, boolean searchContent, java.lang.String location, java.util.List<java.lang.String> cssHeadIncludes, java.lang.String inlineCss, java.util.List<java.lang.String> javascriptHeadIncludes, java.lang.String inlineJavascript, java.lang.String niceName, java.lang.String resourceTypeName, int rank, java.lang.String id, java.util.Map<java.lang.String,CmsXmlContentProperty> settings, boolean isFromConfigFile, boolean isAutoEnabled, boolean isDetail) Constructor for creating a new formatter configuration with resource structure id.
CmsFormatterBean(java.lang.String containerType, java.lang.String rootPath, CmsUUID structureId, int minWidth, int maxWidth, boolean preview, boolean searchContent, java.lang.String location) Constructor for creating a new formatter configuration with resource structure id.
CmsFormatterBean(java.lang.String containerType, java.lang.String jspRootPath, java.lang.String minWidthStr, java.lang.String maxWidthStr, java.lang.String preview, java.lang.String searchContent, java.lang.String location) Constructor for creating a new formatter configuration without resource structure id.

方法概要

方法

限定符和类型	方法和说明
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.
int	hashCode()
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.
static boolean	isPreviewType(java.lang.String containerType) Checks if the given container type matches the ADE gallery preview type.
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 jspStructureId) Sets the structure id of the JSP for this formatter.
java.lang.String	toString()

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

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

字段详细资料

DEFAULT_CONFIGURATION_RANK

public static final int DEFAULT_CONFIGURATION_RANK

Default rank for formatters from formatter configuration files.

另请参阅:

常量字段值

DEFAULT_SCHEMA_RANK

public static final int DEFAULT_SCHEMA_RANK

Default rank for formatters defined in schema.

另请参阅:

常量字段值

PREVIEW_TYPE

public static final java.lang.String PREVIEW_TYPE

Default formatter type constant.

另请参阅:

常量字段值

PREVIEW_WIDTH

public static final int PREVIEW_WIDTH

The width of the preview window for the formatters.

另请参阅:

常量字段值

WILDCARD_TYPE

public static final java.lang.String WILDCARD_TYPE

Wildcard formatter type for width based formatters.

另请参阅:

常量字段值

构造器详细资料

CmsFormatterBean

public CmsFormatterBean(java.util.Set<java.lang.String> containerTypes,
                java.lang.String jspRootPath,
                CmsUUID jspStructureId,
                int minWidth,
                int maxWidth,
                boolean preview,
                boolean searchContent,
                java.lang.String location,
                java.util.List<java.lang.String> cssHeadIncludes,
                java.lang.String inlineCss,
                java.util.List<java.lang.String> javascriptHeadIncludes,
                java.lang.String inlineJavascript,
                java.lang.String niceName,
                java.lang.String resourceTypeName,
                int rank,
                java.lang.String id,
                java.util.Map<java.lang.String,CmsXmlContentProperty> settings,
                boolean isFromConfigFile,
                boolean isAutoEnabled,
                boolean isDetail)

Constructor for creating a new formatter configuration with resource structure id.

参数:

containerTypes - the formatter container types

jspRootPath - the formatter JSP VFS root path

jspStructureId - the structure id of the formatter JSP

minWidth - the formatter min width

maxWidth - the formatter max width

preview - indicates if this formatter is to be used for the preview in the ADE gallery GUI

searchContent - indicates if the content should be searchable in the online index when this formatter is used

location - the location where this formatter was defined, should be an OpenCms VFS resource path

cssHeadIncludes -

inlineCss -

javascriptHeadIncludes -

inlineJavascript -

niceName -

resourceTypeName -

rank -

id -

settings -

isFromConfigFile -

isAutoEnabled -

isDetail -

CmsFormatterBean

public CmsFormatterBean(java.lang.String containerType,
                java.lang.String rootPath,
                CmsUUID structureId,
                int minWidth,
                int maxWidth,
                boolean preview,
                boolean searchContent,
                java.lang.String location)

Constructor for creating a new formatter configuration with resource structure id.

参数:

containerType - the formatter container types

rootPath - the formatter JSP VFS root path

structureId - the structure id of the formatter JSP

minWidth - the formatter min width

maxWidth - the formatter max width

preview - indicates if this formatter is to be used for the preview in the ADE gallery GUI

searchContent - indicates if the content should be searchable in the online index when this formatter is used

location - the location where this formatter was defined, should be an OpenCms VFS resource path

CmsFormatterBean

public CmsFormatterBean(java.lang.String containerType,
                java.lang.String jspRootPath,
                java.lang.String minWidthStr,
                java.lang.String maxWidthStr,
                java.lang.String preview,
                java.lang.String searchContent,
                java.lang.String location)

Constructor for creating a new formatter configuration without resource structure id.

参数:

containerType - the formatter container type

jspRootPath - the formatter JSP VFS root path

minWidthStr - the formatter min width

maxWidthStr - the formatter max width

preview - indicates if this formatter is to be used for the preview in the ADE gallery GUI

searchContent - indicates if the content should be searchable in the online index when this formatter is used

location - the location where this formatter was defined, should be an OpenCms VFS resource path

方法详细资料

isPreviewType

public static boolean isPreviewType(java.lang.String containerType)

Checks if the given container type matches the ADE gallery preview type.

参数:

containerType - the container type to check

返回:

true if the given container type matches the ADE gallery preview type

getContainerTypes

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

从接口复制的说明: I_CmsFormatterBean

Returns the formatter container type.

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

指定者:

getContainerTypes 在接口中 I_CmsFormatterBean

返回:

the formatter container type

另请参阅:

I_CmsFormatterBean.getContainerTypes()

getCssHeadIncludes

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

从接口复制的说明: I_CmsFormatterBean

Gets the CSS head includes.

指定者:

getCssHeadIncludes 在接口中 I_CmsFormatterBean

返回:

the CSS head includes

另请参阅:

I_CmsFormatterBean.getCssHeadIncludes()

getId

public java.lang.String getId()

从接口复制的说明: I_CmsFormatterBean

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.

指定者:

getId 在接口中 I_CmsFormatterBean

返回:

the formatter id

另请参阅:

I_CmsFormatterBean.getId()

getInlineCss

public java.lang.String getInlineCss()

从接口复制的说明: I_CmsFormatterBean

Gets the inline CSS snippets.

指定者:

getInlineCss 在接口中 I_CmsFormatterBean

返回:

the inline CSS snippets

另请参阅:

I_CmsFormatterBean.getInlineCss()

getInlineJavascript

public java.lang.String getInlineJavascript()

从接口复制的说明: I_CmsFormatterBean

Gets the inline JS snippets.

指定者:

getInlineJavascript 在接口中 I_CmsFormatterBean

返回:

the inline JS snippets

另请参阅:

I_CmsFormatterBean.getInlineJavascript()

getJavascriptHeadIncludes

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

从接口复制的说明: I_CmsFormatterBean

Gets the Javascript head includes.

指定者:

getJavascriptHeadIncludes 在接口中 I_CmsFormatterBean

返回:

the head includes

另请参阅:

I_CmsFormatterBean.getJavascriptHeadIncludes()

getJspRootPath

public java.lang.String getJspRootPath()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

getJspRootPath 在接口中 I_CmsFormatterBean

返回:

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

另请参阅:

I_CmsFormatterBean.getJspRootPath()

getJspStructureId

public CmsUUID getJspStructureId()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

getJspStructureId 在接口中 I_CmsFormatterBean

返回:

the structure id of the JSP resource for this formatter

另请参阅:

I_CmsFormatterBean.getJspStructureId()

getLocation

public java.lang.String getLocation()

从接口复制的说明: I_CmsFormatterBean

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.

指定者:

getLocation 在接口中 I_CmsFormatterBean

返回:

the location this formatter was defined in

另请参阅:

I_CmsFormatterBean.getLocation()

getMaxWidth

public int getMaxWidth()

从接口复制的说明: I_CmsFormatterBean

Returns the maximum formatter width.

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

指定者:

getMaxWidth 在接口中 I_CmsFormatterBean

返回:

the maximum formatter width

另请参阅:

I_CmsFormatterBean.getMaxWidth()

getMinWidth

public int getMinWidth()

从接口复制的说明: I_CmsFormatterBean

Returns the minimum formatter width.

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

指定者:

getMinWidth 在接口中 I_CmsFormatterBean

返回:

the minimum formatter width

另请参阅:

I_CmsFormatterBean.getMinWidth()

getNiceName

public java.lang.String getNiceName()

从接口复制的说明: I_CmsFormatterBean

Gets the nice name for this formatter.

指定者:

getNiceName 在接口中 I_CmsFormatterBean

返回:

the nice name for this formatter

另请参阅:

I_CmsFormatterBean.getNiceName()

getRank

public int getRank()

从接口复制的说明: I_CmsFormatterBean

Gets the rank.

指定者:

getRank 在接口中 I_CmsFormatterBean

返回:

the rank

另请参阅:

I_CmsFormatterBean.getRank()

getResourceTypeName

public java.lang.String getResourceTypeName()

从接口复制的说明: I_CmsFormatterBean

Gets the resource type name.

指定者:

getResourceTypeName 在接口中 I_CmsFormatterBean

返回:

the resource type name

另请参阅:

I_CmsFormatterBean.getResourceTypeName()

getSettings

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

从接口复制的说明: I_CmsFormatterBean

Gets the defined settings.

指定者:

getSettings 在接口中 I_CmsFormatterBean

返回:

the defined settings

另请参阅:

I_CmsFormatterBean.getSettings()

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

isAutoEnabled

public boolean isAutoEnabled()

从接口复制的说明: I_CmsFormatterBean

Returns true if the formatter is automatically enabled.

指定者:

isAutoEnabled 在接口中 I_CmsFormatterBean

返回:

true if the formatter is automatically enabled

另请参阅:

I_CmsFormatterBean.isAutoEnabled()

isDetailFormatter

public boolean isDetailFormatter()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isDetailFormatter 在接口中 I_CmsFormatterBean

返回:

true if the formatter can be used for detail views

另请参阅:

I_CmsFormatterBean.isDetailFormatter()

isFromFormatterConfigFile

public boolean isFromFormatterConfigFile()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isFromFormatterConfigFile 在接口中 I_CmsFormatterBean

返回:

formatter f

另请参阅:

I_CmsFormatterBean.isFromFormatterConfigFile()

isMatchAll

public boolean isMatchAll()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isMatchAll 在接口中 I_CmsFormatterBean

返回:

true if this formatter should match all type/width combinations

另请参阅:

I_CmsFormatterBean.isMatchAll()

isPreviewFormatter

public boolean isPreviewFormatter()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isPreviewFormatter 在接口中 I_CmsFormatterBean

返回:

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

另请参阅:

I_CmsFormatterBean.isPreviewFormatter()

isSearchContent

public boolean isSearchContent()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isSearchContent 在接口中 I_CmsFormatterBean

返回:

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

另请参阅:

I_CmsFormatterBean.isSearchContent()

isTypeFormatter

public boolean isTypeFormatter()

从接口复制的说明: I_CmsFormatterBean

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

指定者:

isTypeFormatter 在接口中 I_CmsFormatterBean

返回:

true in case this formatter is based on type information

另请参阅:

I_CmsFormatterBean.isTypeFormatter()

setJspStructureId

public void setJspStructureId(CmsUUID jspStructureId)

Sets the structure id of the JSP for this formatter.

This is "package visible" as it should be only called from CmsFormatterConfiguration.initialize(org.opencms.file.CmsObject).

指定者:

setJspStructureId 在接口中 I_CmsFormatterBean

参数:

jspStructureId - the structure id of the JSP for this formatter

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()