Package org.opencms.xml.containerpage

Class CmsSchemaFormatterBeanWrapper

java.lang.Object

org.opencms.xml.containerpage.CmsSchemaFormatterBeanWrapper

All Implemented Interfaces:

I_CmsFormatterBean

public class CmsSchemaFormatterBeanWrapper
extends java.lang.Object
implements I_CmsFormatterBean

Wrapper class for formatter beans which delegates all methods to the wrapped formatter bean except those for which we need to ask the content handler for additional data like element settings or head includes.

Constructor Summary

Constructors

Constructor	Description
CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource)	Creates a new wrapper instance.

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getAliasKeys()	Gets the set of alias keys for the formatter.
java.util.Set<java.lang.String>	getAllKeys()	Gets the complete set of keys for the formatter, i.e.
java.util.Map<java.lang.String,java.lang.String>	getAttributes()	Gets the map of attributes.
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	getDescription(java.util.Locale locale)	Gets the formatter description.
java.lang.String	getDisplayType()	The display type of this formatter or null in case this is not a display formatter.
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	getKey()	Gets the formatter key, or null if no formatter key is set.
java.lang.String	getLocation()	Returns the location this formatter was defined in.
int	getMaxWidth()	Returns the maximum formatter width.
java.util.List<CmsMetaMapping>	getMetaMappings()	Returns the meta mappings.
int	getMinWidth()	Returns the minimum formatter width.
java.lang.String	getNiceName(java.util.Locale locale)	Gets the nice name for this formatter.
int	getRank()	Gets the rank.
java.util.Collection<java.lang.String>	getResourceTypeNames()	Gets the resource type names.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getSettings(CmsADEConfigData config)	Gets the defined settings.
java.util.List<CmsTemplatePlugin>	getTemplatePlugins()	Gets the template plugins.
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.
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 JSP structure id.
boolean	useMetaMappingsForNormalElements()	Returns true if meta mappings should be evaluated for normal container elements using this formatter, not just detail elements.
java.util.Optional<I_CmsFormatterBean>	withKeys(java.util.Collection<java.lang.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, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getKeyOrId

Constructor Detail

CmsSchemaFormatterBeanWrapper

public CmsSchemaFormatterBeanWrapper(CmsObject cms,
                                     I_CmsFormatterBean wrappedBean,
                                     I_CmsXmlContentHandler contentHandler,
                                     CmsResource resource)

Creates a new wrapper instance.

Parameters:

cms - the CMS context to use

wrappedBean - the wrapped formatter

contentHandler - the content handler to ask for additional information

resource - the resource which should be used to ask the content handler for additional information

Method Detail

getAliasKeys

public java.util.Set<java.lang.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 java.util.Set<java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.util.Set<java.lang.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 java.util.Set<java.lang.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 java.lang.String getDescription(java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.List<java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.lang.String getNiceName(java.util.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 java.util.Collection<java.lang.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 java.util.Map<java.lang.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 java.util.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()

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()

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)

Description copied from interface: I_CmsFormatterBean

Sets the JSP structure id.

Specified by:

setJspStructureId in interface I_CmsFormatterBean

Parameters:

jspStructureId - the jsp structure id

See Also:

I_CmsFormatterBean.setJspStructureId(org.opencms.util.CmsUUID)

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 java.util.Optional<I_CmsFormatterBean> withKeys(java.util.Collection<java.lang.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)