Package org.opencms.xml.containerpage

Class CmsFormatterBean

java.lang.Object

org.opencms.xml.containerpage.CmsFormatterBean

All Implemented Interfaces:

Cloneable, I_CmsFormatterBean

Direct Known Subclasses:

CmsFlexFormatterBean, CmsFunctionFormatterBean, CmsMacroFormatterBean

public class CmsFormatterBean
extends Object
implements I_CmsFormatterBean, Cloneable

A bean containing formatter configuration data as strings.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONFIGURATION_RANK	Default rank for formatters from formatter configuration files.
static final int	DEFAULT_SCHEMA_RANK	Default rank for formatters defined in schema.
protected Set<String>	m_aliasKeys	Set of alias keys.
protected Set<String>	m_containerTypes	The formatter container type.
protected Set<String>	m_cssHeadIncludes	CSS Head includes.
protected String	m_description	The description text for the formatter.
protected String	m_displayType	Provides the display type.
protected String	m_id	The id for this formatter.
protected String	m_inlineCss	Inline CSS snippets.
protected String	m_inlineJavascript	Inline Javascript snippets.
protected boolean	m_isAutoEnabled	Is the formatter automatically enabled?
protected boolean	m_isDetail	True if this formatter can be used for detail views.
protected boolean	m_isFromFormatterConfigFile	Is the formatter from a formatter configuration file?
protected boolean	m_isPreviewFormatter	Indicates if this formatter is to be used as preview in the ADE gallery GUI.
protected List<String>	m_javascriptHeadIncludes	JavaScript head includes.
protected String	m_jspRootPath	The formatter JSP.
protected CmsUUID	m_jspStructureId	The UUID of the JSP resource for this formatter.
protected String	m_key	The formatter key.
protected String	m_location	The location this formatter was configured in.
protected boolean	m_matchAll	If true, will match any container/width combination.
protected int	m_maxWidth	The formatter max width.
protected List<CmsMetaMapping>	m_metaMappings	The meta mappings.
protected int	m_minWidth	The formatter min width.
protected boolean	m_nestedFormatterSettings	Indicates whether nested formatter settings should be displayed.
protected String	m_niceName	The nice name.
protected List<CmsTemplatePlugin>	m_plugins	The referenced plugins.
protected int	m_rank	The rank.
protected Collection<String>	m_resourceTypeNames	The resource type name.
protected boolean	m_search	Indicates if the content should be searchable in the online index when this formatter is used.
protected boolean	m_strictContainers	Indicating if this formatter will always render all nested containers.
protected boolean	m_useMetaMappingsForNormalElements	Indicates whether meta mappings should be applied for all elements.
static final String	PREVIEW_TYPE	Default formatter type constant.
static final int	PREVIEW_WIDTH	The width of the preview window for the formatters.
static final String	WILDCARD_TYPE	Wildcard formatter type for width based formatters.

Constructor Summary

Constructors

Constructor	Description
CmsFormatterBean(String containerType, String jspRootPath, String minWidthStr, String maxWidthStr, String preview, String searchContent, String location)	Constructor for creating a new formatter configuration without resource structure id.
CmsFormatterBean(String containerType, String rootPath, CmsUUID structureId, int minWidth, int maxWidth, boolean preview, boolean searchContent, String location)	Constructor for creating a new formatter configuration with resource structure id.
CmsFormatterBean(Set<String> containerTypes, String jspRootPath, CmsUUID jspStructureId, String key, Set<String> aliasKeys, int minWidth, int maxWidth, boolean preview, boolean searchContent, String location, List<String> cssHeadIncludes, String inlineCss, List<String> javascriptHeadIncludes, String inlineJavascript, List<CmsTemplatePlugin> plugins, String niceName, String description, Collection<String> resourceTypeNames, int rank, String id, CmsSettingConfiguration settingConfig, boolean isFromConfigFile, boolean isAutoEnabled, boolean isDetail, String displayType, boolean isAllowsSettingsInEditor, boolean strictContainers, boolean nestedFormatterSettings, List<CmsMetaMapping> metaMappings, Map<String,String> attributes, boolean useMetaMappingsForNormalElements)	Constructor for creating a new formatter configuration with resource structure id.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAliasKeys()	Gets the set of alias keys for the formatter.
Set<String>	getAllKeys()	Gets the complete set of keys for the formatter, i.e.
Map<String,String>	getAttributes()	Gets the map of attributes.
Set<String>	getContainerTypes()	Returns the formatter container type.
Set<String>	getCssHeadIncludes()	Gets the CSS head includes.
String	getDescription(Locale locale)	Gets the formatter description.
String	getDisplayType()	The display type of this formatter or null in case this is not a display formatter.
String	getId()	Returns the id of this formatter.
String	getInlineCss()	Gets the inline CSS snippets.
String	getInlineJavascript()	Gets the inline JS snippets.
List<String>	getJavascriptHeadIncludes()	Gets the Javascript head includes.
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.
String	getKey()	Gets the formatter key, or null if no formatter key is set.
String	getLocation()	Returns the location this formatter was defined in.
int	getMaxWidth()	Returns the maximum formatter width.
List<CmsMetaMapping>	getMetaMappings()	Returns the meta mappings.
int	getMinWidth()	Returns the minimum formatter width.
String	getNiceName(Locale locale)	Gets the nice name for this formatter.
int	getRank()	Gets the rank.
Collection<String>	getResourceTypeNames()	Gets the resource type names.
Map<String,CmsXmlContentProperty>	getSettings(CmsADEConfigData config)	Gets the defined settings.
List<CmsTemplatePlugin>	getTemplatePlugins()	Gets the template plugins.
int	hashCode()
boolean	hasNestedFormatterSettings()	Returns if nested formatter settings should be displayed.
boolean	isAllowsSettingsInEditor()	Returns whether this formatter allows settings to be edited in the content editor.
boolean	isAutoEnabled()	Returns true if the formatter is automatically enabled.
boolean	isDetailFormatter()	Returns true if the formatter can be used for detail views.
boolean	isDisplayFormatter()	Returns whether this formatter should be used by the 'display' tag.
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(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	isStrictContainers()	Returns whether this formatter will always render all nested containers.
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.
String	toString()
boolean	useMetaMappingsForNormalElements()	Returns true if meta mappings should be evaluated for normal container elements using this formatter, not just detail elements.
Optional<I_CmsFormatterBean>	withKeys(Collection<String> keys)	If possible, returns a formatter bean that is basically a copy of this one, but has the keys supplied as a parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.xml.containerpage.I_CmsFormatterBean

getKeyOrId

Field Details

DEFAULT_CONFIGURATION_RANK

public static final int DEFAULT_CONFIGURATION_RANK

Default rank for formatters from formatter configuration files.

See Also:

• Constant Field Values

DEFAULT_SCHEMA_RANK

public static final int DEFAULT_SCHEMA_RANK

Default rank for formatters defined in schema.

See Also:

• Constant Field Values

PREVIEW_TYPE

public static final String PREVIEW_TYPE

Default formatter type constant.

See Also:

• Constant Field Values

PREVIEW_WIDTH

public static final int PREVIEW_WIDTH

The width of the preview window for the formatters.

See Also:

• Constant Field Values

WILDCARD_TYPE

public static final String WILDCARD_TYPE

Wildcard formatter type for width based formatters.

See Also:

• Constant Field Values

m_containerTypes

protected Set<String> m_containerTypes

The formatter container type.

m_cssHeadIncludes

protected Set<String> m_cssHeadIncludes

CSS Head includes.

m_description

protected String m_description

The description text for the formatter.

m_aliasKeys

protected Set<String> m_aliasKeys

Set of alias keys.

m_displayType

protected String m_displayType

Provides the display type. If empty if this formatter should not be used by the display tag.

m_id

protected String m_id

The id for this formatter.

m_inlineCss

protected String m_inlineCss

Inline CSS snippets.

m_inlineJavascript

protected String m_inlineJavascript

Inline Javascript snippets.

m_isAutoEnabled

protected boolean m_isAutoEnabled

Is the formatter automatically enabled?

m_isDetail

protected boolean m_isDetail

True if this formatter can be used for detail views.

m_isFromFormatterConfigFile

protected boolean m_isFromFormatterConfigFile

Is the formatter from a formatter configuration file?

m_isPreviewFormatter

protected boolean m_isPreviewFormatter

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

m_javascriptHeadIncludes

protected List<String> m_javascriptHeadIncludes

JavaScript head includes.

m_jspRootPath

protected String m_jspRootPath

The formatter JSP.

m_jspStructureId

protected CmsUUID m_jspStructureId

The UUID of the JSP resource for this formatter.

m_key

protected String m_key

The formatter key.

m_location

protected String m_location

The location this formatter was configured in.

m_matchAll

protected boolean m_matchAll

If true, will match any container/width combination.

m_maxWidth

protected int m_maxWidth

The formatter max width.

m_metaMappings

protected List<CmsMetaMapping> m_metaMappings

The meta mappings.

m_minWidth

protected int m_minWidth

The formatter min width.

m_nestedFormatterSettings

protected boolean m_nestedFormatterSettings

Indicates whether nested formatter settings should be displayed.

m_niceName

protected String m_niceName

The nice name.

m_plugins

protected List<CmsTemplatePlugin> m_plugins

The referenced plugins.

m_rank

protected int m_rank

The rank.

m_resourceTypeNames

protected Collection<String> m_resourceTypeNames

The resource type name.

m_search

protected boolean m_search

Indicates if the content should be searchable in the online index when this formatter is used.

m_strictContainers

protected boolean m_strictContainers

Indicating if this formatter will always render all nested containers.

m_useMetaMappingsForNormalElements

protected boolean m_useMetaMappingsForNormalElements

Indicates whether meta mappings should be applied for all elements.

Constructor Details

CmsFormatterBean

public CmsFormatterBean(Set<String> containerTypes,
 String jspRootPath,
 CmsUUID jspStructureId,
 String key,
 Set<String> aliasKeys,
 int minWidth,
 int maxWidth,
 boolean preview,
 boolean searchContent,
 String location,
 List<String> cssHeadIncludes,
 String inlineCss,
 List<String> javascriptHeadIncludes,
 String inlineJavascript,
 List<CmsTemplatePlugin> plugins,
 String niceName,
 String description,
 Collection<String> resourceTypeNames,
 int rank,
 String id,
 CmsSettingConfiguration settingConfig,
 boolean isFromConfigFile,
 boolean isAutoEnabled,
 boolean isDetail,
 String displayType,
 boolean isAllowsSettingsInEditor,
 boolean strictContainers,
 boolean nestedFormatterSettings,
 List<CmsMetaMapping> metaMappings,
 Map<String,String> attributes,
 boolean useMetaMappingsForNormalElements)

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

Parameters:

containerTypes - the formatter container types

jspRootPath - the formatter JSP VFS root path

jspStructureId - the structure id of the formatter JSP

key - the formatter key

aliasKeys - the alias keys

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 - the CSS head includes

inlineCss - the in-line CSS

javascriptHeadIncludes - the JavaScript headincludes

inlineJavascript - the in-line JavaScript

plugins - the template plugins

niceName - the configuration display name

description - the description text for the formatter

resourceTypeNames - the resource type names

rank - the configuration rank

id - the configuration id

settingConfig - the settings configuration

isFromConfigFile - true if configuration file based

isAutoEnabled - true if auto enabled

isDetail - true if detail formatter

displayType - the display type

isAllowsSettingsInEditor - whether this formatter allows settings to be edited in the content editor

strictContainers - true if this formatter will always render all nested containers

nestedFormatterSettings - indicates whether nested formatter settings should be displayed

metaMappings - the meta mappings

attributes - the formatter attributes

useMetaMappingsForNormalElements - if true, meta mappings will be evaluated for normal container elements, not just detail elements

CmsFormatterBean

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

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

Parameters:

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(String containerType,
 String jspRootPath,
 String minWidthStr,
 String maxWidthStr,
 String preview,
 String searchContent,
 String location)

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

Parameters:

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

Method Details

isPreviewType

public static boolean isPreviewType(String containerType)

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

Parameters:

containerType - the container type to check

Returns:

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

getAliasKeys

public Set<String> getAliasKeys()

Description copied from interface: I_CmsFormatterBean

Gets the set of alias keys for the formatter.

Specified by:

getAliasKeys in interface I_CmsFormatterBean

Returns:

the set of alias keys

See Also:

• I_CmsFormatterBean.getAliasKeys()

getAllKeys

public Set<String> getAllKeys()

Description copied from interface: I_CmsFormatterBean

Gets the complete set of keys for the formatter, i.e. its main key and all alias keys.

Specified by:

getAllKeys in interface I_CmsFormatterBean

Returns:

the complete set of keys

See Also:

• I_CmsFormatterBean.getAllKeys()

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: I_CmsFormatterBean

Gets the map of attributes.

Specified by:

getAttributes in interface I_CmsFormatterBean

Returns:

the attribute map

See Also:

• I_CmsFormatterBean.getAttributes()

getContainerTypes

public Set<String> getContainerTypes()

Description copied from interface: I_CmsFormatterBean

Returns the formatter container type.

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

Specified by:

getContainerTypes in interface I_CmsFormatterBean

Returns:

the formatter container type

See Also:

• I_CmsFormatterBean.getContainerTypes()

getCssHeadIncludes

public Set<String> getCssHeadIncludes()

Description copied from interface: I_CmsFormatterBean

Gets the CSS head includes.

Specified by:

getCssHeadIncludes in interface I_CmsFormatterBean

Returns:

the CSS head includes

See Also:

• I_CmsFormatterBean.getCssHeadIncludes()

getDescription

public String getDescription(Locale locale)

Description copied from interface: I_CmsFormatterBean

Gets the formatter description.

If a locale is passed in, macros in the configured description will be resolved with a macro resolver set to that locale. If null is passed in as a locale, the raw configured description will be returned.

Specified by:

getDescription in interface I_CmsFormatterBean

Parameters:

locale - the locale (may be null)

Returns:

the formatter description

See Also:

• I_CmsFormatterBean.getDescription(Locale)

getDisplayType

public String getDisplayType()

Description copied from interface: I_CmsFormatterBean

The display type of this formatter or null in case this is not a display formatter.

Specified by:

getDisplayType in interface I_CmsFormatterBean

Returns:

the display type

See Also:

• I_CmsFormatterBean.getDisplayType()

getId

public String getId()

Description copied from interface: 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.

Specified by:

getId in interface I_CmsFormatterBean

Returns:

the formatter id

See Also:

• I_CmsFormatterBean.getId()

getInlineCss

public String getInlineCss()

Description copied from interface: I_CmsFormatterBean

Gets the inline CSS snippets.

Specified by:

getInlineCss in interface I_CmsFormatterBean

Returns:

the inline CSS snippets

See Also:

• I_CmsFormatterBean.getInlineCss()

getInlineJavascript

public String getInlineJavascript()

Description copied from interface: I_CmsFormatterBean

Gets the inline JS snippets.

Specified by:

getInlineJavascript in interface I_CmsFormatterBean

Returns:

the inline JS snippets

See Also:

• I_CmsFormatterBean.getInlineJavascript()

getJavascriptHeadIncludes

public List<String> getJavascriptHeadIncludes()

Description copied from interface: I_CmsFormatterBean

Gets the Javascript head includes.

Specified by:

getJavascriptHeadIncludes in interface I_CmsFormatterBean

Returns:

the head includes

See Also:

• I_CmsFormatterBean.getJavascriptHeadIncludes()

getJspRootPath

public String getJspRootPath()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

getJspRootPath in interface I_CmsFormatterBean

Returns:

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

See Also:

• I_CmsFormatterBean.getJspRootPath()

getJspStructureId

public CmsUUID getJspStructureId()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

getJspStructureId in interface I_CmsFormatterBean

Returns:

the structure id of the JSP resource for this formatter

See Also:

• I_CmsFormatterBean.getJspStructureId()

getKey

public String getKey()

Description copied from interface: I_CmsFormatterBean

Gets the formatter key, or null if no formatter key is set.

A formatter key is used to allow dynamic switching between formatters with the same key by enabling/disabling the formatters in the sitemap configuration. I.e. if a formatter referenced in a container page has been disabled in the sitemap configuration, but a different formatter with the same key is enabled, the second formatter will be used instead when rendering the page .

Specified by:

getKey in interface I_CmsFormatterBean

Returns:

the formatter key, or null

See Also:

• I_CmsFormatterBean.getKey()

getLocation

public String getLocation()

Description copied from interface: 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.

Specified by:

getLocation in interface I_CmsFormatterBean

Returns:

the location this formatter was defined in

See Also:

• I_CmsFormatterBean.getLocation()

getMaxWidth

public int getMaxWidth()

Description copied from interface: I_CmsFormatterBean

Returns the maximum formatter width.

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

Specified by:

getMaxWidth in interface I_CmsFormatterBean

Returns:

the maximum formatter width

See Also:

• I_CmsFormatterBean.getMaxWidth()

getMetaMappings

public List<CmsMetaMapping> getMetaMappings()

Description copied from interface: I_CmsFormatterBean

Returns the meta mappings.

Specified by:

getMetaMappings in interface I_CmsFormatterBean

Returns:

the meta mappings

See Also:

• I_CmsFormatterBean.getMetaMappings()

getMinWidth

public int getMinWidth()

Description copied from interface: I_CmsFormatterBean

Returns the minimum formatter width.

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

Specified by:

getMinWidth in interface I_CmsFormatterBean

Returns:

the minimum formatter width

See Also:

• I_CmsFormatterBean.getMinWidth()

getNiceName

public String getNiceName(Locale locale)

Description copied from interface: I_CmsFormatterBean

Gets the nice name for this formatter.

Specified by:

getNiceName in interface I_CmsFormatterBean

Parameters:

locale - the locale

Returns:

the nice name for this formatter

See Also:

• I_CmsFormatterBean.getNiceName(Locale)

getRank

public int getRank()

Description copied from interface: I_CmsFormatterBean

Gets the rank.

Specified by:

getRank in interface I_CmsFormatterBean

Returns:

the rank

See Also:

• I_CmsFormatterBean.getRank()

getResourceTypeNames

public Collection<String> getResourceTypeNames()

Description copied from interface: I_CmsFormatterBean

Gets the resource type names.

Specified by:

getResourceTypeNames in interface I_CmsFormatterBean

Returns:

the resource type names

See Also:

• I_CmsFormatterBean.getResourceTypeNames()

getSettings

public Map<String,CmsXmlContentProperty> getSettings(CmsADEConfigData config)

Description copied from interface: I_CmsFormatterBean

Gets the defined settings.

Specified by:

getSettings in interface I_CmsFormatterBean

Parameters:

config - the sitemap configuration for which the settings should be retrieved

Returns:

the defined settings

See Also:

• I_CmsFormatterBean.getSettings(org.opencms.ade.configuration.CmsADEConfigData)

getTemplatePlugins

public List<CmsTemplatePlugin> getTemplatePlugins()

Description copied from interface: I_CmsFormatterBean

Gets the template plugins.

Specified by:

getTemplatePlugins in interface I_CmsFormatterBean

Returns:

the template plugins

See Also:

• I_CmsFormatterBean.getTemplatePlugins()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

hasNestedFormatterSettings

public boolean hasNestedFormatterSettings()

Description copied from interface: I_CmsFormatterBean

Returns if nested formatter settings should be displayed.

Specified by:

hasNestedFormatterSettings in interface I_CmsFormatterBean

Returns:

true if nested formatter settings should be displayed

See Also:

• I_CmsFormatterBean.hasNestedFormatterSettings()

isAllowsSettingsInEditor

public boolean isAllowsSettingsInEditor()

Description copied from interface: I_CmsFormatterBean

Returns whether this formatter allows settings to be edited in the content editor.

Specified by:

isAllowsSettingsInEditor in interface I_CmsFormatterBean

Returns:

true in case editing the settings is allowed in the content editor

See Also:

• I_CmsFormatterBean.isAllowsSettingsInEditor()

isAutoEnabled

public boolean isAutoEnabled()

Description copied from interface: I_CmsFormatterBean

Returns true if the formatter is automatically enabled.

Specified by:

isAutoEnabled in interface I_CmsFormatterBean

Returns:

true if the formatter is automatically enabled

See Also:

• I_CmsFormatterBean.isAutoEnabled()

isDetailFormatter

public boolean isDetailFormatter()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isDetailFormatter in interface I_CmsFormatterBean

Returns:

true if the formatter can be used for detail views

See Also:

• I_CmsFormatterBean.isDetailFormatter()

isDisplayFormatter

public boolean isDisplayFormatter()

Description copied from interface: I_CmsFormatterBean

Returns whether this formatter should be used by the 'display' tag.

Specified by:

isDisplayFormatter in interface I_CmsFormatterBean

Returns:

true if this formatter should be used by the 'display' tag

See Also:

• I_CmsFormatterBean.isDisplayFormatter()

isFromFormatterConfigFile

public boolean isFromFormatterConfigFile()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isFromFormatterConfigFile in interface I_CmsFormatterBean

Returns:

formatter f

See Also:

• I_CmsFormatterBean.isFromFormatterConfigFile()

isMatchAll

public boolean isMatchAll()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isMatchAll in interface I_CmsFormatterBean

Returns:

true if this formatter should match all type/width combinations

See Also:

• I_CmsFormatterBean.isMatchAll()

isPreviewFormatter

public boolean isPreviewFormatter()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isPreviewFormatter in interface I_CmsFormatterBean

Returns:

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

See Also:

• I_CmsFormatterBean.isPreviewFormatter()

isSearchContent

public boolean isSearchContent()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isSearchContent in interface I_CmsFormatterBean

Returns:

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

See Also:

• I_CmsFormatterBean.isSearchContent()

isStrictContainers

public boolean isStrictContainers()

Returns whether this formatter will always render all nested containers.

Returns:

true if this formatter will always render all nested containers

isTypeFormatter

public boolean isTypeFormatter()

Description copied from interface: I_CmsFormatterBean

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

Specified by:

isTypeFormatter in interface I_CmsFormatterBean

Returns:

true in case this formatter is based on type information

See Also:

• 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).

Specified by:

setJspStructureId in interface I_CmsFormatterBean

Parameters:

jspStructureId - the structure id of the JSP for this formatter

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

useMetaMappingsForNormalElements

public boolean useMetaMappingsForNormalElements()

Description copied from interface: I_CmsFormatterBean

Returns true if meta mappings should be evaluated for normal container elements using this formatter, not just detail elements.

Specified by:

useMetaMappingsForNormalElements in interface I_CmsFormatterBean

Returns:

true if meta mappings should be evaluated for normal container elements

See Also:

• I_CmsFormatterBean.useMetaMappingsForNormalElements()

withKeys

public Optional<I_CmsFormatterBean> withKeys(Collection<String> keys)

Description copied from interface: I_CmsFormatterBean

If possible, returns a formatter bean that is basically a copy of this one, but has the keys supplied as a parameter.

Note that this only works for formatters which already have a key, and can not replace the main key. If the keys already match, the current instance may be returned rather than a copy.

If the formatter bean implementation does not support key replacement, or an error occurs, an empty Optional is returned

Specified by:

withKeys in interface I_CmsFormatterBean

Parameters:

keys - the keys to use (should include the current key of the formatter

Returns:

the copy with the replaced keys

See Also:

• I_CmsFormatterBean.withKeys(java.util.Collection)