Package org.opencms.xml.containerpage

Class CmsMacroFormatterBean

java.lang.Object

org.opencms.xml.containerpage.CmsFormatterBean

org.opencms.xml.containerpage.CmsMacroFormatterBean

All Implemented Interfaces:

java.lang.Cloneable, I_CmsFormatterBean

public class CmsMacroFormatterBean
extends CmsFormatterBean

Formatter configuration for macro formatters.

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

CmsMacroFormatterBean(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, int minWidth, int maxWidth, boolean searchContent, java.lang.String location, java.lang.String niceName, java.lang.String description, java.util.Collection<java.lang.String> resourceTypeNames, int rank, java.lang.String id, java.lang.String defaultContentRootPath, CmsUUID defaultContentStructureId, CmsSettingConfiguration settingConfig, boolean isAutoEnabled, boolean isDetail, java.lang.String displayType, boolean isAllowsSettingsInEditor, java.lang.String macroInput, java.lang.String placeholderMacroInput, java.util.Map<java.lang.String,CmsUUID> referencedFormatters, boolean online, java.util.List<CmsMetaMapping> metaMappings, boolean useMetaMappingsForNormalElements)

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultContentRootPath()	Returns the root path to the default content.
CmsUUID	getDefaultContentStructureId()	Returns the UUID of the default content.
java.lang.String	getMacroInput()	Returns the macro input.
java.lang.String	getPlaceholderMacroInput()	Returns the placeholder macro input.
java.util.Map<java.lang.String,CmsUUID>	getReferencedFormatters()	The referenced formatters.
java.util.Map<java.lang.String,CmsXmlContentProperty>	getSettings(CmsADEConfigData config)	Gets the defined settings.

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

getAliasKeys, getAllKeys, getAttributes, getContainerTypes, getCssHeadIncludes, getDescription, getDisplayType, getId, getInlineCss, getInlineJavascript, getJavascriptHeadIncludes, getJspRootPath, getJspStructureId, getKey, getLocation, getMaxWidth, getMetaMappings, getMinWidth, getNiceName, getRank, getResourceTypeNames, 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

CmsMacroFormatterBean

public CmsMacroFormatterBean(java.util.Set<java.lang.String> containerTypes,
                             java.lang.String jspRootPath,
                             CmsUUID jspStructureId,
                             int minWidth,
                             int maxWidth,
                             boolean searchContent,
                             java.lang.String location,
                             java.lang.String niceName,
                             java.lang.String description,
                             java.util.Collection<java.lang.String> resourceTypeNames,
                             int rank,
                             java.lang.String id,
                             java.lang.String defaultContentRootPath,
                             CmsUUID defaultContentStructureId,
                             CmsSettingConfiguration settingConfig,
                             boolean isAutoEnabled,
                             boolean isDetail,
                             java.lang.String displayType,
                             boolean isAllowsSettingsInEditor,
                             java.lang.String macroInput,
                             java.lang.String placeholderMacroInput,
                             java.util.Map<java.lang.String,CmsUUID> referencedFormatters,
                             boolean online,
                             java.util.List<CmsMetaMapping> metaMappings,
                             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

minWidth - the formatter min width

maxWidth - the formatter max width

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

niceName - the configuration display name

description - the description

resourceTypeNames - the resource type names

rank - the configuration rank

id - the configuration id

defaultContentRootPath - the root path to the default content

defaultContentStructureId - the UUID of the default content resource

settingConfig - the settings configuration

isDetail - true if detail formatter

isAutoEnabled - true if auto enabled

displayType - the display type

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

macroInput - the macro input

placeholderMacroInput - the placeholder macro input

referencedFormatters - the referenced formatters

online - if this is the online version

metaMappings - the meta mappings

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

Method Detail

getDefaultContentRootPath

public java.lang.String getDefaultContentRootPath()

Returns the root path to the default content.

Returns:

the root path to the default content

getDefaultContentStructureId

public CmsUUID getDefaultContentStructureId()

Returns the UUID of the default content.

Returns:

the UUID of the default content

getMacroInput

public java.lang.String getMacroInput()

Returns the macro input.

Returns:

the macro input

getPlaceholderMacroInput

public java.lang.String getPlaceholderMacroInput()

Returns the placeholder macro input.

Returns:

the placeholder macro input

getReferencedFormatters

public java.util.Map<java.lang.String,CmsUUID> getReferencedFormatters()

The referenced formatters.

Returns:

the reference formatters

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

Overrides:

getSettings in class CmsFormatterBean

Parameters:

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

Returns:

the defined settings

See Also:

CmsFormatterBean.getSettings(org.opencms.ade.configuration.CmsADEConfigData)