Package org.opencms.jsp.decorator

Interface I_CmsDecoratorConfiguration

All Known Implementing Classes:

CmsDecoratorConfiguration

public interface I_CmsDecoratorConfiguration

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

Modifier and Type	Method	Description
CmsDecorationDefintion	getDecorationDefinition(CmsXmlContent configuration, int i)	Builds a CmsDecorationDefintion from a given configuration file.
CmsDecorationBundle	getDecorations()	Gets the decoration bundle.
boolean	hasUsed(String key)	Tests if a decoration key was used before in this configuration.
void	init(CmsObject cms, String configFile, Locale locale)	Initialises the configuration.
boolean	isExcluded(String tag)	Tests if a tag is contained in the exclude list of the decorator.
boolean	isExcludedAttr(org.htmlparser.Tag tag)	Tests if a tag has an attribute thatis contained in the exclude list of the decorator.
void	markAsUsed(String key)	Mark a decoration key as already used.
void	resetMarkedDecorations()	Resets the used decoration keys.

Method Details

getDecorationDefinition

CmsDecorationDefintion getDecorationDefinition(CmsXmlContent configuration,
 int i)

Builds a CmsDecorationDefintion from a given configuration file.

Parameters:

configuration - the configuration file

i - the number of the decoration definition to create

Returns:

CmsDecorationDefintion created form configuration file

getDecorations

CmsDecorationBundle getDecorations()

Gets the decoration bundle.

Returns:

the decoration bundle to be used

hasUsed

boolean hasUsed(String key)

Tests if a decoration key was used before in this configuration.

Parameters:

key - the key to look for

Returns:

true if this key was already used

init

void init(CmsObject cms,
 String configFile,
 Locale locale)
   throws CmsException

Initialises the configuration.

Parameters:

cms - the CmsObject

configFile - the configuration file

locale - to locale to build this configuration for

Throws:

CmsException - if something goes wrong

isExcluded

boolean isExcluded(String tag)

Tests if a tag is contained in the exclude list of the decorator.

Parameters:

tag - the tag to test

Returns:

true if the tag is in the exclude list, false otherwise.

isExcludedAttr

boolean isExcludedAttr(org.htmlparser.Tag tag)

Tests if a tag has an attribute thatis contained in the exclude list of the decorator.

Parameters:

tag - the tag to test

Returns:

true if the tag is in the exclude list, false otherwise.

markAsUsed

void markAsUsed(String key)

Mark a decoration key as already used.

Parameters:

key - the key to mark

resetMarkedDecorations

void resetMarkedDecorations()

Resets the used decoration keys.