jakartaee-10.0/javadoc/jakarta/faces/component/UIForm.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>UIForm</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>

 <link rel="shortcut icon" href="/img/jakarta-favicon.ico">
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="UIForm";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../jakarta/faces/component/UIData.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../jakarta/faces/component/UIGraphic.html" title="class in jakarta.faces.component"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?jakarta/faces/component/UIForm.html" target="_top">Frames</a></li>
 <li><a href="UIForm.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">jakarta.faces.component</div>
 <h2 title="Class UIForm" class="title">Class UIForm</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">jakarta.faces.component.UIComponent</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">jakarta.faces.component.UIComponentBase</a></li>
 <li>
 <ul class="inheritance">
 <li>jakarta.faces.component.UIForm</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component">NamingContainer</a>, <a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component">PartialStateHolder</a>, <a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component">StateHolder</a>, <a href="../../../jakarta/faces/component/TransientStateHolder.html" title="interface in jakarta.faces.component">TransientStateHolder</a>, <a href="../../../jakarta/faces/component/UniqueIdVendor.html" title="interface in jakarta.faces.component">UniqueIdVendor</a>, <a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>, <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>, <a href="../../../jakarta/faces/event/SystemEventListenerHolder.html" title="interface in jakarta.faces.event">SystemEventListenerHolder</a>, java.util.EventListener</dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../jakarta/faces/component/html/HtmlForm.html" title="class in jakarta.faces.component.html">HtmlForm</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">UIForm</span>
 extends <a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a>
 implements <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component">NamingContainer</a>, <a href="../../../jakarta/faces/component/UniqueIdVendor.html" title="interface in jakarta.faces.component">UniqueIdVendor</a></pre>
 <div class="block"><p>
  <strong class="changed_modified_2_1">UIForm</strong> is a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> that represents an input form to be
  presented to the user, and whose child components represent (among other things) the input fields to be included when
  the form is submitted.
  </p>

  <p>
  By default, the <code>rendererType</code> property must be set to "<code>jakarta.faces.Form</code>". This value can
  be changed by calling the <code>setRendererType()</code> method.
  </p></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#COMPONENT_FAMILY">COMPONENT_FAMILY</a></span></code>
 <div class="block">
  The standard component family for this component.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#COMPONENT_TYPE">COMPONENT_TYPE</a></span></code>
 <div class="block">
  The standard component type for this component.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="fields.inherited.from.class.jakarta.faces.component.UIComponent">
 <!--   -->
 </a>
 <h3>Fields inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></h3>
 <code><a href="../../../jakarta/faces/component/UIComponent.html#ATTRS_WITH_DECLARED_DEFAULT_VALUES">ATTRS_WITH_DECLARED_DEFAULT_VALUES</a>, <a href="../../../jakarta/faces/component/UIComponent.html#BEANINFO_KEY">BEANINFO_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#bindings">bindings</a>, <a href="../../../jakarta/faces/component/UIComponent.html#COMPOSITE_COMPONENT_TYPE_KEY">COMPOSITE_COMPONENT_TYPE_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#COMPOSITE_FACET_NAME">COMPOSITE_FACET_NAME</a>, <a href="../../../jakarta/faces/component/UIComponent.html#FACETS_KEY">FACETS_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#VIEW_LOCATION_KEY">VIEW_LOCATION_KEY</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="fields.inherited.from.class.jakarta.faces.component.NamingContainer">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component">NamingContainer</a></h3>
 <code><a href="../../../jakarta/faces/component/NamingContainer.html#SEPARATOR_CHAR">SEPARATOR_CHAR</a></code></li>
 </ul>
 </li>
 </ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#UIForm--">UIForm</a></span>()</code>
 <div class="block">
  Create a new <a href="../../../jakarta/faces/component/UIForm.html" title="class in jakarta.faces.component"><code>UIForm</code></a> instance with default property values.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#createUniqueId-jakarta.faces.context.FacesContext-java.lang.String-">createUniqueId</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
               java.lang.String&nbsp;seed)</code>
 <div class="block"><p class="changed_modified_2_2">
  Generate an identifier for a component.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#getContainerClientId-jakarta.faces.context.FacesContext-">getContainerClientId</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
 <div class="block">
  Override the <a href="../../../jakarta/faces/component/UIComponent.html#getContainerClientId-jakarta.faces.context.FacesContext-"><code>UIComponent.getContainerClientId(jakarta.faces.context.FacesContext)</code></a> to allow users to disable this form from prepending its
  <code>clientId</code> to its descendent's <code>clientIds</code> depending on the value of this form's
  <a href="../../../jakarta/faces/component/UIForm.html#isPrependId--"><code>isPrependId()</code></a> property.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#getFamily--">getFamily</a></span>()</code>
 <div class="block"><p class="changed_modified_2_3">
  Return the identifier of the component family to which this component belongs.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">invokeOnComponent</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
                  java.lang.String&nbsp;clientId,
                  <a href="../../../jakarta/faces/component/ContextCallback.html" title="interface in jakarta.faces.component">ContextCallback</a>&nbsp;callback)</code>
 <div class="block">
  <span class="changed_modified_2_1">Starting</span> at this component in the View hierarchy, search for a component
  with a <code>clientId</code> equal to the argument <code>clientId</code> and, if found, call the
  <a href="../../../jakarta/faces/component/ContextCallback.html#invokeContextCallback-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a> method on the argument <code>callback</code>, passing the current
  <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> and the found component as arguments.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#isPrependId--">isPrependId</a></span>()</code>
 <div class="block">Is the id prepended.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#isSubmitted--">isSubmitted</a></span>()</code>
 <div class="block">
  <span class="changed_modified_2_1">Returns</span> the current value of the <code>submitted</code> property.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#processDecodes-jakarta.faces.context.FacesContext-">processDecodes</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
 <div class="block">
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processDecodes-jakarta.faces.context.FacesContext-"><code>UIComponent.processDecodes(jakarta.faces.context.FacesContext)</code></a> to ensure that the form is decoded <strong>before</strong> its children.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#processUpdates-jakarta.faces.context.FacesContext-">processUpdates</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
 <div class="block">
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processUpdates-jakarta.faces.context.FacesContext-"><code>UIComponent.processUpdates(jakarta.faces.context.FacesContext)</code></a> to ensure that the children of this <code>UIForm</code> instance are only
  processed if <a href="../../../jakarta/faces/component/UIForm.html#isSubmitted--"><code>isSubmitted()</code></a> returns <code>true</code>.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#processValidators-jakarta.faces.context.FacesContext-">processValidators</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
 <div class="block"><p class="changed_modified_2_3">
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processValidators-jakarta.faces.context.FacesContext-"><code>UIComponent.processValidators(jakarta.faces.context.FacesContext)</code></a> to ensure that the children of this <code>UIForm</code> instance are
  only processed if <a href="../../../jakarta/faces/component/UIForm.html#isSubmitted--"><code>isSubmitted()</code></a> returns <code>true</code>.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#setPrependId-boolean-">setPrependId</a></span>(boolean&nbsp;prependId)</code>
 <div class="block">Set whether the id should be prepended.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#setSubmitted-boolean-">setSubmitted</a></span>(boolean&nbsp;submitted)</code>
 <div class="block">
  <span class="changed_modified_2_1">If</span> <strong>this</strong> <code>UIForm</code> instance (as opposed to other
  forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called,
  with <code>true</code> as the argument, during the <a href="../../../jakarta/faces/component/UIComponent.html#decode-jakarta.faces.context.FacesContext-"><code>UIComponent.decode(jakarta.faces.context.FacesContext)</code></a> for this <code>UIForm</code> instance.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIForm.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">visitTree</a></span>(<a href="../../../jakarta/faces/component/visit/VisitContext.html" title="class in jakarta.faces.component.visit">VisitContext</a>&nbsp;context,
          <a href="../../../jakarta/faces/component/visit/VisitCallback.html" title="interface in jakarta.faces.component.visit">VisitCallback</a>&nbsp;callback)</code>
 <div class="block"><p class="changed_added_2_0">
  Perform a tree visit starting at this node in the tree.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.component.UIComponentBase">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></h3>
 <code><a href="../../../jakarta/faces/component/UIComponentBase.html#addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-">addClientBehavior</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#addFacesListener-jakarta.faces.event.FacesListener-">addFacesListener</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#broadcast-jakarta.faces.event.FacesEvent-">broadcast</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#clearInitialState--">clearInitialState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#decode-jakarta.faces.context.FacesContext-">decode</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeBegin-jakarta.faces.context.FacesContext-">encodeBegin</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeChildren-jakarta.faces.context.FacesContext-">encodeChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeEnd-jakarta.faces.context.FacesContext-">encodeEnd</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#findComponent-java.lang.String-">findComponent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getAttributes--">getAttributes</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getChildCount--">getChildCount</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getChildren--">getChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getClientBehaviors--">getClientBehaviors</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getClientId-jakarta.faces.context.FacesContext-">getClientId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getDefaultEventName--">getDefaultEventName</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getEventNames--">getEventNames</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesContext--">getFacesContext</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesListeners-java.lang.Class-">getFacesListeners</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacet-java.lang.String-">getFacet</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetCount--">getFacetCount</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacets--">getFacets</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetsAndChildren--">getFacetsAndChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getId--">getId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getListenersForEventClass-java.lang.Class-">getListenersForEventClass</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getParent--">getParent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getPassThroughAttributes-boolean-">getPassThroughAttributes</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRenderer-jakarta.faces.context.FacesContext-">getRenderer</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRendererType--">getRendererType</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#getRendersChildren--">getRendersChildren</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#isRendered--">isRendered</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#isTransient--">isTransient</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#markInitialState--">markInitialState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">processRestoreState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#processSaveState-jakarta.faces.context.FacesContext-">processSaveState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#queueEvent-jakarta.faces.event.FacesEvent-">queueEvent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#removeFacesListener-jakarta.faces.event.FacesListener-">removeFacesListener</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#restoreAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreAttachedState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#restoreState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">saveAttachedState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#saveState-jakarta.faces.context.FacesContext-">saveState</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setId-java.lang.String-">setId</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setParent-jakarta.faces.component.UIComponent-">setParent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setRendered-boolean-">setRendered</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setRendererType-java.lang.String-">setRendererType</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#setTransient-boolean-">setTransient</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#subscribeToEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">subscribeToEvent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html#unsubscribeFromEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">unsubscribeFromEvent</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.component.UIComponent">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;jakarta.faces.component.<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></h3>
 <code><a href="../../../jakarta/faces/component/UIComponent.html#encodeAll-jakarta.faces.context.FacesContext-">encodeAll</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getClientId--">getClientId</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCompositeComponentParent-jakarta.faces.component.UIComponent-">getCompositeComponentParent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCurrentComponent-jakarta.faces.context.FacesContext-">getCurrentComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getCurrentCompositeComponent-jakarta.faces.context.FacesContext-">getCurrentCompositeComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getNamingContainer--">getNamingContainer</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes--">getPassThroughAttributes</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getResourceBundleMap--">getResourceBundleMap</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getStateHelper--">getStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getStateHelper-boolean-">getStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper--">getTransientStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper-boolean-">getTransientStateHelper</a>, <a href="../../../jakarta/faces/component/UIComponent.html#getValueExpression-java.lang.String-">getValueExpression</a>, <a href="../../../jakarta/faces/component/UIComponent.html#initialStateMarked--">initialStateMarked</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isCompositeComponent-jakarta.faces.component.UIComponent-">isCompositeComponent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isInView--">isInView</a>, <a href="../../../jakarta/faces/component/UIComponent.html#isVisitable-jakarta.faces.component.visit.VisitContext-">isVisitable</a>, <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-">popComponentFromEL</a>, <a href="../../../jakarta/faces/component/UIComponent.html#processEvent-jakarta.faces.event.ComponentSystemEvent-">processEvent</a>, <a href="../../../jakarta/faces/component/UIComponent.html#pushComponentToEL-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">pushComponentToEL</a>, <a href="../../../jakarta/faces/component/UIComponent.html#restoreTransientState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreTransientState</a>, <a href="../../../jakarta/faces/component/UIComponent.html#saveTransientState-jakarta.faces.context.FacesContext-">saveTransientState</a>, <a href="../../../jakarta/faces/component/UIComponent.html#setInView-boolean-">setInView</a>, <a href="../../../jakarta/faces/component/UIComponent.html#setValueExpression-java.lang.String-jakarta.el.ValueExpression-">setValueExpression</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="COMPONENT_TYPE">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>COMPONENT_TYPE</h4>
 <pre>public static final&nbsp;java.lang.String COMPONENT_TYPE</pre>
 <div class="block"><p>
  The standard component type for this component.
  </p></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../constant-values.html#jakarta.faces.component.UIForm.COMPONENT_TYPE">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="COMPONENT_FAMILY">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>COMPONENT_FAMILY</h4>
 <pre>public static final&nbsp;java.lang.String COMPONENT_FAMILY</pre>
 <div class="block"><p>
  The standard component family for this component.
  </p></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../constant-values.html#jakarta.faces.component.UIForm.COMPONENT_FAMILY">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="UIForm--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>UIForm</h4>
 <pre>public&nbsp;UIForm()</pre>
 <div class="block"><p>
  Create a new <a href="../../../jakarta/faces/component/UIForm.html" title="class in jakarta.faces.component"><code>UIForm</code></a> instance with default property values.
  </p></div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getFamily--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFamily</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getFamily()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFamily--">UIComponent</a></code></span></div>
 <div class="block"><p class="changed_modified_2_3">
  Return the identifier of the component family to which this component belongs. This identifier, in conjunction with
  the value of the <code>rendererType</code> property, may be used to select the appropriate <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> for this
  component instance. Note this method should NOT return <code>null</code>
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFamily--">getFamily</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the component family (not null).</dd>
 </dl>
 </li>
 </ul>
 <a name="isSubmitted--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isSubmitted</h4>
 <pre>public&nbsp;boolean&nbsp;isSubmitted()</pre>
 <div class="block"><p>
  <span class="changed_modified_2_1">Returns</span> the current value of the <code>submitted</code> property. The
  default value is <code>false</code>. See <a href="../../../jakarta/faces/component/UIForm.html#setSubmitted-boolean-"><code>setSubmitted(boolean)</code></a> for details.
  </p>

  <p class="changed_modified_2_1">
  This property must be kept as a transient property using the <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper--"><code>UIComponent.getTransientStateHelper()</code></a>.
  </p></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the form was submitted, <code>false</code> otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="setSubmitted-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSubmitted</h4>
 <pre>public&nbsp;void&nbsp;setSubmitted(boolean&nbsp;submitted)</pre>
 <div class="block"><p>
  <span class="changed_modified_2_1">If</span> <strong>this</strong> <code>UIForm</code> instance (as opposed to other
  forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called,
  with <code>true</code> as the argument, during the <a href="../../../jakarta/faces/component/UIComponent.html#decode-jakarta.faces.context.FacesContext-"><code>UIComponent.decode(jakarta.faces.context.FacesContext)</code></a> for this <code>UIForm</code> instance.
  If <strong>this</strong> <code>UIForm</code> instance is <strong>not</strong> experiencing a submit, this method must
  be called, with <code>false</code> as the argument, during the <a href="../../../jakarta/faces/component/UIComponent.html#decode-jakarta.faces.context.FacesContext-"><code>UIComponent.decode(jakarta.faces.context.FacesContext)</code></a> for this
  <code>UIForm</code> instance.
  </p>

  <p>
  The value of a <code>UIForm</code>'s submitted property must not be saved as part of its state.
  </p>

  <p class="changed_modified_2_1">
  This property must be kept as a transient property using the <a href="../../../jakarta/faces/component/UIComponent.html#getTransientStateHelper--"><code>UIComponent.getTransientStateHelper()</code></a>.
  </p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>submitted</code> - the new value of the submitted flag.</dd>
 </dl>
 </li>
 </ul>
 <a name="isPrependId--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isPrependId</h4>
 <pre>public&nbsp;boolean&nbsp;isPrependId()</pre>
 <div class="block">Is the id prepended.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if it is, <code>false</code> otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="setPrependId-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPrependId</h4>
 <pre>public&nbsp;void&nbsp;setPrependId(boolean&nbsp;prependId)</pre>
 <div class="block">Set whether the id should be prepended.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>prependId</code> - <code>true</code> if it is, <code>false</code> otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="processDecodes-jakarta.faces.context.FacesContext-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>processDecodes</h4>
 <pre>public&nbsp;void&nbsp;processDecodes(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
 <div class="block"><p>
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processDecodes-jakarta.faces.context.FacesContext-"><code>UIComponent.processDecodes(jakarta.faces.context.FacesContext)</code></a> to ensure that the form is decoded <strong>before</strong> its children.
  This is necessary to allow the <code>submitted</code> property to be correctly set.
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponentBase.html#processDecodes-jakarta.faces.context.FacesContext-">processDecodes</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
 </dl>
 </li>
 </ul>
 <a name="processValidators-jakarta.faces.context.FacesContext-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>processValidators</h4>
 <pre>public&nbsp;void&nbsp;processValidators(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
 <div class="block"><p class="changed_modified_2_3">
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processValidators-jakarta.faces.context.FacesContext-"><code>UIComponent.processValidators(jakarta.faces.context.FacesContext)</code></a> to ensure that the children of this <code>UIForm</code> instance are
  only processed if <a href="../../../jakarta/faces/component/UIForm.html#isSubmitted--"><code>isSubmitted()</code></a> returns <code>true</code>.
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponentBase.html#processValidators-jakarta.faces.context.FacesContext-">processValidators</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../jakarta/faces/event/PreValidateEvent.html" title="class in jakarta.faces.event"><code>PreValidateEvent</code></a>,
 <a href="../../../jakarta/faces/event/PostValidateEvent.html" title="class in jakarta.faces.event"><code>PostValidateEvent</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="processUpdates-jakarta.faces.context.FacesContext-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>processUpdates</h4>
 <pre>public&nbsp;void&nbsp;processUpdates(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
 <div class="block"><p>
  Override <a href="../../../jakarta/faces/component/UIComponent.html#processUpdates-jakarta.faces.context.FacesContext-"><code>UIComponent.processUpdates(jakarta.faces.context.FacesContext)</code></a> to ensure that the children of this <code>UIForm</code> instance are only
  processed if <a href="../../../jakarta/faces/component/UIForm.html#isSubmitted--"><code>isSubmitted()</code></a> returns <code>true</code>.
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponentBase.html#processUpdates-jakarta.faces.context.FacesContext-">processUpdates</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
 </dl>
 </li>
 </ul>
 <a name="createUniqueId-jakarta.faces.context.FacesContext-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>createUniqueId</h4>
 <pre>public&nbsp;java.lang.String&nbsp;createUniqueId(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
                                        java.lang.String&nbsp;seed)</pre>
 <div class="block"><p class="changed_modified_2_2">
  Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique
  within this component-container. Optionally, a unique seed value can be supplied by component creators which should
  be included in the generated unique id.
  </p>
  <p class="changed_added_2_2">
  If the <code>prependId</code> property has the value <code>false</code>, this method must call
  <code>createUniqueId</code> on the next ancestor <code>UniqueIdVendor</code>.
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UniqueIdVendor.html#createUniqueId-jakarta.faces.context.FacesContext-java.lang.String-">createUniqueId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../jakarta/faces/component/UniqueIdVendor.html" title="interface in jakarta.faces.component">UniqueIdVendor</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - FacesContext</dd>
 <dd><code>seed</code> - an optional seed value - e.g. based on the position of the component in the VDL-template</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a unique-id in this component-container</dd>
 </dl>
 </li>
 </ul>
 <a name="getContainerClientId-jakarta.faces.context.FacesContext-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getContainerClientId</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getContainerClientId(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
 <div class="block"><p>
  Override the <a href="../../../jakarta/faces/component/UIComponent.html#getContainerClientId-jakarta.faces.context.FacesContext-"><code>UIComponent.getContainerClientId(jakarta.faces.context.FacesContext)</code></a> to allow users to disable this form from prepending its
  <code>clientId</code> to its descendent's <code>clientIds</code> depending on the value of this form's
  <a href="../../../jakarta/faces/component/UIForm.html#isPrependId--"><code>isPrependId()</code></a> property.
  </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getContainerClientId-jakarta.faces.context.FacesContext-">getContainerClientId</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - the Faces context.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the container client id.</dd>
 </dl>
 </li>
 </ul>
 <a name="visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>visitTree</h4>
 <pre>public&nbsp;boolean&nbsp;visitTree(<a href="../../../jakarta/faces/component/visit/VisitContext.html" title="class in jakarta.faces.component.visit">VisitContext</a>&nbsp;context,
                          <a href="../../../jakarta/faces/component/visit/VisitCallback.html" title="interface in jakarta.faces.component.visit">VisitCallback</a>&nbsp;callback)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">UIComponent</a></code></span></div>
 <div class="block"><p class="changed_added_2_0">
  Perform a tree visit starting at this node in the tree.
  </p>

  <div class="changed_added_2_0">

  <p>
  UIComponent.visitTree() implementations do not invoke the <a href="../../../jakarta/faces/component/visit/VisitCallback.html" title="interface in jakarta.faces.component.visit"><code>VisitCallback</code></a> directly, but instead call
  <a href="../../../jakarta/faces/component/visit/VisitContext.html#invokeVisitCallback-jakarta.faces.component.UIComponent-jakarta.faces.component.visit.VisitCallback-"><code>VisitContext.invokeVisitCallback(jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitCallback)</code></a> to invoke the callback. This allows <code>VisitContext</code> implementations to
  provide optimized tree traversals, for example by only calling the <code>VisitCallback</code> for a subset of components.
  </p>

  <p>
  UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and
  UIComponent.popComponentFromEL() after the visit.
  </p>
  </div></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponent.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">visitTree</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - the <code>VisitContext</code> for this visit</dd>
 <dd><code>callback</code> - the <code>VisitCallback</code> instance whose <code>visit</code> method will be called for each node
  visited.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>component implementations may return <code>true</code> to indicate that the tree visit is complete (eg. all
  components that need to be visited have been visited). This results in the tree visit being short-circuited such that
  no more components are visited.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../jakarta/faces/component/UIComponent.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-"><code>UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>invokeOnComponent</h4>
 <pre>public&nbsp;boolean&nbsp;invokeOnComponent(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
                                  java.lang.String&nbsp;clientId,
                                  <a href="../../../jakarta/faces/component/ContextCallback.html" title="interface in jakarta.faces.component">ContextCallback</a>&nbsp;callback)
                           throws <a href="../../../jakarta/faces/FacesException.html" title="class in jakarta.faces">FacesException</a></pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponentBase.html#invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">UIComponentBase</a></code></span></div>
 <div class="block"><p>
  <span class="changed_modified_2_1">Starting</span> at this component in the View hierarchy, search for a component
  with a <code>clientId</code> equal to the argument <code>clientId</code> and, if found, call the
  <a href="../../../jakarta/faces/component/ContextCallback.html#invokeContextCallback-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a> method on the argument <code>callback</code>, passing the current
  <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> and the found component as arguments. This method is similar to <a href="../../../jakarta/faces/component/UIComponent.html#findComponent-java.lang.String-"><code>UIComponent.findComponent(java.lang.String)</code></a> but it
  does not support the leading <a href="../../../jakarta/faces/component/UINamingContainer.html#getSeparatorChar-jakarta.faces.context.FacesContext-"><code>UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)</code></a> syntax for searching from the root of the
  View.
  </p>

  <p>
  The default implementation will first check if <code>this.getClientId()</code> is equal to the argument
  <code>clientId</code>. If so, <span class="changed_added_2_1">first call <a href="../../../jakarta/faces/component/UIComponent.html#pushComponentToEL-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>UIComponent.pushComponentToEL(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a>, then</span> call
  the <a href="../../../jakarta/faces/component/ContextCallback.html#invokeContextCallback-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a> method on the argument callback, passing through the
  <code>FacesContext</code> argument and passing this as the component argument. <span class="changed_added_2_1">Then
  call <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a></span>. If an <code>Exception</code> is thrown by the callback, wrap it in a
  <a href="../../../jakarta/faces/FacesException.html" title="class in jakarta.faces"><code>FacesException</code></a> and re-throw it. Otherwise, return <code>true</code>.
  </p>

  <p>
  Otherwise, for each component returned by <a href="../../../jakarta/faces/component/UIComponent.html#getFacetsAndChildren--"><code>UIComponent.getFacetsAndChildren()</code></a>, call <code>invokeOnComponent()</code>
  passing the arguments to this method, in order. The first time <code>invokeOnComponent()</code> returns true, abort
  traversing the rest of the <code>Iterator</code> and return <code>true</code>.
  </p>

  <p>
  When calling <a href="../../../jakarta/faces/component/ContextCallback.html#invokeContextCallback-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a> the implementation of this method must guarantee that the
  state of the component passed to the callback correctly reflects the component's position in the View hierarchy with
  respect to any state found in the argument <code>clientId</code>. For example, an iterating component such as
  <a href="../../../jakarta/faces/component/UIData.html" title="class in jakarta.faces.component"><code>UIData</code></a> will need to set its row index to correctly reflect the argument <code>clientId</code> before finding
  the appropriate child component backed by the correct row. When the callback returns, either normally or by throwing
  an <code>Exception</code> the implementation of this method must restore the state of the view to the way it was
  before invoking the callback.
  </p>

  <p>
  If none of the elements from <a href="../../../jakarta/faces/component/UIComponent.html#getFacetsAndChildren--"><code>UIComponent.getFacetsAndChildren()</code></a> returned <code>true</code> from
  <code>invokeOnComponent()</code>, return <code>false</code>.
  </p>

  <p>
  Simple usage example to find a component by <code>clientId</code>.
  </p>

  <pre>
  <code>
     private UIComponent found = null;

     private void doFind(FacesContext context, String clientId) {
       context.getViewRoot().invokeOnComponent(context, clientId,
           new ContextCallback() {
              public void invokeContextCallback(FacesContext context,
                                            UIComponent component) {
                found = component;
              }
           });
     }
  </code>
  </pre></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../jakarta/faces/component/UIComponentBase.html#invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">invokeOnComponent</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - the <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the current request</dd>
 <dd><code>clientId</code> - the client identifier of the component to be passed to the argument callback.</dd>
 <dd><code>callback</code> - an implementation of the Callback interface.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the a component with the given <code>clientId</code> is found, the callback method was
  successfully invoked passing that component as an argument, and no Exception was thrown. Returns <code>false</code>
  if no component with the given <code>clientId</code> is found.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../jakarta/faces/FacesException.html" title="class in jakarta.faces">FacesException</a></code> - if the argument Callback throws an Exception, it is wrapped in a <code>FacesException</code>
  and re-thrown.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../jakarta/faces/component/UIComponent.html#invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-"><code>UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../jakarta/faces/component/UIData.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../jakarta/faces/component/UIGraphic.html" title="class in jakarta.faces.component"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?jakarta/faces/component/UIForm.html" target="_top">Frames</a></li>
 <li><a href="UIForm.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>