|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag
public class ApplyDecoratorTag
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.
Nested Class Summary | |
---|---|
(package private) class |
ApplyDecoratorTag.ApplyDecoratorException
|
Field Summary | |
---|---|
private Config |
config
|
private java.lang.String |
contentType
|
private java.lang.String |
decorator
|
private DecoratorMapper |
decoratorMapper
|
private java.lang.String |
encoding
|
private Factory |
factory
|
private java.lang.String |
page
|
private java.util.Map |
params
|
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
id, pageContext |
Fields inherited from interface com.opensymphony.module.sitemesh.RequestConstants |
---|
DECORATOR, PAGE, ROBOT |
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag |
---|
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
ApplyDecoratorTag()
|
Method Summary | |
---|---|
(package private) void |
addParam(java.lang.String name,
java.lang.String value)
Add a parameter to the page. |
int |
doAfterBody()
Ensure that external page contents are included in bodycontent. |
int |
doEndTag()
Standard taglib method: apply decorator to page. |
int |
doStartTag()
|
private PageParserSelector |
getParserSelector()
|
void |
setContentType(java.lang.String contentType)
|
void |
setDecorator(java.lang.String decorator)
Deprecated. Use setName() instead. |
void |
setEncoding(java.lang.String encoding)
|
void |
setId(java.lang.String id)
Tag attribute: If set, this value will override the 'id' property of the page. |
void |
setName(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. |
void |
setTitle(java.lang.String title)
Tag attribute: If set, this value will override the 'title' property of the page. |
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
---|
getParent, setPageContext, setParent |
Field Detail |
---|
private java.lang.String page
private java.lang.String decorator
private java.lang.String contentType
private java.lang.String encoding
private java.util.Map params
private Config config
private DecoratorMapper decoratorMapper
private Factory factory
Constructor Detail |
---|
public ApplyDecoratorTag()
Method Detail |
---|
public void setPage(java.lang.String page)
void addParam(java.lang.String name, java.lang.String value)
public void setTitle(java.lang.String title)
public void setId(java.lang.String id)
setId
in class javax.servlet.jsp.tagext.TagSupport
public void setName(java.lang.String decorator)
DecoratorMapper
public void setDecorator(java.lang.String decorator)
public void setContentType(java.lang.String contentType)
public void setEncoding(java.lang.String encoding)
public int doStartTag()
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.BodyTagSupport
public int doAfterBody() throws javax.servlet.jsp.JspException
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
public int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
private PageParserSelector getParserSelector()
|
www.opensymphony.com/sitemesh/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |