Google Git
Sign in
apache / tomee-site-pub / b7c0eb72baa5f69bee564390518b556971e5f8a7 / . / jakartaee-9.1 / javadoc / jakarta / faces / event / SystemEventListenerHolder.html
blob: bd41ad328283e00f0986b59810f35882ef9b3842 [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>SystemEventListenerHolder</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="SystemEventListenerHolder";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/ValueChangeEvent.html" title="class 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/SystemEventListenerHolder.html" target="_top">Frames</a></li>
<li><a href="SystemEventListenerHolder.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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="Interface SystemEventListenerHolder" class="title">Interface SystemEventListenerHolder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../jakarta/faces/event/ExceptionQueuedEventContext.html" title="class in jakarta.faces.event">ExceptionQueuedEventContext</a>, <a href="../../../jakarta/faces/component/html/HtmlBody.html" title="class in jakarta.faces.component.html">HtmlBody</a>, <a href="../../../jakarta/faces/component/html/HtmlColumn.html" title="class in jakarta.faces.component.html">HtmlColumn</a>, <a href="../../../jakarta/faces/component/html/HtmlCommandButton.html" title="class in jakarta.faces.component.html">HtmlCommandButton</a>, <a href="../../../jakarta/faces/component/html/HtmlCommandLink.html" title="class in jakarta.faces.component.html">HtmlCommandLink</a>, <a href="../../../jakarta/faces/component/html/HtmlCommandScript.html" title="class in jakarta.faces.component.html">HtmlCommandScript</a>, <a href="../../../jakarta/faces/component/html/HtmlDataTable.html" title="class in jakarta.faces.component.html">HtmlDataTable</a>, <a href="../../../jakarta/faces/component/html/HtmlDoctype.html" title="class in jakarta.faces.component.html">HtmlDoctype</a>, <a href="../../../jakarta/faces/component/html/HtmlForm.html" title="class in jakarta.faces.component.html">HtmlForm</a>, <a href="../../../jakarta/faces/component/html/HtmlGraphicImage.html" title="class in jakarta.faces.component.html">HtmlGraphicImage</a>, <a href="../../../jakarta/faces/component/html/HtmlHead.html" title="class in jakarta.faces.component.html">HtmlHead</a>, <a href="../../../jakarta/faces/component/html/HtmlInputFile.html" title="class in jakarta.faces.component.html">HtmlInputFile</a>, <a href="../../../jakarta/faces/component/html/HtmlInputHidden.html" title="class in jakarta.faces.component.html">HtmlInputHidden</a>, <a href="../../../jakarta/faces/component/html/HtmlInputSecret.html" title="class in jakarta.faces.component.html">HtmlInputSecret</a>, <a href="../../../jakarta/faces/component/html/HtmlInputText.html" title="class in jakarta.faces.component.html">HtmlInputText</a>, <a href="../../../jakarta/faces/component/html/HtmlInputTextarea.html" title="class in jakarta.faces.component.html">HtmlInputTextarea</a>, <a href="../../../jakarta/faces/component/html/HtmlMessage.html" title="class in jakarta.faces.component.html">HtmlMessage</a>, <a href="../../../jakarta/faces/component/html/HtmlMessages.html" title="class in jakarta.faces.component.html">HtmlMessages</a>, <a href="../../../jakarta/faces/component/html/HtmlOutcomeTargetButton.html" title="class in jakarta.faces.component.html">HtmlOutcomeTargetButton</a>, <a href="../../../jakarta/faces/component/html/HtmlOutcomeTargetLink.html" title="class in jakarta.faces.component.html">HtmlOutcomeTargetLink</a>, <a href="../../../jakarta/faces/component/html/HtmlOutputFormat.html" title="class in jakarta.faces.component.html">HtmlOutputFormat</a>, <a href="../../../jakarta/faces/component/html/HtmlOutputLabel.html" title="class in jakarta.faces.component.html">HtmlOutputLabel</a>, <a href="../../../jakarta/faces/component/html/HtmlOutputLink.html" title="class in jakarta.faces.component.html">HtmlOutputLink</a>, <a href="../../../jakarta/faces/component/html/HtmlOutputText.html" title="class in jakarta.faces.component.html">HtmlOutputText</a>, <a href="../../../jakarta/faces/component/html/HtmlPanelGrid.html" title="class in jakarta.faces.component.html">HtmlPanelGrid</a>, <a href="../../../jakarta/faces/component/html/HtmlPanelGroup.html" title="class in jakarta.faces.component.html">HtmlPanelGroup</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectBooleanCheckbox.html" title="class in jakarta.faces.component.html">HtmlSelectBooleanCheckbox</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectManyCheckbox.html" title="class in jakarta.faces.component.html">HtmlSelectManyCheckbox</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectManyListbox.html" title="class in jakarta.faces.component.html">HtmlSelectManyListbox</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectManyMenu.html" title="class in jakarta.faces.component.html">HtmlSelectManyMenu</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectOneListbox.html" title="class in jakarta.faces.component.html">HtmlSelectOneListbox</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectOneMenu.html" title="class in jakarta.faces.component.html">HtmlSelectOneMenu</a>, <a href="../../../jakarta/faces/component/html/HtmlSelectOneRadio.html" title="class in jakarta.faces.component.html">HtmlSelectOneRadio</a>, <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/UIComponent.html" title="class in jakarta.faces.component">UIComponent</a>, <a href="../../../jakarta/faces/component/UIComponentBase.html" title="class in jakarta.faces.component">UIComponentBase</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/UIInput.html" title="class in jakarta.faces.component">UIInput</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/UIOutcomeTarget.html" title="class in jakarta.faces.component">UIOutcomeTarget</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/UISelectBoolean.html" title="class in jakarta.faces.component">UISelectBoolean</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/UISelectMany.html" title="class in jakarta.faces.component">UISelectMany</a>, <a href="../../../jakarta/faces/component/UISelectOne.html" title="class in jakarta.faces.component">UISelectOne</a>, <a href="../../../jakarta/faces/component/UIViewAction.html" title="class in jakarta.faces.component">UIViewAction</a>, <a href="../../../jakarta/faces/component/UIViewParameter.html" title="class in jakarta.faces.component">UIViewParameter</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 interface <span class="typeNameLabel">SystemEventListenerHolder</span></pre>
<div class="block"><p class="changed_added_2_0">
Classes that implement this interface agree to maintain a list of <a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event"><code>SystemEventListener</code></a> instances for each kind
of <a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event"><code>SystemEvent</code></a> they can generate. This interface enables arbitrary Objects to act as the source for
<a href="../../../jakarta/faces/event/SystemEvent.html" title="class in jakarta.faces.event"><code>SystemEvent</code></a> instances.
</p>
<p>
If the implementing class is a <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> or is referenced by a
<code>UIComponent</code>, care must be taken to ensure that the implementing class, and all the members of the list
returned by <a href="../../../jakarta/faces/event/SystemEventListenerHolder.html#getListenersForEventClass-java.lang.Class-"><code>getListenersForEventClass(java.lang.Class&lt;? extends jakarta.faces.event.SystemEvent&gt;)</code></a> work correctly with the state management system. One way to ensure
this is to have the class and the list members implement <a href="../../../jakarta/faces/component/StateHolder.html" title="interface in jakarta.faces.component"><code>StateHolder</code></a> or
<code>Serializable</code>.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.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/event/SystemEventListenerHolder.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;facesEventClass)</code>
<div class="block"><div class="changed_added_2_0"></div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getListenersForEventClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getListenersForEventClass</h4>
<pre>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;facesEventClass)</pre>
<div class="block"><div class="changed_added_2_0">
<p>
Return a <code>List</code> of <a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event"><code>SystemEventListener</code></a> instances that have been installed into the class
implementing this interface.
</p>
</div></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>facesEventClass</code> - the class for which listeners are to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the listeners for the argument class</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/SystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/faces/event/ValueChangeEvent.html" title="class 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/SystemEventListenerHolder.html" target="_top">Frames</a></li>
<li><a href="SystemEventListenerHolder.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>