Package org.opencms.xml.containerpage

Class CmsFunctionFormatterBean

java.lang.Object

org.opencms.xml.containerpage.CmsFormatterBean

org.opencms.xml.containerpage.CmsFunctionFormatterBean

All Implemented Interfaces:

java.lang.Cloneable, I_CmsFormatterBean

public class CmsFunctionFormatterBean
extends CmsFormatterBean

A bean containing formatter configuration data as strings.

Field Summary

Fields inherited from class org.opencms.xml.containerpage.CmsFormatterBean

DEFAULT_CONFIGURATION_RANK, DEFAULT_SCHEMA_RANK, m_aliasKeys, m_containerTypes, m_cssHeadIncludes, m_description, m_displayType, m_id, m_inlineCss, m_inlineJavascript, m_isAutoEnabled, m_isDetail, m_isFromFormatterConfigFile, m_isPreviewFormatter, m_javascriptHeadIncludes, m_jspRootPath, m_jspStructureId, m_key, m_location, m_matchAll, m_maxWidth, m_metaMappings, m_minWidth, m_nestedFormatterSettings, m_niceName, m_plugins, m_rank, m_resourceTypeNames, m_search, m_strictContainers, m_useMetaMappingsForNormalElements, PREVIEW_TYPE, PREVIEW_WIDTH, WILDCARD_TYPE

Constructor Summary

Constructors

Constructor

Description

CmsFunctionFormatterBean(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, java.lang.String key, java.util.Set<java.lang.String> aliasKeys, CmsUUID functionFormatterId, int minWidth, int maxWidth, 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.util.List<CmsTemplatePlugin> plugins, java.lang.String niceName, java.lang.String description, java.lang.String id, CmsSettingConfiguration settingConfig, boolean isAllowsSettingsInEditor, boolean isStrictContainers, java.util.Map<java.lang.String,java.lang.String[]> parameters)

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

Method Summary

Modifier and Type	Method	Description
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.util.Map<java.lang.String,java.lang.String[]>	getParameters()	Gets the parameters the dynamic function should set for the included JSP.
int	getRank()	Gets the rank.
CmsUUID	getRealJspId()	Gets the actual JSP id of the function.
java.lang.String	getRealJspRootPath()	Gets the root path of the configured JSP.
java.util.Collection<java.lang.String>	getResourceTypeNames()	Gets the resource type names.

Methods inherited from class org.opencms.xml.containerpage.CmsFormatterBean

getAliasKeys, getAllKeys, getAttributes, getContainerTypes, getCssHeadIncludes, getDescription, getDisplayType, getId, getInlineCss, getInlineJavascript, getJavascriptHeadIncludes, getKey, getLocation, getMaxWidth, getMetaMappings, getMinWidth, getNiceName, getSettings, getTemplatePlugins, hashCode, hasNestedFormatterSettings, isAllowsSettingsInEditor, isAutoEnabled, isDetailFormatter, isDisplayFormatter, isFromFormatterConfigFile, isMatchAll, isPreviewFormatter, isPreviewType, isSearchContent, isStrictContainers, isTypeFormatter, setJspStructureId, toString, useMetaMappingsForNormalElements, withKeys

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

Constructor Detail

CmsFunctionFormatterBean

public CmsFunctionFormatterBean(java.util.Set<java.lang.String> containerTypes,
                                java.lang.String jspRootPath,
                                CmsUUID jspStructureId,
                                java.lang.String key,
                                java.util.Set<java.lang.String> aliasKeys,
                                CmsUUID functionFormatterId,
                                int minWidth,
                                int maxWidth,
                                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.util.List<CmsTemplatePlugin> plugins,
                                java.lang.String niceName,
                                java.lang.String description,
                                java.lang.String id,
                                CmsSettingConfiguration settingConfig,
                                boolean isAllowsSettingsInEditor,
                                boolean isStrictContainers,
                                java.util.Map<java.lang.String,java.lang.String[]> parameters)

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 key

aliasKeys - the alias keys

functionFormatterId - the standard function formatter structure id

minWidth - the formatter min width

maxWidth - the formatter max width

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

id - the configuration id

settingConfig - the settings configuration

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

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

parameters - the request parameters to add for the included JSP

Method Detail

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

Overrides:

getJspRootPath in class CmsFormatterBean

Returns:

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

See Also:

This is not the configured JSP, but the formatter JSP for the function_config type itself.

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

Overrides:

getJspStructureId in class CmsFormatterBean

Returns:

the structure id of the JSP resource for this formatter

See Also:

This is not the configured JSP, but the formatter JSP for the function_config type itself.

getParameters

public java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Gets the parameters the dynamic function should set for the included JSP.

Returns:

the map of parameters to add for the included JSP

getRank

public int getRank()

Description copied from interface: I_CmsFormatterBean

Gets the rank.

Specified by:

getRank in interface I_CmsFormatterBean

Overrides:

getRank in class CmsFormatterBean

Returns:

the rank

See Also:

I_CmsFormatterBean.getRank()

getRealJspId

public CmsUUID getRealJspId()

Gets the actual JSP id of the function.

Returns:

the JSP structure id

getRealJspRootPath

public java.lang.String getRealJspRootPath()

Gets the root path of the configured JSP.

Returns:

the root path of the configured JSP

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

Overrides:

getResourceTypeNames in class CmsFormatterBean

Returns:

the resource type names

See Also:

I_CmsFormatterBean.getResourceTypeNames()