|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.faces.webapp.UIComponentTag | +--javax.faces.webapp.UIComponentBodyTag
UIComponentBodyTag is a base class for all JSP custom actions, related to a UIComponent, that need to process their tag bodies.
Field Summary | |
protected javax.servlet.jsp.tagext.BodyContent |
bodyContent
The bodyContent for this tag handler. |
Fields inherited from class javax.faces.webapp.UIComponentTag |
pageContext |
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 | |
UIComponentBodyTag()
|
Method Summary | |
int |
doAfterBody()
Handle the ending of the nested body content for this tag. |
void |
doInitBody()
Prepare for evaluation of the body. |
javax.servlet.jsp.tagext.BodyContent |
getBodyContent()
Return the BodyContent for this tag handler. |
protected int |
getDoAfterBodyValue()
Return the flag value that should be returned from the doAfterBody() method when it is called. |
protected int |
getDoStartValue()
Return the flag value that should be returned from the doStart() method when it is called. |
javax.servlet.jsp.JspWriter |
getPreviousOut()
Get the JspWriter from our BodyContent . |
void |
release()
Release any resources allocated during the execution of this tag handler. |
void |
setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
Set the bodyContent for this tag handler. |
Methods inherited from class javax.faces.webapp.UIComponentTag |
doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getComponentType, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, getRendererType, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setProperties, setRendered, setupResponseWriter |
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 |
doEndTag, doStartTag, getParent, setPageContext, setParent |
Field Detail |
protected javax.servlet.jsp.tagext.BodyContent bodyContent
The bodyContent
for this tag handler.
Constructor Detail |
public UIComponentBodyTag()
Method Detail |
public int doAfterBody() throws javax.servlet.jsp.JspException
Handle the ending of the nested body content for this tag. The
default implementation simply calls getDoAfterBodyValue()
to retrieve the flag value to be returned.
It should be noted that if this method returns
IterationTag.EVAL_BODY_AGAIN
, any nested
UIComponentTag
must have an explicit ID set.
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
javax.servlet.jsp.JspException
- if an error is encounteredpublic void doInitBody() throws javax.servlet.jsp.JspException
Prepare for evaluation of the body. This method is invoked by the
JSP page implementation object after setBodyContent()
and before the first time the body is to be evaluated. This method
will not be invoked for empty tags or for non-empty tags whose
doStartTag()
method returns SKIP_BODY
or EVAL_BODY_INCLUDE
.
doInitBody
in interface javax.servlet.jsp.tagext.BodyTag
javax.servlet.jsp.JspException
- if an error is encounteredpublic void release()
UIComponentTag
Release any resources allocated during the execution of this tag handler.
release
in interface javax.servlet.jsp.tagext.Tag
release
in class UIComponentTag
public void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
Set the bodyContent
for this tag handler. This method
is invoked by the JSP page implementation object at most once per
action invocation, before doInitiBody()
. This method
will not be invoked for empty tags or for non-empty tags whose
doStartTag()
method returns SKIP_BODY
or
EVAL_BODY_INCLUDE
.
setBodyContent
in interface javax.servlet.jsp.tagext.BodyTag
bodyContent
- The new BodyContent
for this tagpublic javax.servlet.jsp.tagext.BodyContent getBodyContent()
Return the BodyContent
for this tag handler.
public javax.servlet.jsp.JspWriter getPreviousOut()
Get the JspWriter
from our BodyContent
.
protected int getDoAfterBodyValue() throws javax.servlet.jsp.JspException
Return the flag value that should be returned from the
doAfterBody()
method when it is called. Subclasses
may override this method to return the appropriate value.
javax.servlet.jsp.JspException
protected int getDoStartValue() throws javax.servlet.jsp.JspException
UIComponentTag
Return the flag value that should be returned from the
doStart()
method when it is called. Subclasses
may override this method to return the appropriate value.
getDoStartValue
in class UIComponentTag
javax.servlet.jsp.JspException
- to cause doStart()
to
throw an exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |