|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for a CmsDecoratorConfiguration.
This interface describes a CmsDecoratorConfiguration which provides methods to get a filled CmsDecorationBundle. A decoration bundle contains a datastructure of text decorations which can be used in the current request context.
Method Summary | |
CmsDecorationDefintion |
getDecorationDefinition(CmsXmlContent configuration,
int i)
Builds a CmsDecorationDefintion from a given configuration file. |
CmsDecorationBundle |
getDecorations()
Gets the decoration bundle. |
boolean |
hasUsed(java.lang.String key)
Tests if a decoration key was used before in this configuration. |
void |
init(CmsObject cms,
java.lang.String configFile,
java.util.Locale locale)
Initialises the 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. |
Method Detail |
public CmsDecorationDefintion getDecorationDefinition(CmsXmlContent configuration, int i)
configuration
- the configuration filei
- the number of the decoration definition to create
public CmsDecorationBundle getDecorations()
public boolean hasUsed(java.lang.String key)
key
- the key to look for
public void init(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 wrongpublic 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()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |