com.opensymphony.module.sitemesh.mapper: public class: ParameterDecoratorMapper

com.opensymphony.module.sitemesh.mapper
public class: ParameterDecoratorMapper [javadoc | source]

java.lang.Object
   com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
      com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper

All Implemented Interfaces:
DecoratorMapper

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.

Also see:

com.opensymphony.module.sitemesh.DecoratorMapper

author: < - a href="mailto:mcannon@internet.com">Mike Cannon-Brookes

version: $ - Revision: 1.2 $

Fields inherited from com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper:
parent, config

Method from com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper Summary:
getDecorator, init

Methods from com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper:
getDecorator, getNamedDecorator, init

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper Detail:
public Decorator getDecorator(HttpServletRequest request, Page page) { Decorator result = null; String decoratorParamValue = request.getParameter(decoratorParameter); if ((paramName == null \|\| paramValue.equals(request.getParameter(paramName))) && decoratorParamValue != null && !decoratorParamValue.trim().equals("")) { result = getNamedDecorator(request, decoratorParamValue); } return result == null ? super.getDecorator(request, page) : result; }
public void init(Config config, Properties properties, DecoratorMapper parent) throws InstantiationException { super.init(config, properties, parent); decoratorParameter = properties.getProperty("decorator.parameter", "decorator"); paramName = properties.getProperty("parameter.name", null); paramValue = properties.getProperty("parameter.value", null); }

Method from com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper Detail:

 public Decorator getDecorator(HttpServletRequest request,
    Page page) {
        Decorator result = null;
        String decoratorParamValue = request.getParameter(decoratorParameter);
        if ((paramName == null || paramValue.equals(request.getParameter(paramName)))
            && decoratorParamValue != null && !decoratorParamValue.trim().equals("")) {
                result = getNamedDecorator(request, decoratorParamValue);
        }
        return result == null ? super.getDecorator(request, page) : result;
}

 public  void init(Config config,
    Properties properties,
    DecoratorMapper parent) throws InstantiationException {
              
        super.init(config, properties, parent);
        decoratorParameter = properties.getProperty("decorator.parameter", "decorator");
        paramName = properties.getProperty("parameter.name", null);
        paramValue = properties.getProperty("parameter.value", null);
}