com.sitemesh.taglib.page
Class PanelTag

java.lang.Object
  |
  +--com.sitemesh.taglib.AbstractTag
        |
        +--com.sitemesh.taglib.page.PanelTag

public class PanelTag
extends AbstractTag

This tag inserts an external resource as a panel into the current Page.

The page attribute is required and points to the panel resource which should expose an entire page (e.g. another JSP file producing HTML). This attribute can be relative to the page it is being called from or an absolute path from the context-root.

The (optional) decorator attribute is the name of the Decorator to apply to the included page. Note that the implementation of DecoratorMapper can overide this.

Version:
$Revision: 1.5 $
Author:
Joe Walnes

Fields inherited from class com.sitemesh.taglib.AbstractTag
pageContext, parent
 
Constructor Summary
PanelTag()
           
 
Method Summary
 int doEndTag()
          Standard taglib method: apply decorator to page.
 void release()
          Standard taglib method: resets attributes.
 void setDecorator(java.lang.String decorator)
          Tag attribute: Name of Decorator to apply to Page.
 void setPage(java.lang.String page)
          Tag attribute: URI of page to include.
 
Methods inherited from class com.sitemesh.taglib.AbstractTag
doStartTag, getPage, getParent, setPageContext, setParent, trace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PanelTag

public PanelTag()
Method Detail

setPage

public void setPage(java.lang.String page)
Tag attribute: URI of page to include. Can be relative to page being called from, or absolute path from context-root of web-app.

setDecorator

public void setDecorator(java.lang.String decorator)
Tag attribute: Name of Decorator to apply to Page. This is passed to DecoratorMapper to retrieve appropriate Decorator. DecoratorMapper may override if needed.
See Also:
DecoratorMapper

release

public void release()
Standard taglib method: resets attributes.
Overrides:
release in class AbstractTag

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Standard taglib method: apply decorator to page.
Overrides:
doEndTag in class AbstractTag