|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.jsp.decorator.CmsDecoratorConfiguration
public class CmsDecoratorConfiguration
The CmsDecoratorConfiguration initalizes and stores the text decorations.
It uses uses the information of one or more
to create the
pre- and postfixs for text decorations.
CmsDecorationDefintion
Constructor Summary | |
---|---|
CmsDecoratorConfiguration(CmsObject cms)
Constructor, creates a new, empty CmsDecoratorConfiguration. |
|
CmsDecoratorConfiguration(CmsObject cms,
java.lang.String configFile)
Constructor, creates a new, CmsDecoratorConfiguration with a given config file. |
|
CmsDecoratorConfiguration(CmsObject cms,
java.lang.String configFile,
java.util.Locale locale)
Constructor, creates a new, CmsDecoratorConfiguration with a given config file and locale. |
Method Summary | |
---|---|
void |
addDecorations(CmsDecorationDefintion decorationDefinition)
Adds decorations defined in a object to the map of all decorations. |
CmsDecorationBundle |
getDecorations()
Gets the decoration bundle. |
boolean |
hasUsed(java.lang.String key)
Tests if a decoration key was used before in this configuration. |
boolean |
isExcluded(java.lang.String tag)
Tests if a tag is contained in the exclude list of the decorator. |
void |
markAsUsed(java.lang.String key)
Mark a decoration key as already used. |
void |
resetMarkedDecorations()
Resets the used decoration keys. |
void |
setDecorations(CmsDecorationBundle decorations)
Sets the decoration bundle, overwriting an exiting one. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CmsDecoratorConfiguration(CmsObject cms)
cms
- the CmsObjectpublic CmsDecoratorConfiguration(CmsObject cms, java.lang.String configFile) throws CmsException
cms
- the CmsObjectconfigFile
- the configuration file
CmsException
- if something goes wrongpublic CmsDecoratorConfiguration(CmsObject cms, java.lang.String configFile, java.util.Locale locale) throws CmsException
cms
- the CmsObjectconfigFile
- the configuration filelocale
- to locale to build this configuration for
CmsException
- if something goes wrongMethod Detail |
---|
public void addDecorations(CmsDecorationDefintion decorationDefinition) throws CmsException
CmsDecorationDefintion
object to the map of all decorations.
decorationDefinition
- the CmsDecorationDefintion
the decorations to be added
CmsException
- if something goes wrongpublic CmsDecorationBundle getDecorations()
public boolean hasUsed(java.lang.String key)
key
- the key to look for
public boolean isExcluded(java.lang.String tag)
tag
- the tag to test
public void markAsUsed(java.lang.String key)
key
- the key to markpublic void resetMarkedDecorations()
public void setDecorations(CmsDecorationBundle decorations)
decorations
- new decoration bundlepublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |