Class CmsFlexFormatterBean

    • 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.

        containerTypes - the formatter container types
        jspRootPath - the formatter JSP VFS root path
        jspStructureId - the structure id of the formatter JSP
        key - the formatter key
        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 help text for the formatter
        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
        stringTemplate - the string template
        placeholderStringTemplate - the placeholder string template
        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.

        the root path to the default content
      • getPlaceholderStringTemplate

        public java.lang.String getPlaceholderStringTemplate()
        Returns the placeholder string template.

        the placeholder string template
      • getStringTemplate

        public java.lang.String getStringTemplate()
        Returns the string template.

        the string template