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

Quick Search    Search Deep

org.apache.myfaces.taglib.core
Class ViewTag  view ViewTag download ViewTag.java

java.lang.Object
  extended byjavax.faces.webapp.UIComponentTag
      extended byjavax.faces.webapp.UIComponentBodyTag
          extended byorg.apache.myfaces.taglib.core.ViewTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ViewTag
extends javax.faces.webapp.UIComponentBodyTag

Version:
$Revision: 169655 $ $Date: 2005-05-11 12:45:06 -0400 (Wed, 11 May 2005) $

Field Summary
private  java.lang.String _locale
           
private static org.apache.commons.logging.Log log
           
 
Fields inherited from class javax.faces.webapp.UIComponentBodyTag
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
ViewTag()
           
 
Method Summary
 int doAfterBody()
          Process body (re)evaluation.
 int doEndTag()
          Process the end tag for this instance.
 int doStartTag()
          Process the start tag for this instance.
 java.lang.String getComponentType()
           
 java.lang.String getRendererType()
           
protected  boolean isSuppressed()
           
 void setLocale(java.lang.String locale)
           
protected  void setProperties(javax.faces.component.UIComponent component)
           
 
Methods inherited from class javax.faces.webapp.UIComponentBodyTag
doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.faces.webapp.UIComponentTag
encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isValueReference, setBinding, setId, setPageContext, setParent, 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
getParent, setPageContext, setParent
 

Field Detail

log

private static final org.apache.commons.logging.Log log

_locale

private java.lang.String _locale
Constructor Detail

ViewTag

public ViewTag()
Method Detail

getComponentType

public java.lang.String getComponentType()

getRendererType

public java.lang.String getRendererType()

setLocale

public void setLocale(java.lang.String locale)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Description copied from interface: javax.servlet.jsp.tagext.Tag
Process the start tag for this instance. This method is invoked by the JSP page implementation object.

The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any properties exposed as attributes have been set too. When this method is invoked, the body has not yet been evaluated.

This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action should be evaluated or SKIP_BODY to indicate otherwise.

When a Tag returns EVAL_BODY_INCLUDE the result of evaluating the body (if any) is included into the current "out" JspWriter as it happens and then doEndTag() is invoked.

BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler implements BodyTag.

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 doStartTag(), except for a tag handler implementing BodyTag whose doStartTag() method returns BodyTag.EVAL_BODY_BUFFERED.


isSuppressed

protected boolean isSuppressed()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Description copied from interface: javax.servlet.jsp.tagext.Tag
Process the end tag for this instance. This method is invoked by the JSP page implementation object on all Tag handlers.

This method will be called after returning from doStartTag. The body of the action may or may not have been evaluated, depending on the return value of doStartTag.

If this method returns EVAL_PAGE, the rest of the page continues to be evaluated. If this method returns SKIP_PAGE, the rest of the page is not evaluated, the request is completed, and the doEndTag() methods of enclosing tags are not invoked. If this request was forwarded or included from another page (or Servlet), only the current page evaluation is stopped.

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


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().


setProperties

protected void setProperties(javax.faces.component.UIComponent component)