Package com.opensymphony.module.sitemesh.taglib.page

Class ApplyDecoratorTag

  • All Implemented Interfaces:
    RequestConstants, Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class ApplyDecoratorTag
extends javax.servlet.jsp.tagext.BodyTagSupport
implements RequestConstants
    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.

    OR

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

    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.10 $
    Author:
    Joe Walnes
    See Also:
    Serialized Form

    • Constructor Detail

      • ApplyDecoratorTag

        public ApplyDecoratorTag()

    • Method Detail

      • setPage

        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.

      • addParam

        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.

      • setTitle

        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.

      • setId

        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.
        Overrides:
        setId in class javax.servlet.jsp.tagext.TagSupport

      • setName

        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.
        See Also:
        DecoratorMapper

      • setDecorator

        public void setDecorator​(String decorator)
        Deprecated.
        Use setName() instead.

      • setContentType

        public void setContentType​(String contentType)

      • setEncoding

        public void setEncoding​(String encoding)

      • doStartTag

        public int doStartTag()
        Specified by:
        doStartTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

      • doAfterBody

        public int doAfterBody()
                throws javax.servlet.jsp.JspException
        Ensure that external page contents are included in bodycontent.
        Specified by:
        doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
        Overrides:
        doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport
        Throws:
        javax.servlet.jsp.JspException

      • doEndTag

        public int doEndTag()
             throws javax.servlet.jsp.JspException
        Standard taglib method: apply decorator to page.
        Specified by:
        doEndTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
        Throws:
        javax.servlet.jsp.JspException