Interface I_CmsDecoratorConfiguration

  • All Known Implementing Classes:
    CmsDecoratorConfiguration

    public interface I_CmsDecoratorConfiguration
    Interface for a CmsDecoratorConfiguration.

    This interface describes a CmsDecoratorConfiguration which provides methods to get a filled CmsDecorationBundle. A decoration bundle contains a datastructure of text decorations which can be used in the current request context.

    • Method Detail

      • getDecorationDefinition

        CmsDecorationDefintion getDecorationDefinition​(CmsXmlContent configuration,
                                                       int i)
        Builds a CmsDecorationDefintion from a given configuration file.

        Parameters:
        configuration - the configuration file
        i - the number of the decoration definition to create
        Returns:
        CmsDecorationDefintion created form configuration file
      • hasUsed

        boolean hasUsed​(java.lang.String key)
        Tests if a decoration key was used before in this configuration.

        Parameters:
        key - the key to look for
        Returns:
        true if this key was already used
      • init

        void init​(CmsObject cms,
                  java.lang.String configFile,
                  java.util.Locale locale)
           throws CmsException
        Initialises the configuration.

        Parameters:
        cms - the CmsObject
        configFile - the configuration file
        locale - to locale to build this configuration for
        Throws:
        CmsException - if something goes wrong
      • isExcluded

        boolean isExcluded​(java.lang.String tag)
        Tests if a tag is contained in the exclude list of the decorator.

        Parameters:
        tag - the tag to test
        Returns:
        true if the tag is in the exclude list, false otherwise.
      • isExcludedAttr

        boolean isExcludedAttr​(org.htmlparser.Tag tag)
        Tests if a tag has an attribute thatis contained in the exclude list of the decorator.

        Parameters:
        tag - the tag to test
        Returns:
        true if the tag is in the exclude list, false otherwise.
      • markAsUsed

        void markAsUsed​(java.lang.String key)
        Mark a decoration key as already used.

        Parameters:
        key - the key to mark