Package com.opensymphony.module.sitemesh.mapper

Class ParameterDecoratorMapper

java.lang.Object

com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper

All Implemented Interfaces:

DecoratorMapper

public class ParameterDecoratorMapper
extends AbstractDecoratorMapper

The ParameterDecoratorMapper will map a suitable decorator based on request parameters.

The ParameterDecoratorMapper is configured via three properties.

decorator.parameter - the parameter which contains the name of the decorator which will be mapped. The default is "decorator".

For example if decorator.parameter is "foobar" then myurl.jsp?foobar=mydecorator will map to the decorator named "mydecorator".

You can also supply an optional 'confirmation parameter'. The decorator will only be mapped if the parameter named parameter.name is in the request URI and the value of that parameter is equal to the parameter.value property.

For example assuming parameter.name=confirm and parameter.value=true the URI myurl.jsp?decorator=mydecorator&confirm=true will map the decorator mydecorator. where as the URIs myurl.jsp?decorator=mydecorator and myurl.jsp?decorator=mydecorator&confirm=false will not return any decorator.

Author:

Mike Cannon-Brookes

See Also:

• DecoratorMapper

Field Summary

Fields inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

config, parent

Constructor Summary

Constructors

Constructor	Description
ParameterDecoratorMapper()

Method Summary

Modifier and Type	Method	Description
Decorator	getDecorator(javax.servlet.http.HttpServletRequest request, Page page)	Return appropriate Decorator for a certain Page.
void	init(Config config, Properties properties, DecoratorMapper parent)	Initialize the mapper.

Methods inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

getNamedDecorator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParameterDecoratorMapper

public ParameterDecoratorMapper()

Method Details

init

public void init(Config config,
 Properties properties,
 DecoratorMapper parent)
          throws InstantiationException

Description copied from interface: DecoratorMapper

Initialize the mapper. This is always called before the other methods.

Specified by:

init in interface DecoratorMapper

Overrides:

init in class AbstractDecoratorMapper

Parameters:

config - Config supplied by Servlet or Filter.

properties - Any initialization properties (specific to implementation).

parent - the parent

Throws:

InstantiationException - the instantiation exception

getDecorator

public Decorator getDecorator(javax.servlet.http.HttpServletRequest request,
 Page page)

Description copied from interface: DecoratorMapper

Return appropriate Decorator for 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:

getDecorator in interface DecoratorMapper

Overrides:

getDecorator in class AbstractDecoratorMapper

Parameters:

request - the request

page - the page

Returns:

the decorator