Home » sitemesh-2.4.1 » com.opensymphony.module » sitemesh » taglib » page » [javadoc | source]
public class: ApplyDecoratorTag [javadoc | source]

All Implemented Interfaces:
    RequestConstants, BodyTag, IterationTag, Serializable

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

The page attribute should point 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.


If the page attribute is not specified, the body content is parsed into the com.opensymphony.module.sitemesh.Page object and has the com.opensymphony.module.sitemesh.Decorator applied.

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

Nested Class Summary:
class  ApplyDecoratorTag.ApplyDecoratorException   
Fields inherited from javax.servlet.jsp.tagext.BodyTagSupport:
Fields inherited from javax.servlet.jsp.tagext.TagSupport:
id,  pageContext,  class$javax$servlet$jsp$tagext$Tag
Method from com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag Summary:
addParam,   doAfterBody,   doEndTag,   doStartTag,   release,   setContentType,   setDecorator,   setEncoding,   setId,   setName,   setPage,   setTitle,   trace
Methods from javax.servlet.jsp.tagext.BodyTagSupport:
doAfterBody,   doEndTag,   doInitBody,   doStartTag,   getBodyContent,   getPreviousOut,   release,   setBodyContent
Methods from javax.servlet.jsp.tagext.TagSupport:
class$,   doAfterBody,   doEndTag,   doStartTag,   findAncestorWithClass,   getId,   getParent,   getValue,   getValues,   release,   removeValue,   setId,   setPageContext,   setParent,   setValue
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag Detail:
  void addParam(String name,
    String value) 
    Add a parameter to the page. This has a package level access modifier so ParamTag can also call it.
 public int doAfterBody() throws JspException 
    Ensure that external page contents are included in bodycontent.
 public int doEndTag() throws JspException 
    Standard taglib method: apply decorator to page.
 public int doStartTag() 
 public  void release() 
    Release all attributes
 public  void setContentType(String contentType) 
 public  void setDecorator(String decorator) 
Deprecated! Use - setName() instead.

 public  void setEncoding(String encoding) 
 public  void setId(String id) 
    Tag attribute: If set, this value will override the 'id' property of the page. This is a convenience utility and is identical to specifing a 'page:param name=id' tag.
 public  void setName(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.
 public  void setPage(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.
 public  void setTitle(String title) 
    Tag attribute: If set, this value will override the 'title' property of the page. This is a convenience utility and is identical to specifing a 'page:param name=title' tag.
 public static  void trace(Exception e) 
    Log exception generated by taglib.