Home » sitemesh-2.4.1 » com.opensymphony.module » sitemesh » [javadoc | source]
com.opensymphony.module.sitemesh
public interface: DecoratorMapper [javadoc | source]

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

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.

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)
 public  void init(Config config,
    Properties properties,
    DecoratorMapper parent) throws InstantiationException
    Initialize the mapper. This is always called before the other methods.