Class CmsFormatterBean

    • Field Summary

      Modifier and Type Field Description
      Default rank for formatters from formatter configuration files.
      static int DEFAULT_SCHEMA_RANK
      Default rank for formatters defined in schema.
      protected java.util.Set<java.lang.String> m_aliasKeys
      Set of alias keys.
      protected java.util.Set<java.lang.String> m_containerTypes
      The formatter container type.
      protected java.util.Set<java.lang.String> m_cssHeadIncludes
      CSS Head includes.
      protected java.lang.String m_description
      The description text for the formatter.
      protected java.lang.String m_displayType
      Provides the display type.
      protected java.lang.String m_id
      The id for this formatter.
      protected java.lang.String m_inlineCss
      Inline CSS snippets.
      protected java.lang.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 java.util.List<java.lang.String> m_javascriptHeadIncludes
      JavaScript head includes.
      protected java.lang.String m_jspRootPath
      The formatter JSP.
      protected CmsUUID m_jspStructureId
      The UUID of the JSP resource for this formatter.
      protected java.lang.String m_key
      The formatter key.
      protected java.lang.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 java.util.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 java.lang.String m_niceName
      The nice name.
      protected java.util.List<CmsTemplatePlugin> m_plugins
      The referenced plugins.
      protected int m_rank
      The rank.
      protected java.util.Collection<java.lang.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 java.lang.String PREVIEW_TYPE
      Default formatter type constant.
      static int PREVIEW_WIDTH
      The width of the preview window for the formatters.
      static java.lang.String WILDCARD_TYPE
      Wildcard formatter type for width based formatters.
    • Constructor Summary

      Constructor Description
      CmsFormatterBean​(java.lang.String containerType, java.lang.String jspRootPath, java.lang.String minWidthStr, java.lang.String maxWidthStr, java.lang.String preview, java.lang.String searchContent, java.lang.String location)
      Constructor for creating a new formatter configuration without resource structure id.
      CmsFormatterBean​(java.lang.String containerType, java.lang.String rootPath, CmsUUID structureId, int minWidth, int maxWidth, boolean preview, boolean searchContent, java.lang.String location)
      Constructor for creating a new formatter configuration with resource structure id.
      CmsFormatterBean​(java.util.Set<java.lang.String> containerTypes, java.lang.String jspRootPath, CmsUUID jspStructureId, java.lang.String key, java.util.Set<java.lang.String> aliasKeys, int minWidth, int maxWidth, boolean preview, boolean searchContent, 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.util.Collection<java.lang.String> resourceTypeNames, int rank, java.lang.String id, CmsSettingConfiguration settingConfig, boolean isFromConfigFile, boolean isAutoEnabled, boolean isDetail, java.lang.String displayType, boolean isAllowsSettingsInEditor, boolean strictContainers, boolean nestedFormatterSettings, java.util.List<CmsMetaMapping> metaMappings, java.util.Map<java.lang.String,​java.lang.String> attributes, boolean useMetaMappingsForNormalElements)
      Constructor for creating a new formatter configuration with resource structure id.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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.
      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​(java.lang.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.
      java.lang.String toString()  
      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, notify, notifyAll, wait, wait, wait