Google Git
Sign in
apache / tomee-site-pub / d63ad4575738d0254e721c23504f9337b87b8f69 / . / jakartaee-9.1 / javadoc / jakarta / faces / event / ComponentSystemEvent.html
blob: cc28d2f01a56d3332d6fb5a00362e470fee72ee4 [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>ComponentSystemEvent</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="ComponentSystemEvent";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/faces/event/BehaviorListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/event/ComponentSystemEvent.html" target="_top">Frames</a></li>
<li><a href="ComponentSystemEvent.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.java.util.EventObject">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.event</div>
<h2 title="Class ComponentSystemEvent" class="title">Class ComponentSystemEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.EventObject</li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">jakarta.faces.event.SystemEvent</a></li>
<li>
<ul class="inheritance">
<li>jakarta.faces.event.ComponentSystemEvent</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../jakarta/faces/event/PostAddToViewEvent.html" title="class in jakarta.faces.event">PostAddToViewEvent</a>, <a href="../../../jakarta/faces/event/PostConstructViewMapEvent.html" title="class in jakarta.faces.event">PostConstructViewMapEvent</a>, <a href="../../../jakarta/faces/event/PostRenderViewEvent.html" title="class in jakarta.faces.event">PostRenderViewEvent</a>, <a href="../../../jakarta/faces/event/PostRestoreStateEvent.html" title="class in jakarta.faces.event">PostRestoreStateEvent</a>, <a href="../../../jakarta/faces/event/PostValidateEvent.html" title="class in jakarta.faces.event">PostValidateEvent</a>, <a href="../../../jakarta/faces/event/PreDestroyViewMapEvent.html" title="class in jakarta.faces.event">PreDestroyViewMapEvent</a>, <a href="../../../jakarta/faces/event/PreRemoveFromViewEvent.html" title="class in jakarta.faces.event">PreRemoveFromViewEvent</a>, <a href="../../../jakarta/faces/event/PreRenderComponentEvent.html" title="class in jakarta.faces.event">PreRenderComponentEvent</a>, <a href="../../../jakarta/faces/event/PreRenderViewEvent.html" title="class in jakarta.faces.event">PreRenderViewEvent</a>, <a href="../../../jakarta/faces/event/PreValidateEvent.html" title="class in jakarta.faces.event">PreValidateEvent</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ComponentSystemEvent</span>
extends <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a></pre>
<div class="block"><p>
<strong class="changed_added_2_0 changed_modified_2_2"> ComponentSystemEvent</strong> is the base class for
<a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event"><code>SystemEvent</code></a>s that are specific to a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> instance.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#jakarta.faces.event.ComponentSystemEvent">Serialized Form</a></dd>
</dl>
</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.java.util.EventObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;java.util.EventObject</h3>
<code>source</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/event/ComponentSystemEvent.html#ComponentSystemEvent-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">ComponentSystemEvent</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;facesContext,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</code>
<div class="block"><p class="changed_added_2_3">
Pass the argument <code>component</code> to the superclass constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/ComponentSystemEvent.html#ComponentSystemEvent-jakarta.faces.component.UIComponent-">ComponentSystemEvent</a></span>(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</code>
<div class="block"><p class="changed_added_2_0">
Pass the argument <code>component</code> to the superclass constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><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/event/ComponentSystemEvent.html#getComponent--">getComponent</a></span>()</code>
<div class="block"><p class="changed_added_2_0">
the source <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> that sent this event.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/ComponentSystemEvent.html#isAppropriateListener-jakarta.faces.event.FacesListener-">isAppropriateListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</code>
<div class="block"><p class="changed_added_2_2">
Return <code>true</code> if the argument <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> is an instance of the appropriate listener class that
this event supports.</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/event/ComponentSystemEvent.html#processListener-jakarta.faces.event.FacesListener-">processListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</code>
<div class="block"><p class="changed_added_2_2">
Broadcast this event instance to the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> by calling the superclass's
<code>processListener()</code> implementation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.faces.event.SystemEvent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.faces.event.<a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a></h3>
<code><a href="../../../jakarta/faces/event/SystemEvent.html#getFacesContext--">getFacesContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.util.EventObject</h3>
<code>getSource, toString</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, 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="ComponentSystemEvent-jakarta.faces.component.UIComponent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComponentSystemEvent</h4>
<pre>public&nbsp;ComponentSystemEvent(<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</pre>
<div class="block"><p class="changed_added_2_0">
Pass the argument <code>component</code> to the superclass constructor.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>component</code> - the <code>UIComponent</code> reference to be passed to the superclass constructor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the argument is <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="ComponentSystemEvent-jakarta.faces.context.FacesContext-jakarta.faces.component.UIComponent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ComponentSystemEvent</h4>
<pre>public&nbsp;ComponentSystemEvent(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a>&nbsp;facesContext,
<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;component)</pre>
<div class="block"><p class="changed_added_2_3">
Pass the argument <code>component</code> to the superclass constructor.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>facesContext</code> - the Faces context.</dd>
<dd><code>component</code> - the <code>UIComponent</code> reference to be passed to the superclass constructor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the argument is <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isAppropriateListener-jakarta.faces.event.FacesListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAppropriateListener</h4>
<pre>public&nbsp;boolean&nbsp;isAppropriateListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</pre>
<div class="block"><p class="changed_added_2_2">
Return <code>true</code> if the argument <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> is an instance of the appropriate listener class that
this event supports. The default implementation returns true if the listener is a
<a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><code>ComponentSystemEventListener</code></a> or if <code>super.isAppropriateListener()</code> returns true.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/event/SystemEvent.html#isAppropriateListener-jakarta.faces.event.FacesListener-">isAppropriateListener</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to evaluate</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result as specified above</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="processListener-jakarta.faces.event.FacesListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processListener</h4>
<pre>public&nbsp;void&nbsp;processListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a>&nbsp;listener)</pre>
<div class="block"><p class="changed_added_2_2">
Broadcast this event instance to the specified <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> by calling the superclass's
<code>processListener()</code> implementation.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../jakarta/faces/event/SystemEvent.html#processListener-jakarta.faces.event.FacesListener-">processListener</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event">SystemEvent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> to evaluate</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getComponent--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getComponent</h4>
<pre>public&nbsp;<a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>&nbsp;getComponent()</pre>
<div class="block"><p class="changed_added_2_0">
the source <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> that sent this event.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the component for this event</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</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/event/BehaviorListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/ComponentSystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/event/ComponentSystemEvent.html" target="_top">Frames</a></li>
<li><a href="ComponentSystemEvent.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.java.util.EventObject">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>