Class CmsDynamicFunctionBean

  • public class CmsDynamicFunctionBean
    extends java.lang.Object
    A class which contains the data parsed from a dynamic function XML content.

    • Method Detail

      • getFormatForContainer

        public CmsDynamicFunctionBean.Format getFormatForContainer​(CmsObject cms,
                                                                   java.lang.String type,
                                                                   int width)
        Finds the correct format for a given container type and width.

        cms - the current CMS context
        type - the container type
        width - the container width
        the format for the given container type and width
      • getFormatters

        public java.util.List<CmsFormatterBeangetFormatters()
        Creates the formatter list for this dynamic function.

        the formatter list for this dynamic function
      • getFunctionFormatter

        public CmsResource getFunctionFormatter()
        Gets the generic function formatter resource.

        the generic function formatter resource
      • getSettings

        public java.util.Map<java.lang.String,​CmsXmlContentPropertygetSettings()
        Returns the setting configuration for this dynamic function.

        the setting configuration for this dynamic function
      • createFormatterBean

        protected CmsFormatterBean createFormatterBean​(CmsDynamicFunctionBean.Format format,
                                                       boolean isPreview)
        Helper method to create a formatter bean from a format.

        format - the format bean
        isPreview - if true, the formatter returned will be marked as a preview formatter
        the formatter corresponding to the format