org.opencms.jsp.decorator

类 CmsDecorationObject

java.lang.Object

org.opencms.jsp.decorator.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.

从以下版本开始:

6.1.3

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	MACRO_DECORATION Macro for the decoration.
static java.lang.String	MACRO_DECORATIONKEY Macro for the decoration key.
static java.lang.String	MACRO_LANGUAGE Macro for the language.
static java.lang.String	MACRO_LOCALE Macro for the locale.

构造器概要

构造器

构造器和说明
CmsDecorationObject() Constructor, creates a new, empty decoration object.
CmsDecorationObject(java.lang.String decorationKey, java.lang.String decoration, CmsDecorationDefintion decDef, java.util.Locale locale) Constructor, creates a new decoration object with given values.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getContentDecoration(I_CmsDecoratorConfiguration config, java.lang.String text, java.lang.String contentLocale) Gets the decorated content for this decoration object.
java.lang.String	getDecoration() Returns the decoration.
CmsDecorationDefintion	getDecorationDefinition() Returns the decorationDefinition.
java.lang.String	getDecorationKey() Returns the decorationKey.
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

字段详细资料

MACRO_DECORATION

public static final java.lang.String MACRO_DECORATION

Macro for the decoration.

另请参阅:

常量字段值

MACRO_DECORATIONKEY

public static final java.lang.String MACRO_DECORATIONKEY

Macro for the decoration key.

另请参阅:

常量字段值

MACRO_LANGUAGE

public static final java.lang.String MACRO_LANGUAGE

Macro for the language.

另请参阅:

常量字段值

MACRO_LOCALE

public static final java.lang.String MACRO_LOCALE

Macro for the locale.

另请参阅:

常量字段值

构造器详细资料

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.

参数:

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

方法详细资料

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.

参数:

config - the configuration used

text - the text to be decorated

contentLocale - the locale of the content to be decorated

返回:

decorated content

getDecoration

public java.lang.String getDecoration()

Returns the decoration.

返回:

the decoration

getDecorationDefinition

public CmsDecorationDefintion getDecorationDefinition()

Returns the decorationDefinition.

返回:

the decorationDefinition

getDecorationKey

public java.lang.String getDecorationKey()

Returns the decorationKey.

返回:

the decorationKey

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()