Class CmsDecorationObject


  • public class CmsDecorationObject
    extends java.lang.Object
    The CmsDecorationObject defines a single text decoration.

    It uses the information of a CmsDecorationDefintion to create the pre- and postfix for a text decoration.

    Since:
    6.1.3
    • Constructor Detail

      • CmsDecorationObject

        public CmsDecorationObject()
        Constructor, creates a new, empty decoration object.

      • CmsDecorationObject

        public CmsDecorationObject​(java.lang.String decorationKey,
                                   java.lang.String decoration,
                                   CmsDecorationDefintion decDef,
                                   java.util.Locale locale)
        Constructor, creates a new decoration object with given values.

        Parameters:
        decorationKey - the decoration key
        decoration - the decoration for this decoration key
        decDef - the decoration defintion to be used
        locale - the locale of this decoration object
    • Method Detail

      • getContentDecoration

        public java.lang.String getContentDecoration​(I_CmsDecoratorConfiguration config,
                                                     java.lang.String text,
                                                     java.lang.String contentLocale)
        Gets the decorated content for this decoration object.

        Parameters:
        config - the configuration used
        text - the text to be decorated
        contentLocale - the locale of the content to be decorated
        Returns:
        decorated content
      • getDecoration

        public java.lang.String getDecoration()
        Returns the decoration.

        Returns:
        the decoration
      • getDecorationKey

        public java.lang.String getDecorationKey()
        Returns the decorationKey.

        Returns:
        the decorationKey
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()