| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ActionListener</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="ActionListener"; |
| } |
| } |
| 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/ActionEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/event/ActionListenerWrapper.html" title="class in jakarta.faces.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/event/ActionListener.html" target="_top">Frames</a></li> |
| <li><a href="ActionListener.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="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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 ActionListener" class="title">Interface ActionListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.util.EventListener, <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../jakarta/faces/event/ActionListenerWrapper.html" title="class in jakarta.faces.event">ActionListenerWrapper</a>, <a href="../../../jakarta/faces/event/MethodExpressionActionListener.html" title="class in jakarta.faces.event">MethodExpressionActionListener</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ActionListener</span> |
| extends <a href="../../../jakarta/faces/event/FacesListener.html" title="interface in jakarta.faces.event">FacesListener</a></pre> |
| <div class="block"><p> |
| <span class="changed_modified_2_0 changed_modified_2_2">A</span> listener interface for receiving |
| <a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event"><code>ActionEvent</code></a>s. <span class="changed_added_2_0">An implementation of this interface must be thread-safe.</span> |
| A class that is interested in receiving such events implements this interface, and then registers itself with the |
| source <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> of interest, by calling <code>addActionListener()</code>. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/ActionListener.html#TO_FLOW_DOCUMENT_ID_ATTR_NAME">TO_FLOW_DOCUMENT_ID_ATTR_NAME</a></span></code> |
| <div class="block"><p class="changed_added_2_2"> |
| The presence of this component attribute on an <a href="../../../jakarta/faces/component/ActionSource.html" title="interface in jakarta.faces.component"><code>ActionSource</code></a> component will cause the |
| default <code>ActionListener</code> to interpret the value of the attribute as the <em>toFlowDocumentId</em> value to pass |
| to |
| <a href="../../../jakarta/faces/application/NavigationHandler.html#handleNavigation-jakarta.faces.context.FacesContext-java.lang.String-java.lang.String-java.lang.String-"><code>NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String)</code></a>.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/event/ActionListener.html#processAction-jakarta.faces.event.ActionEvent-">processAction</a></span>(<a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event">ActionEvent</a> event)</code> |
| <div class="block"> |
| Invoked when the action described by the specified <a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event"><code>ActionEvent</code></a> occurs.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="TO_FLOW_DOCUMENT_ID_ATTR_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TO_FLOW_DOCUMENT_ID_ATTR_NAME</h4> |
| <pre>static final java.lang.String TO_FLOW_DOCUMENT_ID_ATTR_NAME</pre> |
| <div class="block"><p class="changed_added_2_2"> |
| The presence of this component attribute on an <a href="../../../jakarta/faces/component/ActionSource.html" title="interface in jakarta.faces.component"><code>ActionSource</code></a> component will cause the |
| default <code>ActionListener</code> to interpret the value of the attribute as the <em>toFlowDocumentId</em> value to pass |
| to |
| <a href="../../../jakarta/faces/application/NavigationHandler.html#handleNavigation-jakarta.faces.context.FacesContext-java.lang.String-java.lang.String-java.lang.String-"><code>NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.faces.event.ActionListener.TO_FLOW_DOCUMENT_ID_ATTR_NAME">Constant Field Values</a></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="processAction-jakarta.faces.event.ActionEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>processAction</h4> |
| <pre>void processAction(<a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event">ActionEvent</a> event) |
| throws <a href="../../../jakarta/faces/event/AbortProcessingException.html" title="class in jakarta.faces.event">AbortProcessingException</a></pre> |
| <div class="block"><p> |
| Invoked when the action described by the specified <a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event"><code>ActionEvent</code></a> occurs. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - The <a href="../../../jakarta/faces/event/ActionEvent.html" title="class in jakarta.faces.event"><code>ActionEvent</code></a> that has occurred</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 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/ActionEvent.html" title="class in jakarta.faces.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/faces/event/ActionListenerWrapper.html" title="class in jakarta.faces.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/event/ActionListener.html" target="_top">Frames</a></li> |
| <li><a href="ActionListener.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="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
