com.opensymphony.module.sitemesh.mapper
Class FrameSetDecoratorMapper

java.lang.Object
  extended by com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
      extended by com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper
All Implemented Interfaces:
DecoratorMapper

public final class FrameSetDecoratorMapper
extends AbstractDecoratorMapper

The FrameSetDecoratorMapper will use the specified decorator when the Page is an instance of HTMLPage and isFrameSet() returns true.

The name of this decorator should be supplied in the decorator property - if no decorator property is supplied, no decorator is applied to frame based pages.

Version:
$Revision: 1.1 $
Author:
Joe Walnes
See Also:
DecoratorMapper

Field Summary
private  String decorator
           
 
Fields inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper
config, parent
 
Constructor Summary
FrameSetDecoratorMapper()
           
 
Method Summary
 Decorator getDecorator(HttpServletRequest request, Page page)
          Delegate to parent.
 void init(Config config, Properties properties, DecoratorMapper parent)
          Set parent.
 
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
 

Field Detail

decorator

private String decorator
Constructor Detail

FrameSetDecoratorMapper

public FrameSetDecoratorMapper()
Method Detail

init

public void init(Config config,
                 Properties properties,
                 DecoratorMapper parent)
          throws InstantiationException
Description copied from class: AbstractDecoratorMapper
Set parent.

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).
Throws:
InstantiationException - should be thrown if the implementation cannot be initialized properly.

getDecorator

public Decorator getDecorator(HttpServletRequest request,
                              Page page)
Description copied from class: AbstractDecoratorMapper
Delegate to parent.

Specified by:
getDecorator in interface DecoratorMapper
Overrides:
getDecorator in class AbstractDecoratorMapper

www.opensymphony.com/sitemesh/