Google Git
Sign in
apache / tomee-site-pub / 5029b2533c3906b5c1f8300fff30ee925acf2c30 / . / jakartaee-9.1 / javadoc / jakarta / faces / component / UIComponentBase.html
blob: e4aee8d7053286bb2f860c9543b33add19b13e07 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>UIComponentBase</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="UIComponentBase";
}
}
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,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":42,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":9,"i42":10,"i43":9,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":42,"i51":10,"i52":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/UIComponent.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/component/UIData.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/UIComponentBase.html" target="_top">Frames</a></li>
<li><a href="UIComponentBase.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="#fields.inherited.from.class.jakarta.faces.component.UIComponent">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>Field&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 UIComponentBase" class="title">Class UIComponentBase</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>jakarta.faces.component.UIComponentBase</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/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/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/UIColumn.html" title="class in jakarta.faces.component">UIColumn</a>, <a href="../../../jakarta/faces/component/UICommand.html" title="class in jakarta.faces.component">UICommand</a>, <a href="../../../jakarta/faces/component/UIData.html" title="class in jakarta.faces.component">UIData</a>, <a href="../../../jakarta/faces/component/UIForm.html" title="class in jakarta.faces.component">UIForm</a>, <a href="../../../jakarta/faces/component/UIGraphic.html" title="class in jakarta.faces.component">UIGraphic</a>, <a href="../../../jakarta/faces/component/UIImportConstants.html" title="class in jakarta.faces.component">UIImportConstants</a>, <a href="../../../jakarta/faces/component/UIMessage.html" title="class in jakarta.faces.component">UIMessage</a>, <a href="../../../jakarta/faces/component/UIMessages.html" title="class in jakarta.faces.component">UIMessages</a>, <a href="../../../jakarta/faces/component/UINamingContainer.html" title="class in jakarta.faces.component">UINamingContainer</a>, <a href="../../../jakarta/faces/component/UIOutput.html" title="class in jakarta.faces.component">UIOutput</a>, <a href="../../../jakarta/faces/component/UIPanel.html" title="class in jakarta.faces.component">UIPanel</a>, <a href="../../../jakarta/faces/component/UIParameter.html" title="class in jakarta.faces.component">UIParameter</a>, <a href="../../../jakarta/faces/component/UISelectItem.html" title="class in jakarta.faces.component">UISelectItem</a>, <a href="../../../jakarta/faces/component/UISelectItems.html" title="class in jakarta.faces.component">UISelectItems</a>, <a href="../../../jakarta/faces/component/UIViewAction.html" title="class in jakarta.faces.component">UIViewAction</a>, <a href="../../../jakarta/faces/component/UIViewRoot.html" title="class in jakarta.faces.component">UIViewRoot</a>, <a href="../../../jakarta/faces/component/UIWebsocket.html" title="class in jakarta.faces.component">UIWebsocket</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">UIComponentBase</span>
extends <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></pre>
<div class="block"><p>
<strong class="changed_modified_2_0 changed_modified_2_0_rev_a changed_added_2_1">UIComponentBase</strong> is a
convenience base class that implements the default concrete behavior of all methods defined by <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p>
<p>
By default, this class defines <code>getRendersChildren()</code> to find the renderer for this component and call its
<code>getRendersChildren()</code> method. The default implementation on the <code>Renderer</code> returns
<code>false</code>. As of version 1.2 of the Jakarta Server Faces Specification, component authors are encouraged to
return <code>true</code> from this method and rely on the implementation of <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeChildren-jakarta.faces.context.FacesContext-"><code>encodeChildren(jakarta.faces.context.FacesContext)</code></a> in this class and
in the Renderer (<a href="../../../jakarta/faces/render/Renderer.html#encodeChildren-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>Renderer.encodeChildren(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)</code></a>). Subclasses that wish to manage the rendering of their children
should override this method to return <code>true</code> instead.
</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>
<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#CURRENT_COMPONENT">CURRENT_COMPONENT</a>, <a href="../../../jakarta/faces/component/UIComponent.html#CURRENT_COMPOSITE_COMPONENT">CURRENT_COMPOSITE_COMPONENT</a>, <a href="../../../jakarta/faces/component/UIComponent.html#FACETS_KEY">FACETS_KEY</a>, <a href="../../../jakarta/faces/component/UIComponent.html#HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME">HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME</a>, <a href="../../../jakarta/faces/component/UIComponent.html#VIEW_LOCATION_KEY">VIEW_LOCATION_KEY</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/UIComponentBase.html#UIComponentBase--">UIComponentBase</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-">addClientBehavior</a></span>(java.lang.String&nbsp;eventName,
<a href="../../../jakarta/faces/component/behavior/ClientBehavior.html" title="interface in jakarta.faces.component.behavior">ClientBehavior</a>&nbsp;behavior)</code>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-"><code>ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#addFacesListener-jakarta.faces.event.FacesListener-">addFacesListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</code>
<div class="block">
Add the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to the set of listeners registered to receive event notifications from this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#broadcast-jakarta.faces.event.FacesEvent-">broadcast</a></span>(<a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event">FacesEvent</a>&nbsp;event)</code>
<div class="block">
Broadcast the specified <a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event"><code>FacesEvent</code></a> to all registered event listeners who have expressed an interest in events
of this type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#clearInitialState--">clearInitialState</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
For each of the attached objects on this instance that implement <a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component"><code>PartialStateHolder</code></a>, call
<a href="../../../jakarta/faces/component/PartialStateHolder.html#clearInitialState--"><code>PartialStateHolder.clearInitialState()</code></a> on the attached object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#decode-jakarta.faces.context.FacesContext-">decode</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
Decode any new state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> from the request contained in the specified <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>,
and store this state as needed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#encodeBegin-jakarta.faces.context.FacesContext-">encodeBegin</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
<span class="changed_modified_2_0">If</span> our <code>rendered</code> property is <code>true</code>, render the
beginning of the current state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to the response contained in the specified
<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>.</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/UIComponentBase.html#encodeChildren-jakarta.faces.context.FacesContext-">encodeChildren</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
If our <code>rendered</code> property is <code>true</code>, render the child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s of this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</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/UIComponentBase.html#encodeEnd-jakarta.faces.context.FacesContext-">encodeEnd</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
<span class="changed_modified_2_0">If</span> our <code>rendered</code> property is <code>true</code>, render the
ending of the current state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#findComponent-java.lang.String-">findComponent</a></span>(java.lang.String&nbsp;expression)</code>
<div class="block">
<span class="changed_modified_2_2">Search</span> for and return the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> with an <code>id</code> that
matches the specified search expression (if any), according to the algorithm described below.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getAttributes--">getAttributes</a></span>()</code>
<div class="block">
Return a mutable <code>Map</code> representing the attributes (and properties, see below) associated wth this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, keyed by attribute name (which must be a String).</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getChildCount--">getChildCount</a></span>()</code>
<div class="block">
Return the number of child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s that are associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getChildren--">getChildren</a></span>()</code>
<div class="block">
<span class="changed_modified_2_0">Return</span> a mutable <code>List</code> representing the child
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s associated with this component.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.util.List&lt;<a href="../../../jakarta/faces/component/behavior/ClientBehavior.html" title="interface in jakarta.faces.component.behavior">ClientBehavior</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getClientBehaviors--">getClientBehaviors</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getClientBehaviors--"><code>ClientBehaviorHolder.getClientBehaviors()</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getClientId-jakarta.faces.context.FacesContext-">getClientId</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
Return a client-side identifier for this component, generating one if necessary.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getDefaultEventName--">getDefaultEventName</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getDefaultEventName--"><code>ClientBehaviorHolder.getDefaultEventName()</code></a>.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getEventNames--">getEventNames</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getEventNames--"><code>ClientBehaviorHolder.getEventNames()</code></a>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesContext--">getFacesContext</a></span>()</code>
<div class="block">
Convenience method to return the <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> instance for the current request.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacesListeners-java.lang.Class-">getFacesListeners</a></span>(java.lang.Class&nbsp;clazz)</code>
<div class="block">
Return an array of registered <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a>s that are instances of the specified class.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacet-java.lang.String-">getFacet</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">
Convenience method to return the named facet, if it exists, or <code>null</code> otherwise.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetCount--">getFacetCount</a></span>()</code>
<div class="block">
Return the number of facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s that are associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacets--">getFacets</a></span>()</code>
<div class="block">
Return a mutable <code>Map</code> representing the facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s associated with this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, keyed by facet name (which must be a String).</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetsAndChildren--">getFacetsAndChildren</a></span>()</code>
<div class="block">
Return an <code>Iterator</code> over the facet followed by child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getId--">getId</a></span>()</code>
<div class="block">
Return the component identifier of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event">SystemEventListener</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getListenersForEventClass-java.lang.Class-">getListenersForEventClass</a></span>(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass)</code>
<div class="block"><p class="changed_added_2_1">
Return the <code>SystemEventListener</code> instances registered on this <code>UIComponent</code> instance that are
interested in events of type <code>eventClass</code>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getParent--">getParent</a></span>()</code>
<div class="block">
Return the parent <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> of this <code>UIComponent</code>, if any.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getPassThroughAttributes-boolean-">getPassThroughAttributes</a></span>(boolean&nbsp;create)</code>
<div class="block"><p class="changed_added_2_2">
This method has the same specification as <a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes--"><code>UIComponent.getPassThroughAttributes()</code></a> except that it is allowed to return
<code>null</code> if and only if the argument <code>create</code> is <code>false</code> and no pass through attribute data structure
exists for this instance.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>protected <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getRenderer-jakarta.faces.context.FacesContext-">getRenderer</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
Convenience method to return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance associated with this component, if any; otherwise, return
<code>null</code>.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getRendererType--">getRendererType</a></span>()</code>
<div class="block">
Return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> type for this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> (if any).</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getRendersChildren--">getRendersChildren</a></span>()</code>
<div class="block">
Return a flag indicating whether this component is responsible for rendering its child components.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el">ValueBinding</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#getValueBinding-java.lang.String-">getValueBinding</a></span>(java.lang.String&nbsp;name)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This has been replaced by <a href="../../../jakarta/faces/component/UIComponent.html#getValueExpression-java.lang.String-"><code>UIComponent.getValueExpression(java.lang.String)</code></a>.</span></div>
</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.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="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#isRendered--">isRendered</a></span>()</code>
<div class="block">
Return <code>true</code> if this component (and its children) should be rendered during the <em>Render Response</em>
phase of the request processing lifecycle.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#isTransient--">isTransient</a></span>()</code>
<div class="block">
If true, the Object implementing this interface must not participate in state saving or restoring.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#markInitialState--">markInitialState</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
For each of the attached objects on this instance that implement <a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component"><code>PartialStateHolder</code></a>, call
<a href="../../../jakarta/faces/component/PartialStateHolder.html#markInitialState--"><code>PartialStateHolder.markInitialState()</code></a> on the attached object.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.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">
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Apply Request
Values</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">processRestoreState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;state)</code>
<div class="block">
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Restore View</em>
phase of the request processing lifecycle for all facets of this component, all children of this component, and this
component itself, as follows.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#processSaveState-jakarta.faces.context.FacesContext-">processSaveState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the state saving portion
of the <em>Render Response</em> phase of the request processing lifecycle for all facets of this component, all
children of this component, and this component itself, as follows.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.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">
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Update Model
Values</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.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">
<span class="changed_modified_2_0 changed_modified_2_3"><span class=
"changed_modified_2_0_rev_a">Perform</span></span> the component tree processing required by the <em>Process
Validations</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#queueEvent-jakarta.faces.event.FacesEvent-">queueEvent</a></span>(<a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event">FacesEvent</a>&nbsp;event)</code>
<div class="block">
Queue an event for broadcast at the end of the current request processing lifecycle phase.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#removeFacesListener-jakarta.faces.event.FacesListener-">removeFacesListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</code>
<div class="block">
Remove the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> from the set of listeners registered to receive event notifications from
this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#restoreAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreAttachedState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;stateObj)</code>
<div class="block">
This method is called by <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> subclasses that need to restore the objects they saved using
<a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#restoreState-jakarta.faces.context.FacesContext-java.lang.Object-">restoreState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;state)</code>
<div class="block">
<span class="changed_modified_2_0_rev_a">Perform</span> any processing required to restore the state from the entries
in the state Object.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">saveAttachedState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;attachedObject)</code>
<div class="block"><p class="changed_modified_2_0">
This method is called by <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> subclasses that want to save one or more attached objects.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#saveState-jakarta.faces.context.FacesContext-">saveState</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</code>
<div class="block">
Gets the state of the instance as a <code>Serializable</code> Object.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setId-java.lang.String-">setId</a></span>(java.lang.String&nbsp;id)</code>
<div class="block">
Set the component identifier of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> (if any).</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setParent-jakarta.faces.component.UIComponent-">setParent</a></span>(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;parent)</code>
<div class="block"><p class="changed_modified_2_0">
<span class="changed_modified_2_0_rev_a">Set</span> the parent <code>UIComponent</code> of this
<code>UIComponent</code>.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setRendered-boolean-">setRendered</a></span>(boolean&nbsp;rendered)</code>
<div class="block">
Set the <code>rendered</code> property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setRendererType-java.lang.String-">setRendererType</a></span>(java.lang.String&nbsp;rendererType)</code>
<div class="block">
Set the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> type for this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, or <code>null</code> for components that render
themselves.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setTransient-boolean-">setTransient</a></span>(boolean&nbsp;transientFlag)</code>
<div class="block">
<span class="changed_modified_2_0_rev_a">Denotes</span> whether or not the Object implementing this interface must or
must not participate in state saving or restoring.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#setValueBinding-java.lang.String-jakarta.faces.el.ValueBinding-">setValueBinding</a></span>(java.lang.String&nbsp;name,
<a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el">ValueBinding</a>&nbsp;binding)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This has been replaced by <a href="../../../jakarta/faces/component/UIComponent.html#setValueExpression-java.lang.String-jakarta.el.ValueExpression-"><code>UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression)</code></a>.</span></div>
</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#subscribeToEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">subscribeToEvent</a></span>(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass,
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>&nbsp;componentListener)</code>
<div class="block"><p class="changed_added_2_1">
Install the listener instance referenced by argument <code>componentListener</code> as a listener for events of type
<code>eventClass</code> originating from this specific instance of <code>UIComponent</code>.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/component/UIComponentBase.html#unsubscribeFromEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">unsubscribeFromEvent</a></span>(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass,
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>&nbsp;componentListener)</code>
<div class="block"><p class="changed_added_2_1">
Remove the listener instance referenced by argument <code>componentListener</code> as a listener for events of type
<code>eventClass</code> originating from this specific instance of <code>UIComponent</code>.</div>
</td>
</tr>
</table>
<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#getContainerClientId-jakarta.faces.context.FacesContext-">getContainerClientId</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#getFamily--">getFamily</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>, <a href="../../../jakarta/faces/component/UIComponent.html#visitTree-jakarta.faces.component.visit.VisitContext-jakarta.faces.component.visit.VisitCallback-">visitTree</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UIComponentBase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UIComponentBase</h4>
<pre>public&nbsp;UIComponentBase()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getAttributes()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getAttributes--">UIComponent</a></code></span></div>
<div class="block"><p>
Return a mutable <code>Map</code> representing the attributes (and properties, see below) associated wth this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, keyed by attribute name (which must be a String). The returned implementation must support all
of the standard and optional <code>Map</code> methods, plus support the following additional requirements:
</p>
<ul>
<li>The <code>Map</code> implementation must implement the <code>java.io.Serializable</code> interface.</li>
<li>Any attempt to add a <code>null</code> key or value must throw a <code>NullPointerException</code>.</li>
<li>Any attempt to add a key that is not a String must throw a <code>ClassCastException</code>.</li>
<li>If the attribute name specified as a key matches a property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>'s implementation class,
the following methods will have special behavior:
<ul>
<li><code>containsKey</code> - Return <code>false</code>.</li>
<li><code>get()</code> - If the property is readable, call the getter method and return the returned value (wrapping
primitive values in their corresponding wrapper classes); otherwise throw <code>IllegalArgumentException</code>.</li>
<li><code>put()</code> - If the property is writeable, call the setter method to set the corresponding value
(unwrapping primitive values in their corresponding wrapper classes). If the property is not writeable, or an attempt
is made to set a property of primitive type to <code>null</code>, throw <code>IllegalArgumentException</code>.</li>
<li><code>remove</code> - Throw <code>IllegalArgumentException</code>.</li>
</ul>
</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getAttributes--">getAttributes</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 attribute map.</dd>
</dl>
</li>
</ul>
<a name="getPassThroughAttributes-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassThroughAttributes</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getPassThroughAttributes(boolean&nbsp;create)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes-boolean-">UIComponent</a></code></span></div>
<div class="block"><p class="changed_added_2_2">
This method has the same specification as <a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes--"><code>UIComponent.getPassThroughAttributes()</code></a> except that it is allowed to return
<code>null</code> if and only if the argument <code>create</code> is <code>false</code> and no pass through attribute data structure
exists for this instance. The returned <code>Map</code> implementation must support all of the standard and optional
<code>Map</code> methods, plus support the following additional requirements. The map must be stored in using
<a href="../../../jakarta/faces/component/UIComponent.html#getStateHelper--"><code>UIComponent.getStateHelper()</code></a>.
</p>
<div class="changed_added_2_2">
<p>
The <code>Map</code> implementation must implement <code>java.io.Serializable</code>.
</p>
<p>
Any attempt to add a <code>null</code> key or value must throw a <code>NullPointerException</code>.
</p>
<p>
Any attempt to add a key that is not a <code>String</code> must throw an <code>IllegalArgumentException</code>.
</p>
<p>
For backward compatibility with components that extend directly from this class, a default implementation is provided
that returns the empty map.
</p>
</div></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getPassThroughAttributes-boolean-">getPassThroughAttributes</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>create</code> - if <code>true</code>, a new <code>Map</code> instance will be created if it does not exist already. If
<code>false</code>, and there is no existing <code>Map</code> instance, one will not be created and <code>null</code>
will be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>Map</code> instance, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getClientId-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientId</h4>
<pre>public&nbsp;java.lang.String&nbsp;getClientId(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getClientId-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
Return a client-side identifier for this component, generating one if necessary. The associated <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>, if
any, will be asked to convert the clientId to a form suitable for transmission to the client.
</p>
<p>
The return from this method must be the same value throughout the lifetime of the instance, unless the
<code>id</code> property of the component is changed, or the component is placed in a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> whose
client ID changes (for example, <a href="../../../jakarta/faces/component/UIData.html" title="class in jakarta.faces.component"><code>UIData</code></a>). However, even in these cases, consecutive calls to this method must
always return the same value. The implementation must follow these steps in determining the clientId:
</p>
<p>
Find the closest ancestor to <b>this</b> component in the view hierarchy that implements
<code>NamingContainer</code>. Call <code>getContainerClientId()</code> on it and save the result as the
<code>parentId</code> local variable. Call <a href="../../../jakarta/faces/component/UIComponent.html#getId--"><code>UIComponent.getId()</code></a> on <b>this</b> component and save the result as the
<code>myId</code> local variable. If <code>myId</code> is <code>null</code>, call
<code>context.getViewRoot().createUniqueId()</code> and assign the result to myId. If <code>parentId</code> is
non-<code>null</code>, let <code>myId</code> equal <code>parentId
+ <a href="../../../jakarta/faces/component/UINamingContainer.html#getSeparatorChar-jakarta.faces.context.FacesContext-"><code>UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)</code></a> + myId</code>. Call <a href="../../../jakarta/faces/render/Renderer.html#convertClientId-jakarta.faces.context.FacesContext-java.lang.String-"><code>Renderer.convertClientId(jakarta.faces.context.FacesContext, java.lang.String)</code></a>, passing
<code>myId</code>, and return the result.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getClientId-jakarta.faces.context.FacesContext-">getClientId</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 <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the current request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the client id.</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="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;java.lang.String&nbsp;getId()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getId--">UIComponent</a></code></span></div>
<div class="block"><p>
Return the component identifier of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getId--">getId</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 identifier.</dd>
</dl>
</li>
</ul>
<a name="setId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(java.lang.String&nbsp;id)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#setId-java.lang.String-">UIComponent</a></code></span></div>
<div class="block"><p>
Set the component identifier of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> (if any). Component identifiers must obey the following
syntax restrictions:
</p>
<ul>
<li>Must not be a zero-length String.</li>
<li>First character must be a letter or an underscore ('_').</li>
<li>Subsequent characters must be a letter, a digit, an underscore ('_'), or a dash ('-').</li>
<li>
</ul>
<p>
Component identifiers must also obey the following semantic restrictions (note that this restriction is
<strong>NOT</strong> enforced by the <code>setId()</code> implementation):
</p>
<ul>
<li>The specified identifier must be unique among all the components (including facets) that are descendents of the
nearest ancestor <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> that is a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a>, or within the scope of the entire component
tree if there is no such ancestor that is a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a>.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#setId-java.lang.String-">setId</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>id</code> - The new component identifier, or <code>null</code> to indicate that this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> does not have
a component identifier</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>id</code> is not syntactically valid</dd>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="getParent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre>public&nbsp;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;getParent()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getParent--">UIComponent</a></code></span></div>
<div class="block"><p>
Return the parent <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> of this <code>UIComponent</code>, if any. A component must allow child
components to be added to and removed from the list of children of this component, even though the child component
returns null from <code>getParent( )</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getParent--">getParent</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 parent component.</dd>
</dl>
</li>
</ul>
<a name="setParent-jakarta.faces.component.UIComponent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParent</h4>
<pre>public&nbsp;void&nbsp;setParent(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;parent)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#setParent-jakarta.faces.component.UIComponent-">UIComponent</a></code></span></div>
<div class="block"><p class="changed_modified_2_0">
<span class="changed_modified_2_0_rev_a">Set</span> the parent <code>UIComponent</code> of this
<code>UIComponent</code>. <span class="changed_added_2_0 changed_modified_2_0_rev_a">If
<code>parent.isInView()</code> returns <code>true</code>, calling this method will first cause a
<a href="../../../jakarta/faces/event/PreRemoveFromViewEvent.html" title="class in jakarta.faces.event"><code>PreRemoveFromViewEvent</code></a> to be published, for this node, and then the children of this
node. Then, once the re-parenting has occurred, a <a href="../../../jakarta/faces/event/PostAddToViewEvent.html" title="class in jakarta.faces.event"><code>PostAddToViewEvent</code></a> will be published as
well, first for this node, and then for the node's children, <span class="changed_modified_2_0_rev_a">but only if any
of the following conditions are true.</span></span>
</p>
<div class="changed_modified_2_0_rev_a">
<ul>
<li>
<p>
<a href="../../../jakarta/faces/context/FacesContext.html#getCurrentPhaseId--"><code>FacesContext.getCurrentPhaseId()</code></a> returns <a href="../../../jakarta/faces/event/PhaseId.html#RESTORE_VIEW"><code>PhaseId.RESTORE_VIEW</code></a>
and partial state saving is enabled.
</p>
</li>
<li>
<p>
<a href="../../../jakarta/faces/context/FacesContext.html#isPostback--"><code>FacesContext.isPostback()</code></a> returns <code>false</code> and
<a href="../../../jakarta/faces/context/FacesContext.html#getCurrentPhaseId--"><code>FacesContext.getCurrentPhaseId()</code></a> returns something other than
<a href="../../../jakarta/faces/event/PhaseId.html#RESTORE_VIEW"><code>PhaseId.RESTORE_VIEW</code></a>
</p>
</li>
</ul>
</div>
<p class="changed_modified_2_0">
<strong>This method must never be called by developers; a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>'s internal implementation will call it
as components are added to or removed from a parent's child <code>List</code> or facet <code>Map</code></strong>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#setParent-jakarta.faces.component.UIComponent-">setParent</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>parent</code> - The new parent, or <code>null</code> for the root node of a component tree</dd>
</dl>
</li>
</ul>
<a name="isRendered--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRendered</h4>
<pre>public&nbsp;boolean&nbsp;isRendered()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#isRendered--">UIComponent</a></code></span></div>
<div class="block"><p>
Return <code>true</code> if this component (and its children) should be rendered during the <em>Render Response</em>
phase of the request processing lifecycle.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#isRendered--">isRendered</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><code>true</code> if the component should be rendered, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="setRendered-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRendered</h4>
<pre>public&nbsp;void&nbsp;setRendered(boolean&nbsp;rendered)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#setRendered-boolean-">UIComponent</a></code></span></div>
<div class="block"><p>
Set the <code>rendered</code> property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#setRendered-boolean-">setRendered</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>rendered</code> - If <code>true</code> render this component; otherwise, do not render this component</dd>
</dl>
</li>
</ul>
<a name="getRendererType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRendererType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getRendererType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getRendererType--">UIComponent</a></code></span></div>
<div class="block"><p>
Return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> type for this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> (if any).
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getRendererType--">getRendererType</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 renderer type.</dd>
</dl>
</li>
</ul>
<a name="setRendererType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRendererType</h4>
<pre>public&nbsp;void&nbsp;setRendererType(java.lang.String&nbsp;rendererType)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#setRendererType-java.lang.String-">UIComponent</a></code></span></div>
<div class="block"><p>
Set the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> type for this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, or <code>null</code> for components that render
themselves.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#setRendererType-java.lang.String-">setRendererType</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>rendererType</code> - Logical identifier of the type of <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> to use, or <code>null</code> for components
that render themselves</dd>
</dl>
</li>
</ul>
<a name="getRendersChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRendersChildren</h4>
<pre>public&nbsp;boolean&nbsp;getRendersChildren()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getRendersChildren--">UIComponent</a></code></span></div>
<div class="block"><p>
Return a flag indicating whether this component is responsible for rendering its child components. The default
implementation in <a href="../../../jakarta/faces/component/UIComponentBase.html#getRendersChildren--"><code>getRendersChildren()</code></a> tries to find the renderer for this component. If it
does, it calls <a href="../../../jakarta/faces/render/Renderer.html#getRendersChildren--"><code>Renderer.getRendersChildren()</code></a> and returns the result. If it doesn't, it returns false. As of
version 1.2 of the Jakarta Server Faces Specification, component authors are encouraged to return <code>true</code>
from this method and rely on <a href="../../../jakarta/faces/component/UIComponentBase.html#encodeChildren-jakarta.faces.context.FacesContext-"><code>encodeChildren(jakarta.faces.context.FacesContext)</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getRendersChildren--">getRendersChildren</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><code>true</code> if the component renders its children, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="getChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;&nbsp;getChildren()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getChildren--">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">Return</span> a mutable <code>List</code> representing the child
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s associated with this component. The returned implementation must support all of the standard and
optional <code>List</code> methods, plus support the following additional requirements:
</p>
<ul>
<li>The <code>List</code> implementation must implement the <code>java.io.Serializable</code> interface.</li>
<li>Any attempt to add a <code>null</code> must throw a NullPointerException</li>
<li>Any attempt to add an object that does not implement <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> must throw a ClassCastException.</li>
<li>Whenever a new child component is added, the <code>parent</code> property of the child must be set to this
component instance. If the <code>parent</code> property of the child was already non-null, the child must first be
removed from its previous parent (where it may have been either a child or a facet).</li>
<li>Whenever an existing child component is removed, the <code>parent</code> property of the child must be set to
<code>null</code>.</li>
<li class="changed_modified_2_1">
<p>
After the child component has been added to the view, <a href="../../../jakarta/faces/application/Application.html#publishEvent-jakarta.faces.context.FacesContext-java.lang.Class-java.lang.Object-"><code>Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class&lt;? extends jakarta.faces.event.SystemEvent&gt;, java.lang.Object)</code></a> must
be called, passing <a href="../../../jakarta/faces/event/PostAddToViewEvent.html" title="class in jakarta.faces.event"><code>PostAddToViewEvent</code></a><code>.class</code> as the first argument and the
newly added component as the second argument if any the following cases are true.
</p>
<ul>
<li>
<p>
<a href="../../../jakarta/faces/context/FacesContext.html#getCurrentPhaseId--"><code>FacesContext.getCurrentPhaseId()</code></a> returns <a href="../../../jakarta/faces/event/PhaseId.html#RESTORE_VIEW"><code>PhaseId.RESTORE_VIEW</code></a>
and partial state saving is enabled.
</p>
</li>
<li>
<p>
<a href="../../../jakarta/faces/context/FacesContext.html#isPostback--"><code>FacesContext.isPostback()</code></a> returns <code>false</code> and
<a href="../../../jakarta/faces/context/FacesContext.html#getCurrentPhaseId--"><code>FacesContext.getCurrentPhaseId()</code></a> returns something other than
<a href="../../../jakarta/faces/event/PhaseId.html#RESTORE_VIEW"><code>PhaseId.RESTORE_VIEW</code></a>
</p>
</li>
</ul>
</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getChildren--">getChildren</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 list of children.</dd>
</dl>
</li>
</ul>
<a name="getChildCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildCount</h4>
<pre>public&nbsp;int&nbsp;getChildCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getChildCount--">UIComponent</a></code></span></div>
<div class="block"><p>
Return the number of child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s that are associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>. If there are no
children, this method must return 0. The method must not cause the creation of a child component list.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getChildCount--">getChildCount</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 number of child components.</dd>
</dl>
</li>
</ul>
<a name="findComponent-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findComponent</h4>
<pre>public&nbsp;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;findComponent(java.lang.String&nbsp;expression)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#findComponent-java.lang.String-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_2">Search</span> for and return the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> with an <code>id</code> that
matches the specified search expression (if any), according to the algorithm described below.
</p>
<p class="changed_added_2_2">
WARNING: The found <code>UIComponent</code> instance, if any, is returned <strong>without</strong> regard for its
tree traversal context. Retrieving an Jakarta Expression Language-bound attribute from the component is not safe.
Jakarta Expression Language expressions can contain implicit objects, such as <code>#{component}</code>, which assume
they are being evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of
implicit objects outside of a tree traversal context produces undefined results. See <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> for a
method that <strong>does</strong> correctly account for the tree traversal context when operating on the found
<code>UIComponent</code> instance. <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> is also useful to find components given a simple
<code>clientId</code>.
<p>
Component identifiers are required to be unique within the scope of the closest ancestor <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> that
encloses this component (which might be this component itself). If there are no <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> components in
the ancestry of this component, the root component in the tree is treated as if it were a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a>,
whether or not its class actually implements the <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> interface.
</p>
<p>
A <em>search expression</em> consists of either an identifier (which is matched exactly against the <code>id</code>
property of a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, or a series of such identifiers linked by the
<a href="../../../jakarta/faces/component/UINamingContainer.html#getSeparatorChar-jakarta.faces.context.FacesContext-"><code>UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)</code></a> character value. The search algorithm should operates as follows, though
alternate alogrithms may be used as long as the end result is the same:
</p>
<ul>
<li>Identify the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> that will be the base for searching, by stopping as soon as one of the following
conditions is met:
<ul>
<li>If the search expression begins with the the separator character (called an "absolute" search expression), the
base will be the root <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> of the component tree. The leading separator character will be stripped
off, and the remainder of the search expression will be treated as a "relative" search expression as described
below.</li>
<li>Otherwise, if this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> it will serve as the basis.</li>
<li>Otherwise, search up the parents of this component. If a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> is encountered, it will be the
base.</li>
<li>Otherwise (if no <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> is encountered) the root <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> will be the base.</li>
</ul>
</li>
<li>The search expression (possibly modified in the previous step) is now a "relative" search expression that will be
used to locate the component (if any) that has an <code>id</code> that matches, within the scope of the base
component. The match is performed as follows:
<ul>
<li>If the search expression is a simple identifier, this value is compared to the <code>id</code> property, and then
recursively through the facets and children of the base <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> (except that if a descendant
<a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> is found, its own facets and children are not searched).</li>
<li>If the search expression includes more than one identifier separated by the separator character, the first
identifier is used to locate a <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> by the rules in the previous bullet point. Then, the
<code>findComponent()</code> method of this <a href="../../../jakarta/faces/component/NamingContainer.html" title="interface in jakarta.faces.component"><code>NamingContainer</code></a> will be called, passing the remainder of the
search expression.</li>
</ul>
</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#findComponent-java.lang.String-">findComponent</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>expression</code> - Search expression identifying the <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the found <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, or <code>null</code> if the component was not found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>expr</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="invokeOnComponent-jakarta.faces.context.FacesContext-java.lang.String-jakarta.faces.component.ContextCallback-">
<!-- -->
</a>
<ul class="blockList">
<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"><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/UIComponent.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/UIComponent.html" title="class in jakarta.faces.component">UIComponent</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>java.lang.NullPointerException</code> - if any of the arguments are null</dd>
<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="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="getFacets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacets</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;&nbsp;getFacets()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacets--">UIComponent</a></code></span></div>
<div class="block"><p>
Return a mutable <code>Map</code> representing the facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s associated with this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, keyed by facet name (which must be a String). The returned implementation must support all of
the standard and optional <code>Map</code> methods, plus support the following additional requirements:
</p>
<ul>
<li>The <code>Map</code> implementation must implement the <code>java.io.Serializable</code> interface.</li>
<li>Any attempt to add a <code>null</code> key or value must throw a NullPointerException.</li>
<li>Any attempt to add a key that is not a String must throw a ClassCastException.</li>
<li>Any attempt to add a value that is not a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> must throw a ClassCastException.</li>
<li>Whenever a new facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is added:
<ul>
<li>The <code>parent</code> property of the component must be set to this component instance.</li>
<li>If the <code>parent</code> property of the component was already non-null, the component must first be removed
from its previous parent (where it may have been either a child or a facet).</li>
</ul>
</li>
<li>Whenever an existing facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is removed:
<ul>
<li>The <code>parent</code> property of the facet must be set to <code>null</code>.</li>
</ul>
</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacets--">getFacets</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 map of facets.</dd>
</dl>
</li>
</ul>
<a name="getFacetCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacetCount</h4>
<pre>public&nbsp;int&nbsp;getFacetCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacetCount--">UIComponent</a></code></span></div>
<div class="block"><p>
Return the number of facet <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s that are associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>. If there are no
facets, this method must return 0. The method must not cause the creation of a facet component map.
</p>
<p>
For backwards compatability with classes that extend UIComponent directly, a default implementation is provided that
simply calls <a href="../../../jakarta/faces/component/UIComponent.html#getFacets--"><code>UIComponent.getFacets()</code></a> and then calls the <code>size()</code> method on the returned <code>Map</code>. A
more optimized version of this method is provided in <a href="../../../jakarta/faces/component/UIComponentBase.html#getFacetCount--"><code>getFacetCount()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacetCount--">getFacetCount</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 number of facets.</dd>
</dl>
</li>
</ul>
<a name="getFacet-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacet</h4>
<pre>public&nbsp;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;getFacet(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacet-java.lang.String-">UIComponent</a></code></span></div>
<div class="block"><p>
Convenience method to return the named facet, if it exists, or <code>null</code> otherwise. If the requested facet
does not exist, the facets Map must not be created.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacet-java.lang.String-">getFacet</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>name</code> - Name of the desired facet</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the component, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getFacetsAndChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacetsAndChildren</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&gt;&nbsp;getFacetsAndChildren()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacetsAndChildren--">UIComponent</a></code></span></div>
<div class="block"><p>
Return an <code>Iterator</code> over the facet followed by child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
Facets are returned in an undefined order, followed by all the children in the order they are stored in the child
list. If this component has no facets or children, an empty <code>Iterator</code> is returned.
</p>
<p>
The returned <code>Iterator</code> must not support the <code>remove()</code> operation.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacetsAndChildren--">getFacetsAndChildren</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 facets and children iterator.</dd>
</dl>
</li>
</ul>
<a name="broadcast-jakarta.faces.event.FacesEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>broadcast</h4>
<pre>public&nbsp;void&nbsp;broadcast(<a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event">FacesEvent</a>&nbsp;event)
throws <a href="../../../jakarta/faces/event/AbortProcessingException.html" title="class in jakarta.faces.event">AbortProcessingException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#broadcast-jakarta.faces.event.FacesEvent-">UIComponent</a></code></span></div>
<div class="block"><p>
Broadcast the specified <a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event"><code>FacesEvent</code></a> to all registered event listeners who have expressed an interest in events
of this type. Listeners are called in the order in which they were added.
</p>
<p class="changed_added_2_0">
If the <code>event</code> is an instance of <a href="../../../jakarta/faces/event/BehaviorEvent.html" title="class in jakarta.faces.event"><code>BehaviorEvent</code></a> and the current
<code>component</code> is the source of the <code>event</code> call
<a href="../../../jakarta/faces/event/BehaviorEvent.html#getBehavior--"><code>BehaviorEvent.getBehavior()</code></a> to get the <a href="../../../jakarta/faces/component/behavior/Behavior.html" title="interface in jakarta.faces.component.behavior"><code>Behavior</code></a>
for the event.
<span class="changed_modified_2_0_rev_a">Call
<a href="../../../jakarta/faces/component/behavior/Behavior.html#broadcast-jakarta.faces.event.BehaviorEvent-"><code>Behavior.broadcast(jakarta.faces.event.BehaviorEvent)</code></a> on the
<code>Behavior</code> instance</span>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#broadcast-jakarta.faces.event.FacesEvent-">broadcast</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>event</code> - The <a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event"><code>FacesEvent</code></a> to be broadcast</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/faces/event/AbortProcessingException.html" title="class in jakarta.faces.event">AbortProcessingException</a></code> - Signal the Jakarta Server Faces implementation that no further processing on the
current event should be performed</dd>
<dd><code>java.lang.IllegalStateException</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>event</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="decode-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public&nbsp;void&nbsp;decode(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#decode-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
Decode any new state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> from the request contained in the specified <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>,
and store this state as needed.
</p>
<p>
During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by
calling <code>queueEvent()</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#decode-jakarta.faces.context.FacesContext-">decode</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> - <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="encodeBegin-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBegin</h4>
<pre>public&nbsp;void&nbsp;encodeBegin(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#encodeBegin-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">If</span> our <code>rendered</code> property is <code>true</code>, render the
beginning of the current state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> to the response contained in the specified
<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a>. 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>. Call
<a href="../../../jakarta/faces/application/Application.html#publishEvent-jakarta.faces.context.FacesContext-java.lang.Class-java.lang.Object-"><code>Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class&lt;? extends jakarta.faces.event.SystemEvent&gt;, java.lang.Object)</code></a>, passing
<a href="../../../jakarta/faces/event/PreRenderComponentEvent.html" title="class in jakarta.faces.event"><code>PreRenderComponentEvent</code></a><code>.class</code> as the first argument and the component
instance to be rendered as the second argument.
</p>
<p>
If a <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> is associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, the actual encoding will be delegated to
<a href="../../../jakarta/faces/render/Renderer.html#encodeBegin-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>Renderer.encodeBegin(FacesContext, UIComponent)</code></a>.
</p>
<p class="changed_added_2_0">
If our <code>rendered</code> property is <code>false</code>, 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> and return
immediately.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#encodeBegin-jakarta.faces.context.FacesContext-">encodeBegin</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> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the response we are creating</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
</dl>
</li>
</ul>
<a name="encodeChildren-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeChildren</h4>
<pre>public&nbsp;void&nbsp;encodeChildren(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#encodeChildren-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
If our <code>rendered</code> property is <code>true</code>, render the child <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>s of this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>. This method will only be called if the <code>rendersChildren</code> property is
<code>true</code>.
</p>
<p>
If a <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> is associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, the actual encoding will be delegated to
<a href="../../../jakarta/faces/render/Renderer.html#encodeChildren-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>Renderer.encodeChildren(FacesContext, UIComponent)</code></a>. <span class="changed_modified_2_0">If no <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a>
is associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, iterate over each of the children of this component and call
<a href="../../../jakarta/faces/component/UIComponent.html#encodeAll-jakarta.faces.context.FacesContext-"><code>UIComponent.encodeAll(jakarta.faces.context.FacesContext)</code></a>.</span>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#encodeChildren-jakarta.faces.context.FacesContext-">encodeChildren</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> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the response we are creating</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
</dl>
</li>
</ul>
<a name="encodeEnd-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeEnd</h4>
<pre>public&nbsp;void&nbsp;encodeEnd(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#encodeEnd-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">If</span> our <code>rendered</code> property is <code>true</code>, render the
ending of the current state of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p>
<p>
If a <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> is associated with this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, the actual encoding will be delegated to
<a href="../../../jakarta/faces/render/Renderer.html#encodeEnd-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-"><code>Renderer.encodeEnd(FacesContext, UIComponent)</code></a>.
</p>
<p class="changed_added_2_0">
Call <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a>. before returning regardless of the value of the <code>rendered</code>
property.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#encodeEnd-jakarta.faces.context.FacesContext-">encodeEnd</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> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the response we are creating</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an input/output error occurs while rendering</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>context</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="addFacesListener-jakarta.faces.event.FacesListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFacesListener</h4>
<pre>protected&nbsp;void&nbsp;addFacesListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</pre>
<div class="block"><p>
Add the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to the set of listeners registered to receive event notifications from this
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>. It is expected that <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> classes acting as event sources will have corresponding
typesafe APIs for registering listeners of the required type, and the implementation of those registration methods
will delegate to this method. For example:
</p>
<pre>
public class FooEvent extends FacesEvent {
...
protected boolean isAppropriateListener(FacesListener listener) {
return (listener instanceof FooListener);
}
protected void processListener(FacesListener listener) {
((FooListener) listener).processFoo(this);
}
...
}
public interface FooListener extends FacesListener {
public void processFoo(FooEvent event);
}
public class FooComponent extends UIComponentBase {
...
public void addFooListener(FooListener listener) {
addFacesListener(listener);
}
public void removeFooListener(FooListener listener) {
removeFacesListener(listener);
}
...
}
</pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#addFacesListener-jakarta.faces.event.FacesListener-">addFacesListener</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>listener</code> - The <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to be registered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>listener</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getFacesListeners-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacesListeners</h4>
<pre>protected&nbsp;<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>[]&nbsp;getFacesListeners(java.lang.Class&nbsp;clazz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacesListeners-java.lang.Class-">UIComponent</a></code></span></div>
<div class="block"><p>
Return an array of registered <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a>s that are instances of the specified class. If there are no such
registered listeners, a zero-length array is returned. The returned array can be safely be cast to an array strongly
typed to an element type of <code>clazz</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacesListeners-java.lang.Class-">getFacesListeners</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>clazz</code> - Class that must be implemented by a <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> for it to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Faces listeners, or a zero-length array.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>class</code> is not, and does not implement, <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>clazz</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="removeFacesListener-jakarta.faces.event.FacesListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFacesListener</h4>
<pre>protected&nbsp;void&nbsp;removeFacesListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</pre>
<div class="block"><p>
Remove the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> from the set of listeners registered to receive event notifications from
this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#removeFacesListener-jakarta.faces.event.FacesListener-">removeFacesListener</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>listener</code> - The <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to be deregistered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>listener</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="queueEvent-jakarta.faces.event.FacesEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queueEvent</h4>
<pre>public&nbsp;void&nbsp;queueEvent(<a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event">FacesEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#queueEvent-jakarta.faces.event.FacesEvent-">UIComponent</a></code></span></div>
<div class="block"><p>
Queue an event for broadcast at the end of the current request processing lifecycle phase. The default implementation
in <a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component"><code>UIComponentBase</code></a> must delegate this call to the <code>queueEvent()</code> method of the parent
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#queueEvent-jakarta.faces.event.FacesEvent-">queueEvent</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>event</code> - <a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event"><code>FacesEvent</code></a> to be queued</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this component is not a descendant of a <a href="../../../jakarta/faces/component/UIViewRoot.html" title="class in jakarta.faces.component"><code>UIViewRoot</code></a></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>event</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="subscribeToEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribeToEvent</h4>
<pre>public&nbsp;void&nbsp;subscribeToEvent(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass,
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>&nbsp;componentListener)</pre>
<div class="block"><p class="changed_added_2_1">
Install the listener instance referenced by argument <code>componentListener</code> as a listener for events of type
<code>eventClass</code> originating from this specific instance of <code>UIComponent</code>. The default
implementation creates an inner <a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event"><code>SystemEventListener</code></a> instance that wraps argument
<code>componentListener</code> as the <code>listener</code> argument. This inner class must call through to the
argument <code>componentListener</code> in its implementation of <a href="../../../jakarta/faces/event/SystemEventListener.html#processEvent-jakarta.faces.event.SystemEvent-"><code>SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)</code></a> and its
implementation of <a href="../../../jakarta/faces/event/SystemEventListener.html#isListenerForSource-java.lang.Object-"><code>SystemEventListener.isListenerForSource(java.lang.Object)</code></a> must return true if the instance class of this
<code>UIComponent</code> is assignable from the argument to <code>isListenerForSource</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#subscribeToEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">subscribeToEvent</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>eventClass</code> - the <code>Class</code> of event for which <code>listener</code> must be fired.</dd>
<dd><code>componentListener</code> - the implementation of <a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><code>ComponentSystemEventListener</code></a> whose
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html#processEvent-jakarta.faces.event.ComponentSystemEvent-"><code>ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)</code></a> method must be called when events of type
<code>facesEventClass</code> are fired.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if any of the arguments are <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a name="unsubscribeFromEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsubscribeFromEvent</h4>
<pre>public&nbsp;void&nbsp;unsubscribeFromEvent(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass,
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event">ComponentSystemEventListener</a>&nbsp;componentListener)</pre>
<div class="block"><p class="changed_added_2_1">
Remove the listener instance referenced by argument <code>componentListener</code> as a listener for events of type
<code>eventClass</code> originating from this specific instance of <code>UIComponent</code>. When doing the
comparison to determine if an existing listener is equal to the argument <code>componentListener</code> (and thus
must be removed), the <code>equals()</code> method on the <em>existing listener</em> must be invoked, passing the
argument <code>componentListener</code>, rather than the other way around.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#unsubscribeFromEvent-java.lang.Class-jakarta.faces.event.ComponentSystemEventListener-">unsubscribeFromEvent</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>eventClass</code> - the <code>Class</code> of event for which <code>listener</code> must be removed.</dd>
<dd><code>componentListener</code> - the implementation of <a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><code>ComponentSystemEventListener</code></a> whose
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html#processEvent-jakarta.faces.event.ComponentSystemEvent-"><code>ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)</code></a> method must no longer be called when events of type
<code>eventClass</code> are fired.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if any of the arguments are <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a name="getListenersForEventClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListenersForEventClass</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event">SystemEventListener</a>&gt;&nbsp;getListenersForEventClass(java.lang.Class&lt;? extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a>&gt;&nbsp;eventClass)</pre>
<div class="block"><p class="changed_added_2_1">
Return the <code>SystemEventListener</code> instances registered on this <code>UIComponent</code> instance that are
interested in events of type <code>eventClass</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/event/SystemEventListenerHolder.html#getListenersForEventClass-java.lang.Class-">getListenersForEventClass</a></code>&nbsp;in interface&nbsp;<code><a href="../../../jakarta/faces/event/SystemEventListenerHolder.html" title="interface in jakarta.faces.event">SystemEventListenerHolder</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getListenersForEventClass-java.lang.Class-">getListenersForEventClass</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>eventClass</code> - the <code>Class</code> of event for which the listeners must be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of listeners.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if argument <code>eventClass</code> is <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#processDecodes-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Apply Request
Values</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.
</p>
<ul>
<li>If the <code>rendered</code> property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is <code>false</code>, skip further
processing.</li>
<li class="changed_added_2_0">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>.</li>
<li>Call the <code>processDecodes()</code> method of all facets and children of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, in the
order determined by a call to <code>getFacetsAndChildren()</code>.</li>
<li>Call the <code>decode()</code> method of this component.</li>
<li>Call <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a> from inside of a <code>finally block, just before returning.</code></li>
<li>If a <code>RuntimeException</code> is thrown during decode processing, call <a href="../../../jakarta/faces/context/FacesContext.html#renderResponse--"><code>FacesContext.renderResponse()</code></a>
and re-throw the exception.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#processDecodes-jakarta.faces.context.FacesContext-">processDecodes</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> - <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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#processValidators-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0 changed_modified_2_3"><span class=
"changed_modified_2_0_rev_a">Perform</span></span> the component tree processing required by the <em>Process
Validations</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.
</p>
<ul>
<li>If the <code>rendered</code> property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is <code>false</code>, skip further
processing.</li>
<li class="changed_added_2_0">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>.</li>
<li>Call the <code>processValidators()</code> method of all facets and children of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, in the
order determined by a call to <code>getFacetsAndChildren()</code>.</li>
<li><span class="changed_modified_2_0_rev_a">After returning from calling <code>getFacetsAndChildren()</code> call
<a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a>.</span></li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#processValidators-jakarta.faces.context.FacesContext-">processValidators</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> - <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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#processUpdates-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Update Model
Values</em> phase of the request processing lifecycle for all facets of this component, all children of this
component, and this component itself, as follows.
</p>
<ul>
<li>If the <code>rendered</code> property of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> is <code>false</code>, skip further
processing.</li>
<li class="changed_added_2_0">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>.</li>
<li>Call the <code>processUpdates()</code> method of all facets and children of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a>, in the
order determined by a call to <code>getFacetsAndChildren()</code>. <span class="changed_added_2_0">After returning
from the <code>processUpdates()</code> method on a child or facet, call
<a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a></span></li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#processUpdates-jakarta.faces.context.FacesContext-">processUpdates</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> - <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="processSaveState-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processSaveState</h4>
<pre>public&nbsp;java.lang.Object&nbsp;processSaveState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#processSaveState-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the state saving portion
of the <em>Render Response</em> phase of the request processing lifecycle for all facets of this component, all
children of this component, and this component itself, as follows.
</p>
<ul>
<li>consult the <code>transient</code> property of this component. If true, just return <code>null</code>.</li>
<li class="changed_added_2_0">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>.</li>
<li>Call the <code>processSaveState()</code> method of all facets and children of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> in the
order determined by a call to <code>getFacetsAndChildren()</code>, skipping children and facets that are transient.
Ensure that <a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a> is called correctly after each child or facet.</li>
<li>Call the <code>saveState()</code> method of this component.</li>
<li>Encapsulate the child state and your state into a Serializable Object and return it.</li>
</ul>
<p>
This method may not be called if the state saving method is set to server.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#processSaveState-jakarta.faces.context.FacesContext-">processSaveState</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> - <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="returnLabel">Returns:</span></dt>
<dd>the saved state.</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="processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processRestoreState</h4>
<pre>public&nbsp;void&nbsp;processRestoreState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">UIComponent</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0">Perform</span> the component tree processing required by the <em>Restore View</em>
phase of the request processing lifecycle for all facets of this component, all children of this component, and this
component itself, as follows.
</p>
<ul>
<li class="changed_modified_2_0">Call the <code>restoreState()</code> method of this component.</li>
<li class="changed_added_2_0">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>.</li>
<li>Call the <code>processRestoreState()</code> method of all facets and children of this <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> in the
order determined by a call to <code>getFacetsAndChildren()</code>. <span class="changed_added_2_0">After returning
from the <code>processRestoreState()</code> method on a child or facet, call
<a href="../../../jakarta/faces/component/UIComponent.html#popComponentFromEL-jakarta.faces.context.FacesContext-"><code>UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)</code></a></span></li>
</ul>
<p>
This method may not be called if the state saving method is set to server.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#processRestoreState-jakarta.faces.context.FacesContext-java.lang.Object-">processRestoreState</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> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the request we are processing</dd>
<dd><code>state</code> - the state.</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="getFacesContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFacesContext</h4>
<pre>protected&nbsp;<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;getFacesContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getFacesContext--">UIComponent</a></code></span></div>
<div class="block"><p>
Convenience method to return the <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> instance for the current request.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getFacesContext--">getFacesContext</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 Faces context.</dd>
</dl>
</li>
</ul>
<a name="getRenderer-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenderer</h4>
<pre>protected&nbsp;<a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render">Renderer</a>&nbsp;getRenderer(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../jakarta/faces/component/UIComponent.html#getRenderer-jakarta.faces.context.FacesContext-">UIComponent</a></code></span></div>
<div class="block"><p>
Convenience method to return the <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> instance associated with this component, if any; otherwise, return
<code>null</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getRenderer-jakarta.faces.context.FacesContext-">getRenderer</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> - <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context"><code>FacesContext</code></a> for the current request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the renderer, or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="markInitialState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markInitialState</h4>
<pre>public&nbsp;void&nbsp;markInitialState()</pre>
<div class="block"><p class="changed_added_2_0">
For each of the attached objects on this instance that implement <a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component"><code>PartialStateHolder</code></a>, call
<a href="../../../jakarta/faces/component/PartialStateHolder.html#markInitialState--"><code>PartialStateHolder.markInitialState()</code></a> on the attached object.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/PartialStateHolder.html#markInitialState--">markInitialState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component">PartialStateHolder</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#markInitialState--">markInitialState</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="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="clearInitialState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearInitialState</h4>
<pre>public&nbsp;void&nbsp;clearInitialState()</pre>
<div class="block"><p class="changed_added_2_0">
For each of the attached objects on this instance that implement <a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component"><code>PartialStateHolder</code></a>, call
<a href="../../../jakarta/faces/component/PartialStateHolder.html#clearInitialState--"><code>PartialStateHolder.clearInitialState()</code></a> on the attached object.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/PartialStateHolder.html#clearInitialState--">clearInitialState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../jakarta/faces/component/PartialStateHolder.html" title="interface in jakarta.faces.component">PartialStateHolder</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#clearInitialState--">clearInitialState</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="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="saveState-jakarta.faces.context.FacesContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveState</h4>
<pre>public&nbsp;java.lang.Object&nbsp;saveState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../jakarta/faces/component/StateHolder.html#saveState-jakarta.faces.context.FacesContext-">StateHolder</a></code></span></div>
<div class="block"><p>
Gets the state of the instance as a <code>Serializable</code> Object.
</p>
<p>
If the class that implements this interface has references to instances that implement StateHolder (such as a
<code>UIComponent</code> with event handlers, validators, etc.) this method must call the <a href="../../../jakarta/faces/component/StateHolder.html#saveState-jakarta.faces.context.FacesContext-"><code>StateHolder.saveState(jakarta.faces.context.FacesContext)</code></a> method
on all those instances as well. <strong>This method must not save the state of children and facets.</strong> That is
done via the <a href="../../../jakarta/faces/application/StateManager.html" title="class in jakarta.faces.application"><code>StateManager</code></a>
</p>
<p>
This method must not alter the state of the implementing object. In other words, after executing this code:
</p>
<pre>
<code>
Object state = component.saveState(facesContext);
</code>
</pre>
<p>
<code>component</code> should be the same as before executing it.
</p>
<p>
The return from this method must be <code>Serializable</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the Faces context.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the saved state.</dd>
</dl>
</li>
</ul>
<a name="restoreState-jakarta.faces.context.FacesContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restoreState</h4>
<pre>public&nbsp;void&nbsp;restoreState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../jakarta/faces/component/StateHolder.html#restoreState-jakarta.faces.context.FacesContext-java.lang.Object-">StateHolder</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0_rev_a">Perform</span> any processing required to restore the state from the entries
in the state Object.
</p>
<p>
If the class that implements this interface has references to instances that also implement StateHolder (such as a
<code>UIComponent</code> with event handlers, validators, etc.) this method must call the <a href="../../../jakarta/faces/component/StateHolder.html#restoreState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>
method on all those instances as well.
</p>
<p class="changed_modified_2_0_rev_a">
If the <code>state</code> argument is <code>null</code>, take no action and return.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the Faces context.</dd>
<dd><code>state</code> - the state.</dd>
</dl>
</li>
</ul>
<a name="isTransient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTransient</h4>
<pre>public&nbsp;boolean&nbsp;isTransient()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../jakarta/faces/component/StateHolder.html#isTransient--">StateHolder</a></code></span></div>
<div class="block"><p>
If true, the Object implementing this interface must not participate in state saving or restoring.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if transient, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="setTransient-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransient</h4>
<pre>public&nbsp;void&nbsp;setTransient(boolean&nbsp;transientFlag)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../jakarta/faces/component/StateHolder.html#setTransient-boolean-">StateHolder</a></code></span></div>
<div class="block"><p>
<span class="changed_modified_2_0_rev_a">Denotes</span> whether or not the Object implementing this interface must or
must not participate in state saving or restoring.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transientFlag</code> - boolean pass <code>true</code> if this Object <span class="changed_modified_2_0_rev_a">will
not participate</span> in state saving or restoring, otherwise pass <code>false</code>.</dd>
</dl>
</li>
</ul>
<a name="saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveAttachedState</h4>
<pre>public static&nbsp;java.lang.Object&nbsp;saveAttachedState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;attachedObject)</pre>
<div class="block"><p class="changed_modified_2_0">
This method is called by <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> subclasses that want to save one or more attached objects. It is a
convenience method that does the work of saving attached objects that may or may not implement the
<a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component"><code>StateHolder</code></a> interface. Using this method implies the use of <a href="../../../jakarta/faces/component/UIComponentBase.html#restoreAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>restoreAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a> to restore the
attached objects.
</p>
<p>
This method supports saving attached objects of the following type: <code>Object</code>s, <code>null</code> values,
and <code
class="changed_modified_2_0">Collection</code>s of these objects. If any contained objects are not <code
class="changed_modified_2_0">Collection</code>s and do not implement <a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component"><code>StateHolder</code></a>, they must have
zero-argument public constructors. The exact structure of the returned object is undefined and opaque, but will be
serializable.
</p></div>
<dl>
<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 this request.</dd>
<dd><code>attachedObject</code> - the object, which may be a <code>List</code> instance, or an Object. The
<code>attachedObject</code> (or the elements that comprise <code>attachedObject</code> may implement
<a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component"><code>StateHolder</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state object to be saved.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the context argument is null.</dd>
</dl>
</li>
</ul>
<a name="restoreAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restoreAttachedState</h4>
<pre>public static&nbsp;java.lang.Object&nbsp;restoreAttachedState(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;context,
java.lang.Object&nbsp;stateObj)
throws java.lang.IllegalStateException</pre>
<div class="block"><p>
This method is called by <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> subclasses that need to restore the objects they saved using
<a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>. This method is tightly coupled with <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>.
</p>
<p>
This method supports restoring all attached objects types supported by <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>.
</p></div>
<dl>
<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 this request</dd>
<dd><code>stateObj</code> - the opaque object returned from <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object restored from <code>stateObj</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if context is null.</dd>
<dd><code>java.lang.IllegalStateException</code> - if the object is not previously returned by <a href="../../../jakarta/faces/component/UIComponentBase.html#saveAttachedState-jakarta.faces.context.FacesContext-java.lang.Object-"><code>saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)</code></a>.</dd>
</dl>
</li>
</ul>
<a name="addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addClientBehavior</h4>
<pre>public&nbsp;void&nbsp;addClientBehavior(java.lang.String&nbsp;eventName,
<a href="../../../jakarta/faces/component/behavior/ClientBehavior.html" title="interface in jakarta.faces.component.behavior">ClientBehavior</a>&nbsp;behavior)</pre>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#addClientBehavior-java.lang.String-jakarta.faces.component.behavior.ClientBehavior-"><code>ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)</code></a>.
<code>UIComponent</code> does not implement the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>
interface, but provides default implementations for the methods defined by
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> to simplify subclass implementations. Subclasses that
wish to support the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> contract must declare that the
subclass implements <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>, and must provide an implementation
of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getEventNames--"><code>ClientBehaviorHolder.getEventNames()</code></a>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>eventName</code> - the logical name of the client-side event to attach the behavior to.</dd>
<dd><code>behavior</code> - the <a href="../../../jakarta/faces/component/behavior/Behavior.html" title="interface in jakarta.faces.component.behavior"><code>Behavior</code></a> instance to attach for the specified event
name.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getEventNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventNames</h4>
<pre>public&nbsp;java.util.Collection&lt;java.lang.String&gt;&nbsp;getEventNames()</pre>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getEventNames--"><code>ClientBehaviorHolder.getEventNames()</code></a>.
<code>UIComponent</code> does not implement the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>
interface, but provides default implementations for the methods defined by
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> to simplify subclass implementations. Subclasses that
wish to support the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> contract must declare that the
subclass implements <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>, and must override this method to
return a non-Empty <code>Collection</code> of the client event names that the component supports.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the collection of event names.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getClientBehaviors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientBehaviors</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,java.util.List&lt;<a href="../../../jakarta/faces/component/behavior/ClientBehavior.html" title="interface in jakarta.faces.component.behavior">ClientBehavior</a>&gt;&gt;&nbsp;getClientBehaviors()</pre>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getClientBehaviors--"><code>ClientBehaviorHolder.getClientBehaviors()</code></a>.
<code>UIComponent</code> does not implement the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>
interface, but provides default implementations for the methods defined by
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> to simplify subclass implementations. Subclasses that
wish to support the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> contract must declare that the
subclass implements <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>, and must add an implementation of
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getEventNames--"><code>ClientBehaviorHolder.getEventNames()</code></a>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>behaviors associated with this component.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getDefaultEventName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultEventName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDefaultEventName()</pre>
<div class="block"><p class="changed_added_2_0">
This is a default implementation of
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getDefaultEventName--"><code>ClientBehaviorHolder.getDefaultEventName()</code></a>. <code>UIComponent</code> does not
implement the <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> interface, but provides default
implementations for the methods defined by <a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> to simplify
subclass implementations. Subclasses that wish to support the
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a> contract must declare that the subclass implements
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html" title="interface in jakarta.faces.component.behavior"><code>ClientBehaviorHolder</code></a>, and must provide an implementation of
<a href="../../../jakarta/faces/component/behavior/ClientBehaviorHolder.html#getEventNames--"><code>ClientBehaviorHolder.getEventNames()</code></a>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default event name.</dd>
</dl>
</li>
</ul>
<a name="getValueBinding-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueBinding</h4>
<pre>@Deprecated
public&nbsp;<a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el">ValueBinding</a>&nbsp;getValueBinding(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This has been replaced by <a href="../../../jakarta/faces/component/UIComponent.html#getValueExpression-java.lang.String-"><code>UIComponent.getValueExpression(java.lang.String)</code></a>.</span></div>
<div class="block"><p>
Call through to <a href="../../../jakarta/faces/component/UIComponent.html#getValueExpression-java.lang.String-"><code>UIComponent.getValueExpression(java.lang.String)</code></a> and examine the result. If the result is an instance of the wrapper class
mandated in <a href="../../../jakarta/faces/component/UIComponent.html#setValueBinding-java.lang.String-jakarta.faces.el.ValueBinding-"><code>UIComponent.setValueBinding(java.lang.String, jakarta.faces.el.ValueBinding)</code></a>, extract the <code>ValueBinding</code> instance and return it. Otherwise, wrap
the result in an implementation of <code>ValueBinding</code>, and return it.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#getValueBinding-java.lang.String-">getValueBinding</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>name</code> - Name of the attribute or property for which to retrieve a <a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el"><code>ValueBinding</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value binding.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>name</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="setValueBinding-java.lang.String-jakarta.faces.el.ValueBinding-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setValueBinding</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setValueBinding(java.lang.String&nbsp;name,
<a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el">ValueBinding</a>&nbsp;binding)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This has been replaced by <a href="../../../jakarta/faces/component/UIComponent.html#setValueExpression-java.lang.String-jakarta.el.ValueExpression-"><code>UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression)</code></a>.</span></div>
<div class="block"><p>
Wrap the argument <code>binding</code> in an implementation of <a href="../../../jakarta/el/ValueExpression.html" title="class in jakarta.el"><code>ValueExpression</code></a> and call through to
<a href="../../../jakarta/faces/component/UIComponent.html#setValueExpression-java.lang.String-jakarta.el.ValueExpression-"><code>UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression)</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/faces/component/UIComponent.html#setValueBinding-java.lang.String-jakarta.faces.el.ValueBinding-">setValueBinding</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>name</code> - Name of the attribute or property for which to set a <a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el"><code>ValueBinding</code></a></dd>
<dd><code>binding</code> - The <a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el"><code>ValueBinding</code></a> to set, or <code>null</code> to remove any currently set <a href="../../../jakarta/faces/el/ValueBinding.html" title="class in jakarta.faces.el"><code>ValueBinding</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>name</code> is one of <code>id</code> or <code>parent</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>name</code> is <code>null</code></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/UIComponent.html" title="class in jakarta.faces.component"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/component/UIData.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/UIComponentBase.html" target="_top">Frames</a></li>
<li><a href="UIComponentBase.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="#fields.inherited.from.class.jakarta.faces.component.UIComponent">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>Field&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>