Package org.opencms.xml.containerpage
Class CmsFlexFormatterBean
- java.lang.Object
-
- org.opencms.xml.containerpage.CmsFormatterBean
-
- org.opencms.xml.containerpage.CmsFlexFormatterBean
-
- All Implemented Interfaces:
java.lang.Cloneable
,I_CmsFormatterBean
public class CmsFlexFormatterBean extends CmsFormatterBean
Formatter configuration for flex 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 CmsFlexFormatterBean(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, java.lang.String key, 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 stringTemplate, java.lang.String placeholderStringTemplate, java.util.List<CmsMetaMapping> metaMappings, boolean useMetaMappingsForNormalElements)
Constructor for creating a new formatter configuration with resource structure id.
-
Method Summary
All Methods Instance Methods Concrete Methods 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
getPlaceholderStringTemplate()
Returns the placeholder string template.java.lang.String
getStringTemplate()
Returns the string template.-
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, 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
-
CmsFlexFormatterBean
public CmsFlexFormatterBean(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, java.lang.String key, 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 stringTemplate, java.lang.String placeholderStringTemplate, java.util.List<CmsMetaMapping> metaMappings, boolean useMetaMappingsForNormalElements)
Constructor for creating a new formatter configuration with resource structure id.- Parameters:
containerTypes
- the formatter container typesjspRootPath
- the formatter JSP VFS root pathjspStructureId
- the structure id of the formatter JSPkey
- the formatter keyminWidth
- the formatter min widthmaxWidth
- the formatter max widthsearchContent
- indicates if the content should be searchable in the online index when this formatter is usedlocation
- the location where this formatter was defined, should be an OpenCms VFS resource pathniceName
- the configuration display namedescription
- the help text for the formatterresourceTypeNames
- the resource type namesrank
- the configuration rankid
- the configuration iddefaultContentRootPath
- the root path to the default contentdefaultContentStructureId
- the UUID of the default content resourcesettingConfig
- the settings configurationisDetail
-true
if detail formatterisAutoEnabled
-true
if auto enableddisplayType
- the display typeisAllowsSettingsInEditor
- whether this formatter allows settings to be edited in the content editorstringTemplate
- the string templateplaceholderStringTemplate
- the placeholder string templatemetaMappings
- the meta mappingsuseMetaMappingsForNormalElements
- 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
-
getPlaceholderStringTemplate
public java.lang.String getPlaceholderStringTemplate()
Returns the placeholder string template.- Returns:
- the placeholder string template
-
getStringTemplate
public java.lang.String getStringTemplate()
Returns the string template.- Returns:
- the string template
-
-