Save This Page
Home » sitemesh-2.3 » com.opensymphony.module » sitemesh » mapper » [javadoc | source]
com.opensymphony.module.sitemesh.mapper
public class: PageDecoratorMapper [javadoc | source]
java.lang.Object
   com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
      com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper

All Implemented Interfaces:
    DecoratorMapper

The PageDecoratorMapper allows the actual Page to determine the Decorator to be used.

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 .

Fields inherited from com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper:
parent,  config
Method from com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper 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.PageDecoratorMapper Detail:
 public Decorator getDecorator(HttpServletRequest request,
    Page page) 
 public  void init(Config config,
    Properties properties,
    DecoratorMapper parent) throws InstantiationException