uiviewroot.html

j2ee帮助文档软件设计/软件工程 文件格式

                    or <code>null</code> to disassociate this view with any
                    specific <A HREF="../../../javax/faces/render/RenderKit.html" title="class in javax.faces.render"><CODE>RenderKit</CODE></A> instance</DL>
</DD>
</DL>
<HR>

<A NAME="getViewId()"><!-- --></A><H3>
getViewId</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getViewId</B>()</PRE>
<DL>
<DD><p>Return the view identifier for this view.</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setViewId(java.lang.String)"><!-- --></A><H3>
setViewId</H3>
<PRE>
public void <B>setViewId</B>(<A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;viewId)</PRE>
<DL>
<DD><p>Set the view identifier for this view.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>viewId</CODE> - The new view identifier</DL>
</DD>
</DL>
<HR>

<A NAME="getBeforePhaseListener()"><!-- --></A><H3>
getBeforePhaseListener</H3>
<PRE>
public <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el">MethodExpression</A> <B>getBeforePhaseListener</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>the <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el"><CODE>MethodExpression</CODE></A> that will be invoked before
         this view is rendered.</DL>
</DD>
</DL>
<HR>

<A NAME="setBeforePhaseListener(javax.el.MethodExpression)"><!-- --></A><H3>
setBeforePhaseListener</H3>
<PRE>
public void <B>setBeforePhaseListener</B>(<A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el">MethodExpression</A>&nbsp;newBeforePhase)</PRE>
<DL>
<DD><p>Allow an arbitrary method to be called for the "beforePhase"
 event as the UIViewRoot runs through its lifecycle.  This method
 will be called for all phases except <A HREF="../../../javax/faces/event/PhaseId.html#RESTORE_VIEW"><CODE>PhaseId.RESTORE_VIEW</CODE></A>.  Unlike a true <A HREF="../../../javax/faces/event/PhaseListener.html" title="interface in javax.faces.event"><CODE>PhaseListener</CODE></A>,
 this approach doesn't allow for only receiving <A HREF="../../../javax/faces/event/PhaseEvent.html" title="class in javax.faces.event"><CODE>PhaseEvent</CODE></A>s for a given phase.</p>
 <p/>
 <p>The method must conform to the signature of <A HREF="../../../javax/faces/event/PhaseListener.html#beforePhase(javax.faces.event.PhaseEvent)"><CODE>PhaseListener.beforePhase(javax.faces.event.PhaseEvent)</CODE></A>.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newBeforePhase</CODE> - the <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el"><CODE>MethodExpression</CODE></A> that will be
                       invoked before this view is rendered.</DL>
</DD>
</DL>
<HR>

<A NAME="getAfterPhaseListener()"><!-- --></A><H3>
getAfterPhaseListener</H3>
<PRE>
public <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el">MethodExpression</A> <B>getAfterPhaseListener</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>the <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el"><CODE>MethodExpression</CODE></A> that will be invoked after
         this view is rendered.</DL>
</DD>
</DL>
<HR>

<A NAME="setAfterPhaseListener(javax.el.MethodExpression)"><!-- --></A><H3>
setAfterPhaseListener</H3>
<PRE>
public void <B>setAfterPhaseListener</B>(<A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el">MethodExpression</A>&nbsp;newAfterPhase)</PRE>
<DL>
<DD><p>Allow an arbitrary method to be called for the "afterPhase"
 event as the UIViewRoot runs through its lifecycle.  This method
 will be called for all phases except <A HREF="../../../javax/faces/event/PhaseId.html#RESTORE_VIEW"><CODE>PhaseId.RESTORE_VIEW</CODE></A>.  Unlike a true <A HREF="../../../javax/faces/event/PhaseListener.html" title="interface in javax.faces.event"><CODE>PhaseListener</CODE></A>,
 this approach doesn't allow for only receiving <A HREF="../../../javax/faces/event/PhaseEvent.html" title="class in javax.faces.event"><CODE>PhaseEvent</CODE></A>s for a given phase.</p>
 <p/>
 <p>The method must conform to the signature of <A HREF="../../../javax/faces/event/PhaseListener.html#afterPhase(javax.faces.event.PhaseEvent)"><CODE>PhaseListener.afterPhase(javax.faces.event.PhaseEvent)</CODE></A>.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newAfterPhase</CODE> - the <A HREF="../../../javax/el/MethodExpression.html" title="class in javax.el"><CODE>MethodExpression</CODE></A> that will be
                      invoked after this view is rendered.</DL>
</DD>
</DL>
<HR>

<A NAME="removePhaseListener(javax.faces.event.PhaseListener)"><!-- --></A><H3>
removePhaseListener</H3>
<PRE>
public void <B>removePhaseListener</B>(<A HREF="../../../javax/faces/event/PhaseListener.html" title="interface in javax.faces.event">PhaseListener</A>&nbsp;toRemove)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addPhaseListener(javax.faces.event.PhaseListener)"><!-- --></A><H3>
addPhaseListener</H3>
<PRE>
public void <B>addPhaseListener</B>(<A HREF="../../../javax/faces/event/PhaseListener.html" title="interface in javax.faces.event">PhaseListener</A>&nbsp;newPhaseListener)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="queueEvent(javax.faces.event.FacesEvent)"><!-- --></A><H3>
queueEvent</H3>
<PRE>
public void <B>queueEvent</B>(<A HREF="../../../javax/faces/event/FacesEvent.html" title="class in javax.faces.event">FacesEvent</A>&nbsp;event)</PRE>
<DL>
<DD><p>Override the default <A HREF="../../../javax/faces/component/UIComponentBase.html#queueEvent(javax.faces.event.FacesEvent)"><CODE>UIComponentBase.queueEvent(javax.faces.event.FacesEvent)</CODE></A> behavior to
 accumulate the queued events for later broadcasting.</p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/faces/component/UIComponentBase.html#queueEvent(javax.faces.event.FacesEvent)">queueEvent</A></CODE> in class <CODE><A HREF="../../../javax/faces/component/UIComponentBase.html" title="class in javax.faces.component">UIComponentBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - <A HREF="../../../javax/faces/event/FacesEvent.html" title="class in javax.faces.event"><CODE>FacesEvent</CODE></A> to be queued
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this component is not a
                               descendant of a <A HREF="../../../javax/faces/component/UIViewRoot.html" title="class in javax.faces.component"><CODE>UIViewRoot</CODE></A>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>event</code>
                               is <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="processDecodes(javax.faces.context.FacesContext)"><!-- --></A><H3>
processDecodes</H3>
<PRE>
public void <B>processDecodes</B>(<A HREF="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context">FacesContext</A>&nbsp;context)</PRE>
<DL>
<DD><p>Override the default <A HREF="../../../javax/faces/component/UIComponentBase.html#processDecodes(javax.faces.context.FacesContext)"><CODE>UIComponentBase.processDecodes(javax.faces.context.FacesContext)</CODE></A>
 behavior to broadcast any queued events after the default
 processing has been completed and to clear out any events
 for later phases if the event processing for this phase caused <A HREF="../../../javax/faces/context/FacesContext.html#renderResponse()"><CODE>FacesContext.renderResponse()</CODE></A> or <A HREF="../../../javax/faces/context/FacesContext.html#responseComplete()"><CODE>FacesContext.responseComplete()</CODE></A>
 to be called.</p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/faces/component/UIComponentBase.html#processDecodes(javax.faces.context.FacesContext)">processDecodes</A></CODE> in class <CODE><A HREF="../../../javax/faces/component/UIComponentBase.html" title="class in javax.faces.component">UIComponentBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - <A HREF="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context"><CODE>FacesContext</CODE></A> for the request we are processing
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>context</code>
                              is <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="encodeBegin(javax.faces.context.FacesContext)"><!-- --></A><H3>
encodeBegin</H3>
<PRE>
public void <B>encodeBegin</B>(<A HREF="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context">FacesContext</A>&nbsp;context)
                 throws <A HREF="http://java.sun.com/j2se/1.5/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD><p>Override the default <A HREF="../../../javax/faces/component/UIComponentBase.html#encodeBegin(javax.faces.context.FacesContext)"><CODE>UIComponentBase.encodeBegin(javax.faces.context.FacesContext)</CODE></A>
 behavior.  If
 <A HREF="../../../javax/faces/component/UIViewRoot.html#getBeforePhaseListener()"><CODE>getBeforePhaseListener()</CODE></A> returns non-<code>null</code>,
 invoke it, passing a <A HREF="../../../javax/faces/event/PhaseEvent.html" title="class in javax.faces.event"><CODE>PhaseEvent</CODE></A> for the <A HREF="../../../javax/faces/event/PhaseId.html#RENDER_RESPONSE"><CODE>PhaseId.RENDER_RESPONSE</CODE></A> phase.  If the internal list populated
 by calls to <A HREF="../../../javax/faces/component/UIViewRoot.html#addPhaseListener(javax.faces.event.PhaseListener)"><CODE>addPhaseListener(javax.faces.event.PhaseListener)</CODE></A> is non-empty, any listeners
 in that list must have their <A HREF="../../../javax/faces/event/PhaseListener.html#beforePhase(javax.faces.event.PhaseEvent)"><CODE>PhaseListener.beforePhase(javax.faces.event.PhaseEvent)</CODE></A>
 method called, passing the <code>PhaseEvent</code>.  Any errors
 that occur during invocation of any of the the beforePhase
 listeners must be logged and swallowed.  After listeners are invoked
 call superclass processing.</p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/faces/component/UIComponentBase.html#encodeBegin(javax.faces.context.FacesContext)">encodeBegin</A></CODE> in class <CODE><A HREF="../../../javax/faces/component/UIComponentBase.html" title="class in javax.faces.component">UIComponentBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - <A HREF="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context"><CODE>FacesContext</CODE></A> for the response we are creating
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an input/output error occurs while rendering</DL>
</DD>
</DL>
<HR>

<A NAME="encodeEnd(javax.faces.context.FacesContext)"><!-- --></A><H3>
encodeEnd</H3>
<PRE>
public void <B>encodeEnd</B>(<A HREF="../../../javax/faces/context/FacesContext.html" title="class in javax.faces.context">FacesContext</A>&nbsp;context)
               throws <A HREF="http://java.sun.com/j2se/1.5/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD><p>Override the default <A HREF="../../../javax/faces/component/UIComponentBase.html#encodeEnd(javax.faces.context.FacesContext)"><CODE>UIComponentBase.encodeEnd(javax.faces.context.FacesContext)</CODE></A>
 behavior.  If <A HREF="../../../javax/faces/component/UIViewRoot.html#getAfterPhaseListener()"><CODE>getAfterPhaseListener()</CODE></A> returns
 non-<code>null</code>, invoke it, passing a <A HREF="../../../javax/faces/event/PhaseEvent.html" title="class in javax.faces.event"><CODE>PhaseEvent</CODE></A>
 for the <A HREF="../../../javax/faces/event/PhaseId.html#RENDER_RESPONSE"><CODE>PhaseId.RENDER_RESPONSE</CODE></A> phase.  Any errors that