org.opencms.jsp.decorator

类 CmsDecorationMap

java.lang.Object

org.opencms.jsp.decorator.CmsDecorationMap

所有已实现的接口:

java.lang.Comparable<CmsDecorationMap>

public class CmsDecorationMap
extends java.lang.Object
implements java.lang.Comparable<CmsDecorationMap>

The CmsDecorationMap is the object representation of a single decoartion file.

The semicolon seperated elements of the decoartion file are stored in a map.

The map uses the decoration as keys and CmsDecorationObjects as values.

Multiple CmsDecorationMaps form a CmsDecorationBundle.

从以下版本开始:

6.1.3

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CSV_SEPERATOR The seperator for the CSV file.

构造器概要

构造器

构造器和说明
CmsDecorationMap(CmsDecorationDefintion decDef, java.lang.String name, java.util.Locale locale) Constructor, creates a new, empty CmsDecorationMap.
CmsDecorationMap(CmsObject cms, CmsResource res, CmsDecorationDefintion decDef) Constructor, creates a new CmsDecorationMap.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(CmsDecorationMap o)
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,CmsDecorationObject>	getDecorationMap() Returns the decorationMap.
java.util.Locale	getLocale() Returns the locale.
java.lang.String	getName() Returns the name.
int	hashCode()
void	setDecorationMap(java.util.Map<java.lang.String,CmsDecorationObject> decorationMap) Sets the decorationMap.
java.lang.String	toString()

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

CSV_SEPERATOR

public static final java.lang.String CSV_SEPERATOR

The seperator for the CSV file.

另请参阅:

常量字段值

构造器详细资料

CmsDecorationMap

public CmsDecorationMap(CmsDecorationDefintion decDef,
                java.lang.String name,
                java.util.Locale locale)

Constructor, creates a new, empty CmsDecorationMap.

参数:

decDef - the CmsDecorationDefintion to be used in this decoration map

name - The name of the decoration map

locale - the locale for this decoration map

CmsDecorationMap

public CmsDecorationMap(CmsObject cms,
                CmsResource res,
                CmsDecorationDefintion decDef)
                 throws CmsException

Constructor, creates a new CmsDecorationMap.

参数:

cms - the CmsObject

res - the resource to extrace the decorations from

decDef - the CmsDecorationDefintion to be used in this decoration map

抛出:

CmsException - if something goes wrong

方法详细资料

compareTo

public int compareTo(CmsDecorationMap o)

指定者:

compareTo 在接口中 java.lang.Comparable<CmsDecorationMap>

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getDecorationMap

public java.util.Map<java.lang.String,CmsDecorationObject> getDecorationMap()

Returns the decorationMap.

返回:

the decorationMap

getLocale

public java.util.Locale getLocale()

Returns the locale.

返回:

the locale

getName

public java.lang.String getName()

Returns the name.

返回:

the name

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

setDecorationMap

public void setDecorationMap(java.util.Map<java.lang.String,CmsDecorationObject> decorationMap)

Sets the decorationMap.

参数:

decorationMap - the decorationMap to set

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()