Class CmsFunctionFormatterBean

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

        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