Class PageDecoratorMapper
- All Implemented Interfaces:
DecoratorMapper
The 'meta.decorator' and 'decorator' properties of the page are accessed and if any of them contain the name of a valid Decorator, that Decorator shall be applied.
As an example, if HTML is being used, the Decorator could be chosen by using a
<html decorator="mydecorator"> root tag or by using a
<meta name="decorator" content="mydecorator"> tag in the header.
The actual properties to query are specified by passing properties to the mapper using the property.?
prefix. As the properties are stored in a Map, each key has to be unique. Example: property.1=decorator,
property.2=meta.decorator .
- Author:
- Joe Walnes
- See Also:
-
Field Summary
Fields inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
config, parent -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetDecorator(javax.servlet.http.HttpServletRequest request, Page page) Return appropriateDecoratorfor a certain Page.voidinit(Config config, Properties properties, DecoratorMapper parent) Initialize the mapper.Methods inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
getNamedDecorator
-
Constructor Details
-
PageDecoratorMapper
public PageDecoratorMapper()
-
-
Method Details
-
init
public void init(Config config, Properties properties, DecoratorMapper parent) throws InstantiationException Description copied from interface:DecoratorMapperInitialize the mapper. This is always called before the other methods.- Specified by:
initin interfaceDecoratorMapper- Overrides:
initin classAbstractDecoratorMapper- Parameters:
config- Config supplied by Servlet or Filter.properties- Any initialization properties (specific to implementation).parent- the parent- Throws:
InstantiationException- the instantiation exception
-
getDecorator
Description copied from interface:DecoratorMapperReturn appropriateDecoratorfor a certain Page.The implementation can determine the result based on the actual request or the data of the parsed page. Typically this would call
getNamedDecorator()which would delegate to a parent DecoratorMapper.- Specified by:
getDecoratorin interfaceDecoratorMapper- Overrides:
getDecoratorin classAbstractDecoratorMapper- Parameters:
request- the requestpage- the page- Returns:
- the decorator
-