| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>jakarta.faces.application</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="jakarta.faces.application"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/annotation/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../jakarta/faces/bean/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/application/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package jakarta.faces.application</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/Application.html" title="class in jakarta.faces.application">Application</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <strong class="changed_modified_2_0 changed_modified_2_0_rev_a changed_modified_2_2 |
| changed_modified_2_3">Application</strong> represents a per-web-application singleton object where applications based |
| on Jakarta Server Faces (or implementations wishing to provide extended functionality) can register application-wide |
| singletons that provide functionality required by Jakarta Server Faces.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ApplicationConfigurationPopulator.html" title="class in jakarta.faces.application">ApplicationConfigurationPopulator</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| This class defines a <code>java.util.ServiceLoader</code> service which enables programmatic configuration of the Jakarta |
| Server Faces runtime using the existing Application Configuration Resources schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ApplicationFactory.html" title="class in jakarta.faces.application">ApplicationFactory</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <strong class="changed_modified_2_0 changed_modified_2_3">ApplicationFactory</strong> is a factory object that |
| creates (if needed) and returns <a href="../../../jakarta/faces/application/Application.html" title="class in jakarta.faces.application"><code>Application</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ApplicationWrapper.html" title="class in jakarta.faces.application">ApplicationWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <span class="changed_modified_2_2">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/Application.html" title="class in jakarta.faces.application"><code>Application</code></a> that can be |
| subclassed by developers wishing to provide specialized behavior to an existing <a href="../../../jakarta/faces/application/Application.html" title="class in jakarta.faces.application"><code>Application</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ConfigurableNavigationHandler.html" title="class in jakarta.faces.application">ConfigurableNavigationHandler</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <strong class="changed_modified_2_2">ConfigurableNavigationHandler</strong> extends the contract of |
| <a href="../../../jakarta/faces/application/NavigationHandler.html" title="class in jakarta.faces.application"><code>NavigationHandler</code></a> to allow runtime inspection of the <a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application"><code>NavigationCase</code></a>s that make up the rule-base for |
| navigation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ConfigurableNavigationHandlerWrapper.html" title="class in jakarta.faces.application">ConfigurableNavigationHandlerWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| <span class="changed_modified_2_3">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/ConfigurableNavigationHandler.html" title="class in jakarta.faces.application"><code>ConfigurableNavigationHandler</code></a> |
| that can be subclassed by developers wishing to provide specialized behavior to an existing |
| <a href="../../../jakarta/faces/application/ConfigurableNavigationHandler.html" title="class in jakarta.faces.application"><code>ConfigurableNavigationHandler</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/FacesMessage.html" title="class in jakarta.faces.application">FacesMessage</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <strong>FacesMessage</strong> represents a single validation (or other) message, which is typically associated with a |
| particular component in the view.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/FacesMessage.Severity.html" title="class in jakarta.faces.application">FacesMessage.Severity</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Class used to represent message severity levels in a typesafe enumeration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application">NavigationCase</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <strong class="changed_modified_2_2"> NavigationCase</strong> represents a <code><navigation-case></code> in |
| the navigation rule base, as well as the <span class="changed_modified_2_2"><code><from-view-id></code> with |
| which this <code><navigation-case></code> is a sibling</span>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/NavigationCaseWrapper.html" title="class in jakarta.faces.application">NavigationCaseWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| <span class="changed_modified_2_3">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application"><code>NavigationCase</code></a> that can be |
| subclassed by developers wishing to provide specialized behavior to an existing <a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application"><code>NavigationCase</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/NavigationHandler.html" title="class in jakarta.faces.application">NavigationHandler</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <span class="changed_modified_2_0 changed_modified_2_2">A</span> <strong>NavigationHandler</strong> is passed the |
| outcome string returned by an application action invoked for this application, and will use this (along with related |
| state information) to choose the view to be displayed next.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/NavigationHandlerWrapper.html" title="class in jakarta.faces.application">NavigationHandlerWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| <strong class="changed_modified_2_3">NavigationHandlerWrapper</strong> provides a simple implementation of |
| <a href="../../../jakarta/faces/application/NavigationHandler.html" title="class in jakarta.faces.application"><code>NavigationHandler</code></a> that can be subclassed by developers wishing to provide specialized behavior to an existing |
| <a href="../../../jakarta/faces/application/NavigationHandler.html" title="class in jakarta.faces.application"><code>NavigationHandler</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/Resource.html" title="class in jakarta.faces.application">Resource</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <span class="changed_modified_2_1 changed_modified_2_2 changed_modified_2_3">An</span> instance of |
| <code>Resource</code> is a Java object representation of the artifact that is served up in response to a <i>resource |
| request</i> from the client.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceHandler.html" title="class in jakarta.faces.application">ResourceHandler</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <strong class="changed_modified_2_0_rev_a changed_modified_2_2 changed_modified_2_3">ResourceHandler</strong> is the |
| run-time API by which <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> and <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> |
| instances<span class="changed_added_2_2">, and the <a href="../../../jakarta/faces/view/ViewDeclarationLanguage.html" title="class in jakarta.faces.view"><code>ViewDeclarationLanguage</code></a> can reference |
| <a href="../../../jakarta/faces/application/Resource.html" title="class in jakarta.faces.application"><code>Resource</code></a> instances.</span> An implementation of this class must be thread-safe.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceHandlerWrapper.html" title="class in jakarta.faces.application">ResourceHandlerWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <span class="changed_modified_2_0_rev_a changed_modified_2_2 changed_modified_2_3">Provides</span> a simple |
| implementation of <a href="../../../jakarta/faces/application/ResourceHandler.html" title="class in jakarta.faces.application"><code>ResourceHandler</code></a> that can be subclassed by developers wishing to provide specialized |
| behavior to an existing <a href="../../../jakarta/faces/application/ResourceHandler.html" title="class in jakarta.faces.application"><code>ResourceHandler</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceWrapper.html" title="class in jakarta.faces.application">ResourceWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| <span class="changed_modified_2_2 changed_modified_2_3">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/Resource.html" title="class in jakarta.faces.application"><code>Resource</code></a> |
| that can be subclassed by developers wishing to provide specialized behavior to an existing <a href="../../../jakarta/faces/application/Resource.html" title="class in jakarta.faces.application"><code>Resource</code></a> |
| instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/StateManager.html" title="class in jakarta.faces.application">StateManager</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <strong class="changed_modified_2_0 changed_modified_2_1 changed_modified_2_2 |
| changed_modified_2_3">StateManager</strong> directs the process of saving and restoring the view between requests.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/StateManagerWrapper.html" title="class in jakarta.faces.application">StateManagerWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <span class="changed_modified_2_3">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/StateManager.html" title="class in jakarta.faces.application"><code>StateManager</code></a> that can be |
| subclassed by developers wishing to provide specialized behavior to an existing <a href="../../../jakarta/faces/application/StateManager.html" title="class in jakarta.faces.application"><code>StateManager</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ViewHandler.html" title="class in jakarta.faces.application">ViewHandler</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| <strong><span class="changed_modified_2_0 changed_modified_2_1 changed_modified_2_2 changed_modified_2_3"> |
| ViewHandler</span></strong> is the pluggablity mechanism for allowing implementations of or applications using the |
| JJakarta Server Faces specification to provide their own handling of the activities in the <em>Render Response</em> |
| and <em>Restore View</em> phases of the request processing lifecycle.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ViewHandlerWrapper.html" title="class in jakarta.faces.application">ViewHandlerWrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_modified_2_2"> |
| <span class="changed_modified_2_3">Provides</span> a simple implementation of <a href="../../../jakarta/faces/application/ViewHandler.html" title="class in jakarta.faces.application"><code>ViewHandler</code></a> that can be |
| subclassed by developers wishing to provide specialized behavior to an existing <a href="../../../jakarta/faces/application/ViewHandler.html" title="class in jakarta.faces.application"><code>ViewHandler</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ViewResource.html" title="class in jakarta.faces.application">ViewResource</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| Superclass of <a href="../../../jakarta/faces/application/Resource.html" title="class in jakarta.faces.application"><code>Resource</code></a> that is only for use with views.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ProjectStage.html" title="enum in jakarta.faces.application">ProjectStage</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| This class enables a feature similar to the <code>RAILS_ENV</code> feature of the Ruby on Rails web framework.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceVisitOption.html" title="enum in jakarta.faces.application">ResourceVisitOption</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_3"> |
| Defines the resource traversal options.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ViewVisitOption.html" title="enum in jakarta.faces.application">ViewVisitOption</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_3"> |
| Defines the view traversal options.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ProtectedViewException.html" title="class in jakarta.faces.application">ProtectedViewException</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_2"> |
| This exception is thrown by the runtime when a violation of the view protection mechanism is encountered.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ViewExpiredException.html" title="class in jakarta.faces.application">ViewExpiredException</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Implementations must throw this <a href="../../../jakarta/faces/FacesException.html" title="class in jakarta.faces"><code>FacesException</code></a> when attempting to restore the view |
| <a href="../../../jakarta/faces/application/StateManager.html#restoreView-jakarta.faces.context.FacesContext-java.lang.String-java.lang.String-"><code>StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)</code></a> results in failure on postback.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceDependencies.html" title="annotation in jakarta.faces.application">ResourceDependencies</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| Container annotation to specify multiple <a href="../../../jakarta/faces/application/ResourceDependency.html" title="annotation in jakarta.faces.application"><code>ResourceDependency</code></a> annotations on a single class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/faces/application/ResourceDependency.html" title="annotation in jakarta.faces.application">ResourceDependency</a></td> |
| <td class="colLast"> |
| <div class="block"><p class="changed_added_2_0"> |
| Instances of <a href="../../../jakarta/faces/component/UIComponent.html" title="class in jakarta.faces.component"><code>UIComponent</code></a> or <a href="../../../jakarta/faces/render/Renderer.html" title="class in jakarta.faces.render"><code>Renderer</code></a> that have this |
| annotation (or <a href="../../../jakarta/faces/application/ResourceDependencies.html" title="annotation in jakarta.faces.application"><code>ResourceDependencies</code></a> attached at the class level will automatically have a resource dependency |
| added so that the named resource will be present in user agent's view of the <code>UIViewRoot</code> in which this |
| component or renderer is used.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/annotation/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../jakarta/faces/bean/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/faces/application/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
