Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.faces.webapp
Class UIComponentBodyTag  view UIComponentBodyTag download UIComponentBodyTag.java

java.lang.Object
  extended byjavax.faces.webapp.UIComponentTag
      extended byjavax.faces.webapp.UIComponentBodyTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public abstract class UIComponentBodyTag
extends UIComponentTag
implements javax.servlet.jsp.tagext.BodyTag

Version:
$Revision: 265611 $ $Date: 2005-08-31 21:05:16 -0400 (Wed, 31 Aug 2005) $

Field Summary
protected  javax.servlet.jsp.tagext.BodyContent bodyContent
           
 
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()
          Process body (re)evaluation.
 void doInitBody()
          Prepare for evaluation of the body.
 javax.servlet.jsp.tagext.BodyContent getBodyContent()
           
protected  int getDoAfterBodyValue()
           
protected  int getDoStartValue()
           
 javax.servlet.jsp.JspWriter getPreviousOut()
           
 void release()
          Called on a Tag handler to release state.
 void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
          Set the bodyContent property.
 
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

bodyContent

protected javax.servlet.jsp.tagext.BodyContent bodyContent
Constructor Detail

UIComponentBodyTag

public UIComponentBodyTag()
Method Detail

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
Description copied from interface: javax.servlet.jsp.tagext.IterationTag
Process body (re)evaluation. This method is invoked by the JSP Page implementation object after every evaluation of the body into the BodyEvaluation object. The method is not invoked if there is no body evaluation.

If doAfterBody returns EVAL_BODY_AGAIN, a new evaluation of the body will happen (followed by another invocation of doAfterBody). If doAfterBody returns SKIP_BODY, no more body evaluations will occur, and the doEndTag method will be invoked.

If this tag handler implements BodyTag and doAfterBody returns SKIP_BODY, the value of out will be restored using the popBody method in pageContext prior to invoking doEndTag.

The method re-invocations may be lead to different actions because there might have been some changes to shared state, or because of external computation.

The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated TagExtraInfo or TLD) after the invocation of doAfterBody().

Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

doInitBody

public void doInitBody()
                throws javax.servlet.jsp.JspException
Description copied from interface: javax.servlet.jsp.tagext.BodyTag
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.

The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated TagExtraInfo or TLD) after the invocation of doInitBody().

Specified by:
doInitBody in interface javax.servlet.jsp.tagext.BodyTag

release

public void release()
Description copied from interface: javax.servlet.jsp.tagext.Tag
Called on a Tag handler to release state. The page compiler guarantees that JSP page implementation objects will invoke this method on all tag handlers, but there may be multiple invocations on doStartTag and doEndTag in between.

Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class UIComponentTag

getBodyContent

public javax.servlet.jsp.tagext.BodyContent getBodyContent()

setBodyContent

public void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
Description copied from interface: javax.servlet.jsp.tagext.BodyTag
Set the bodyContent property. This method is invoked by the JSP page implementation object at most once per action invocation. This method will be invoked before doInitBody. This method will not be invoked for empty tags or for non-empty tags whose doStartTag() method returns SKIP_BODY or EVAL_BODY_INCLUDE.

When setBodyContent is invoked, the value of the implicit object out has already been changed in the pageContext object. The BodyContent object passed will have not data on it but may have been reused (and cleared) from some previous invocation.

The BodyContent object is available and with the appropriate content until after the invocation of the doEndTag method, at which case it may be reused.

Specified by:
setBodyContent in interface javax.servlet.jsp.tagext.BodyTag

getPreviousOut

public javax.servlet.jsp.JspWriter getPreviousOut()

getDoStartValue

protected int getDoStartValue()
                       throws javax.servlet.jsp.JspException
Overrides:
getDoStartValue in class UIComponentTag

getDoAfterBodyValue

protected int getDoAfterBodyValue()
                           throws javax.servlet.jsp.JspException