com.opensymphony.module.sitemesh: public interface: DecoratorMapper

com.opensymphony.module.sitemesh
public interface: DecoratorMapper [javadoc | source]

All Known Implementing Classes:
LanguageDecoratorMapper, InlineDecoratorMapper, AgentDecoratorMapper, EnvEntryDecoratorMapper, AbstractDecoratorMapper, SessionDecoratorMapper, ParameterDecoratorMapper, NullDecoratorMapper, ConfigDecoratorMapper, FileDecoratorMapper, OSDecoratorMapper, FrameSetDecoratorMapper, CookieDecoratorMapper, PageDecoratorMapper, PrintableDecoratorMapper, RobotDecoratorMapper

The DecoratorMapper is responsible for determining which com.opensymphony.module.sitemesh.Decorator should be used for a com.opensymphony.module.sitemesh.Page .

Implementations of this are returned by the com.opensymphony.module.sitemesh.Factory , and should be thread-safe.

author: < - a href="mailto:joe@truemesh.com">Joe Walnes

version: $ - Revision: 1.2 $

Method from com.opensymphony.module.sitemesh.DecoratorMapper Summary:
getDecorator, getNamedDecorator, init

Method from com.opensymphony.module.sitemesh.DecoratorMapper Detail:
public Decorator getDecorator(HttpServletRequest request, Page page) Return appropriate com.opensymphony.module.sitemesh.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.
public Decorator getNamedDecorator(HttpServletRequest request, String name) Return a com.opensymphony.module.sitemesh.Decorator with given name.
public void init(Config config, Properties properties, DecoratorMapper parent) throws InstantiationException Initialize the mapper. This is always called before the other methods.

Method from com.opensymphony.module.sitemesh.DecoratorMapper Detail:

 public Decorator getDecorator(HttpServletRequest request,
    Page page)Return appropriate com.opensymphony.module.sitemesh.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.

 public Decorator getNamedDecorator(HttpServletRequest request,
    String name)Return a com.opensymphony.module.sitemesh.Decorator  with given name.

 public  void init(Config config,
    Properties properties,
    DecoratorMapper parent) throws InstantiationExceptionInitialize the mapper. This is always called before the other methods.