Package org.opencms.jsp.decorator

Class CmsDecorationObject

java.lang.Object

org.opencms.jsp.decorator.CmsDecorationObject

public class CmsDecorationObject
extends 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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MACRO_DECORATION	Macro for the decoration.
static final String	MACRO_DECORATIONKEY	Macro for the decoration key.
static final String	MACRO_LANGUAGE	Macro for the language.
static final String	MACRO_LOCALE	Macro for the locale.

Constructor Summary

Constructors

Constructor	Description
CmsDecorationObject()	Constructor, creates a new, empty decoration object.
CmsDecorationObject(String decorationKey, String decoration, CmsDecorationDefintion decDef, Locale locale)	Constructor, creates a new decoration object with given values.

Method Summary

Modifier and Type	Method	Description
String	getContentDecoration(I_CmsDecoratorConfiguration config, String text, String contentLocale)	Gets the decorated content for this decoration object.
String	getDecoration()	Returns the decoration.
CmsDecorationDefintion	getDecorationDefinition()	Returns the decorationDefinition.
String	getDecorationKey()	Returns the decorationKey.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MACRO_DECORATION

public static final String MACRO_DECORATION

Macro for the decoration.

See Also:

• Constant Field Values

MACRO_DECORATIONKEY

public static final String MACRO_DECORATIONKEY

Macro for the decoration key.

See Also:

• Constant Field Values

MACRO_LANGUAGE

public static final String MACRO_LANGUAGE

Macro for the language.

See Also:

• Constant Field Values

MACRO_LOCALE

public static final String MACRO_LOCALE

Macro for the locale.

See Also:

• Constant Field Values

Constructor Details

CmsDecorationObject

public CmsDecorationObject()

Constructor, creates a new, empty decoration object.

CmsDecorationObject

public CmsDecorationObject(String decorationKey,
 String decoration,
 CmsDecorationDefintion decDef,
 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 Details

getContentDecoration

public String getContentDecoration(I_CmsDecoratorConfiguration config,
 String text,
 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 String getDecoration()

Returns the decoration.

Returns:

the decoration

getDecorationDefinition

public CmsDecorationDefintion getDecorationDefinition()

Returns the decorationDefinition.

Returns:

the decorationDefinition

getDecorationKey

public String getDecorationKey()

Returns the decorationKey.

Returns:

the decorationKey

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()