| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SystemEvent</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="SystemEvent"; |
| } |
| } |
| 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/ScopeContext.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/event/SystemEvent.html" target="_top">Frames</a></li> |
| <li><a href="SystemEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.java.util.EventObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 SystemEvent" class="title">Class SystemEvent</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>jakarta.faces.event.SystemEvent</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/ComponentSystemEvent.html" title="class in jakarta.faces.event">ComponentSystemEvent</a>, <a href="../../../jakarta/faces/event/ExceptionQueuedEvent.html" title="class in jakarta.faces.event">ExceptionQueuedEvent</a>, <a href="../../../jakarta/faces/event/PostConstructApplicationEvent.html" title="class in jakarta.faces.event">PostConstructApplicationEvent</a>, <a href="../../../jakarta/faces/event/PostConstructCustomScopeEvent.html" title="class in jakarta.faces.event">PostConstructCustomScopeEvent</a>, <a href="../../../jakarta/faces/event/PostKeepFlashValueEvent.html" title="class in jakarta.faces.event">PostKeepFlashValueEvent</a>, <a href="../../../jakarta/faces/event/PostPutFlashValueEvent.html" title="class in jakarta.faces.event">PostPutFlashValueEvent</a>, <a href="../../../jakarta/faces/event/PreClearFlashEvent.html" title="class in jakarta.faces.event">PreClearFlashEvent</a>, <a href="../../../jakarta/faces/event/PreDestroyApplicationEvent.html" title="class in jakarta.faces.event">PreDestroyApplicationEvent</a>, <a href="../../../jakarta/faces/event/PreDestroyCustomScopeEvent.html" title="class in jakarta.faces.event">PreDestroyCustomScopeEvent</a>, <a href="../../../jakarta/faces/event/PreRemoveFlashValueEvent.html" title="class in jakarta.faces.event">PreRemoveFlashValueEvent</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">SystemEvent</span> |
| extends java.util.EventObject</pre> |
| <div class="block"><p> |
| <strong class="changed_added_2_0 changed_modified_2_2">SystemEvent</strong> is the base class for non-application |
| specific events that can be fired by arbitrary objects. |
| </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.SystemEvent">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 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"> </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/SystemEvent.html#SystemEvent-jakarta.faces.context.FacesContext-java.lang.Object-">SystemEvent</a></span>(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a> facesContext, |
| java.lang.Object source)</code> |
| <div class="block"><p class="changed_added_2_3"> |
| Pass the argument <code>source</code> to the superclass constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/SystemEvent.html#SystemEvent-java.lang.Object-">SystemEvent</a></span>(java.lang.Object source)</code> |
| <div class="block"><p class="changed_added_2_0"> |
| Pass the argument <code>source</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/SystemEvent.html#getFacesContext--">getFacesContext</a></span>()</code> |
| <div class="block"><p class="changed_added_2_3"> |
| Get the Faces context.</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/SystemEvent.html#isAppropriateListener-jakarta.faces.event.FacesListener-">isAppropriateListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a> listener)</code> |
| <div class="block"> |
| <span class="changed_modified_2_2">Return</span> <code>true</code> if this <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> is an instance of a |
| 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/SystemEvent.html#processListener-jakarta.faces.event.FacesListener-">processListener</a></span>(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a> listener)</code> |
| <div class="block"> |
| 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 whatever mechanism is appropriate.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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 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="SystemEvent-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SystemEvent</h4> |
| <pre>public SystemEvent(java.lang.Object source)</pre> |
| <div class="block"><p class="changed_added_2_0"> |
| Pass the argument <code>source</code> to the superclass constructor. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the <code>source</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="SystemEvent-jakarta.faces.context.FacesContext-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SystemEvent</h4> |
| <pre>public SystemEvent(<a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a> facesContext, |
| java.lang.Object source)</pre> |
| <div class="block"><p class="changed_added_2_3"> |
| Pass the argument <code>source</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>source</code> - the <code>source</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> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFacesContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFacesContext</h4> |
| <pre>public <a href="../../../jakarta/faces/context/FacesContext.html" title="class in jakarta.faces.context">FacesContext</a> getFacesContext()</pre> |
| <div class="block"><p class="changed_added_2_3"> |
| Get the Faces context. |
| </p> |
| |
| <p> |
| If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and |
| return it. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Faces context.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAppropriateListener-jakarta.faces.event.FacesListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAppropriateListener</h4> |
| <pre>public boolean isAppropriateListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a> listener)</pre> |
| <div class="block"><p> |
| <span class="changed_modified_2_2">Return</span> <code>true</code> if this <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event"><code>FacesListener</code></a> is an instance of a |
| the appropriate listener class that this event supports. <span class="changed_added_2_2">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>.</span> |
| </p></div> |
| <dl> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="processListener-jakarta.faces.event.FacesListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>processListener</h4> |
| <pre>public void processListener(<a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a> listener)</pre> |
| <div class="block"><p> |
| 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 whatever mechanism is appropriate. |
| Typically, this will be accomplished by calling an event processing method, and passing this instance as a parameter. |
| </p></div> |
| <dl> |
| <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 send this <a href="../../../jakarta/faces/event/FacesEvent.html" title="class in jakarta.faces.event"><code>FacesEvent</code></a> to</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> |
| </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/ScopeContext.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/event/SystemEventListener.html" title="interface in jakarta.faces.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/event/SystemEvent.html" target="_top">Frames</a></li> |
| <li><a href="SystemEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.java.util.EventObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |