Uses of Class
jakarta.faces.context.FacesContext
-
Packages that use FacesContext Package Description jakarta.faces.application jakarta.faces.component jakarta.faces.component.behavior jakarta.faces.component.html Specialized user interface component classes for HTML.jakarta.faces.component.search jakarta.faces.component.visit jakarta.faces.context jakarta.faces.convert jakarta.faces.event jakarta.faces.flow jakarta.faces.lifecycle jakarta.faces.render jakarta.faces.validator jakarta.faces.view jakarta.faces.view.facelets -
-
Uses of FacesContext in jakarta.faces.application
Methods in jakarta.faces.application with parameters of type FacesContext Modifier and Type Method Description StringViewHandler. calculateCharacterEncoding(FacesContext context)Returns the correct character encoding to be used for this request.StringViewHandlerWrapper. calculateCharacterEncoding(FacesContext context)The default behavior of this method is to callViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)on the wrappedViewHandlerobject.abstract LocaleViewHandler. calculateLocale(FacesContext context)Returns an appropriateLocaleto use for this and subsequent requests for the current client.LocaleViewHandlerWrapper. calculateLocale(FacesContext context)The default behavior of this method is to callViewHandler.calculateLocale(jakarta.faces.context.FacesContext)on the wrappedViewHandlerobject.abstract StringViewHandler. calculateRenderKitId(FacesContext context)Return an appropriaterenderKitIdfor this and subsequent requests from the current client.StringViewHandlerWrapper. calculateRenderKitId(FacesContext context)The default behavior of this method is to callViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)on the wrappedViewHandlerobject.UIComponentApplication. createComponent(ValueExpression componentExpression, FacesContext context, String componentType)UIComponentApplication. createComponent(ValueExpression componentExpression, FacesContext context, String componentType, String rendererType)LikeApplication.createComponent(ValueExpression, FacesContext, String)except theRendererfor the component to be returned must be inspected for the annotations mentioned inApplication.createComponent(ValueExpression, FacesContext, String)as specified in the documentation for that method.UIComponentApplication. createComponent(FacesContext context, Resource componentResource)UIComponentApplication. createComponent(FacesContext context, String componentType, String rendererType)LikeApplication.createComponent(String)except theRendererfor the component to be returned must be inspected for the annotations mentioned inApplication.createComponent(ValueExpression, FacesContext, String)as specified in the documentation for that method.UIComponentApplicationWrapper. createComponent(ValueExpression componentExpression, FacesContext context, String componentType)The default behavior of this method is to callApplication.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String)on the wrappedApplicationobject.UIComponentApplicationWrapper. createComponent(ValueExpression componentExpression, FacesContext context, String componentType, String rendererType)The default behavior of this method is to callApplication.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String)on the wrappedApplicationobject.UIComponentApplicationWrapper. createComponent(FacesContext context, Resource componentResource)The default behavior of this method is to callApplication.createComponent(jakarta.faces.context.FacesContext, Resource)on the wrappedApplicationobject.UIComponentApplicationWrapper. createComponent(FacesContext context, String componentType, String rendererType)The default behavior of this method is to callApplication.createComponent(jakarta.faces.context.FacesContext, String, String)on the wrappedApplicationobject.abstract UIViewRootViewHandler. createView(FacesContext context, String viewId)Create and return a newUIViewRootinstance initialized with information from the argumentFacesContextandviewId.UIViewRootViewHandlerWrapper. createView(FacesContext context, String viewId)The default behavior of this method is to callViewHandler.createView(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.ViewResourceResourceHandler. createViewResource(FacesContext context, String resourceName)Create an instance ofResourcegiven the argumentresourceName, which may contain "/" characters.ViewResourceResourceHandlerWrapper. createViewResource(FacesContext context, String resourceName)The default behavior of this method is to callResourceHandler.createViewResource(jakarta.faces.context.FacesContext, java.lang.String)on the wrappedResourceHandlerobject.StringViewHandler. deriveLogicalViewId(FacesContext context, String requestViewId)Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.StringViewHandlerWrapper. deriveLogicalViewId(FacesContext context, String requestViewId)The default behavior of this method is to callViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.StringViewHandler. deriveViewId(FacesContext context, String requestViewId)Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.StringViewHandlerWrapper. deriveViewId(FacesContext context, String requestViewId)The default behavior of this method is to callViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.<T> TApplication. evaluateExpressionGet(FacesContext context, String expression, Class<? extends T> expectedType)Get a value by evaluating an expression.<T> TApplicationWrapper. evaluateExpressionGet(FacesContext context, String expression, Class<? extends T> expectedType)The default behavior of this method is to callApplication.evaluateExpressionGet(jakarta.faces.context.FacesContext, String, Class)on the wrappedApplicationobject.URLNavigationCase. getActionURL(FacesContext context)Construct an absolute URL to thisNavigationCaseinstance usingViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String)on the path portion of the url.URLNavigationCaseWrapper. getActionURL(FacesContext context)abstract StringViewHandler. getActionURL(FacesContext context, String viewId)If the value returned from this method is used as thefileargument to the four-argument constructor forjava.net.URL(assuming appropriate values are used for the first three arguments), then a client making a request to thetoExternalForm()of thatURLwill select the argumentviewIdfor traversing the Jakarta Faces lifecycle.StringViewHandlerWrapper. getActionURL(FacesContext context, String viewId)The default behavior of this method is to callViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.URLNavigationCase. getBookmarkableURL(FacesContext context)Construct an absolute URL suitable for a bookmarkable link to thisNavigationCaseinstance usingViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean)on the path portion of the url.URLNavigationCaseWrapper. getBookmarkableURL(FacesContext context)StringViewHandler. getBookmarkableURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Faces response.StringViewHandlerWrapper. getBookmarkableURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)The default behavior of this method is to callViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)on the wrappedViewHandlerobject.BooleanNavigationCase. getCondition(FacesContext context)Evaluates the<if>for this<navigation-case>, if any.BooleanNavigationCaseWrapper. getCondition(FacesContext context)abstract NavigationCaseConfigurableNavigationHandler. getNavigationCase(FacesContext context, String fromAction, String outcome)Return theNavigationCaserepresenting the navigation that would be taken hadNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)been called with the same arguments ornullif there is no such case.NavigationCaseConfigurableNavigationHandler. getNavigationCase(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)Return theNavigationCaserepresenting the navigation that would be taken hadNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)been called with the same arguments ornullif there is no such case.NavigationCaseConfigurableNavigationHandlerWrapper. getNavigationCase(FacesContext context, String fromAction, String outcome)NavigationCaseConfigurableNavigationHandlerWrapper. getNavigationCase(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)URLNavigationCase. getRedirectURL(FacesContext context)Construct an absolute URL suitable for a "redirect" to thisNavigationCaseinstance usingViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean)on the path portion of the url.URLNavigationCaseWrapper. getRedirectURL(FacesContext context)StringViewHandler. getRedirectURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)Return a Jakarta Faces action URL derived from theviewIdargument that is suitable to be used by theNavigationHandlerto issue a redirect request to the URL using a NonFaces request.StringViewHandlerWrapper. getRedirectURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)The default behavior of this method is to callViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)on the wrappedViewHandlerobject.ResourceBundleApplication. getResourceBundle(FacesContext ctx, String name)Find aResourceBundleas defined in the application configuration resources under the specified name.ResourceBundleApplicationWrapper. getResourceBundle(FacesContext ctx, String name)The default behavior of this method is to callApplication.getResourceBundle(jakarta.faces.context.FacesContext, String)on the wrappedApplicationobject.URLNavigationCase. getResourceURL(FacesContext context)Construct an absolute URL to thisNavigationCaseinstance usingViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String)on the path portion of the url.URLNavigationCaseWrapper. getResourceURL(FacesContext context)abstract StringViewHandler. getResourceURL(FacesContext context, String path)If the value returned from this method is used as thefileargument to the four-argument constructor forjava.net.URL(assuming appropriate values are used for the first three arguments), then a client making a request to thetoExternalForm()of thatURLwill select the argumentpathfor direct rendering.StringViewHandlerWrapper. getResourceURL(FacesContext context, String path)The default behavior of this method is to callViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.StringNavigationCase. getToViewId(FacesContext context)Evaluates the<to-view-id>for this<navigation-case>StringNavigationCaseWrapper. getToViewId(FacesContext context)ViewDeclarationLanguageViewHandler. getViewDeclarationLanguage(FacesContext context, String viewId)ViewDeclarationLanguageViewHandlerWrapper. getViewDeclarationLanguage(FacesContext context, String viewId)The default behavior of this method is to callViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String)on the wrappedViewHandlerobject.Stream<String>ResourceHandler. getViewResources(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options)Return aStreampossibly lazily populated by walking the resource tree rooted at a given initial path.Stream<String>ResourceHandler. getViewResources(FacesContext facesContext, String path, ResourceVisitOption... options)Return aStreampossibly lazily populated by walking the resource tree rooted at a given initial path.Stream<String>ResourceHandlerWrapper. getViewResources(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options)The default behavior of this method is to callResourceHandler.getViewResources(FacesContext, String, int, ResourceVisitOption...)on the wrappedResourceHandlerobject.Stream<String>ResourceHandlerWrapper. getViewResources(FacesContext facesContext, String path, ResourceVisitOption... options)The default behavior of this method is to callResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...)on the wrappedResourceHandlerobject.Stream<String>ViewHandler. getViews(FacesContext facesContext, String path, int maxDepth, ViewVisitOption... options)Return aStreampossibly lazily populated by walking the view trees of every activeViewDeclarationLanguagerooted at a given initial path.Stream<String>ViewHandler. getViews(FacesContext facesContext, String path, ViewVisitOption... options)Return aStreampossibly lazily populated by walking the view trees of every activeViewDeclarationLanguagerooted at a given initial path.Stream<String>ViewHandlerWrapper. getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options)The default behavior of this method is to callViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)on the wrappedViewHandlerobject.Stream<String>ViewHandlerWrapper. getViews(FacesContext context, String path, ViewVisitOption... options)The default behavior of this method is to callViewHandler.getViews(FacesContext, String, ViewVisitOption...)on the wrappedViewHandlerobject.StringStateManager. getViewState(FacesContext context)Convenience method to return the view state as aStringwith noRenderKitspecific markup.StringStateManagerWrapper. getViewState(FacesContext context)The default behavior of this method is to callStateManager.getViewState(jakarta.faces.context.FacesContext)on the wrappedStateManagerobject.abstract StringViewHandler. getWebsocketURL(FacesContext context, String channel)If the value returned from this method is used as thefileargument to the four-argument constructor forjava.net.URL(assuming appropriate values are used for the first three arguments), then a client making a push handshake request to thetoExternalForm()of thatURLwill select the argumentchannelfor connecting the websocket push channel in the current view.StringViewHandlerWrapper. getWebsocketURL(FacesContext context, String channel)The default behavior of this method is to callViewHandler.getWebsocketURL(FacesContext, String)on the wrappedViewHandlerobject.voidConfigurableNavigationHandlerWrapper. handleNavigation(FacesContext context, String fromAction, String outcome)abstract voidNavigationHandler. handleNavigation(FacesContext context, String fromAction, String outcome)Perform navigation processing based on the state information in the specifiedFacesContext, plus the outcome string returned by an executed application action.voidNavigationHandler. handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)Overloaded variant ofNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)that allows the caller to provide the defining document id for a flow to be entered by this navigation.voidNavigationHandlerWrapper. handleNavigation(FacesContext context, String fromAction, String outcome)voidNavigationHandlerWrapper. handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)abstract voidResourceHandler. handleResourceRequest(FacesContext context)This method specifies the contract for satisfying resource requests.voidResourceHandlerWrapper. handleResourceRequest(FacesContext context)The default behavior of this method is to callResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)on the wrappedResourceHandlerobject.voidViewHandler. initView(FacesContext context)Initialize the view for the request processing lifecycle.voidViewHandlerWrapper. initView(FacesContext context)The default behavior of this method is to callViewHandler.initView(jakarta.faces.context.FacesContext)on the wrappedViewHandlerobject.voidConfigurableNavigationHandler. inspectFlow(FacesContext context, Flow flow)Called by the flow system to cause the flow to be inspected for navigation rules.voidConfigurableNavigationHandlerWrapper. inspectFlow(FacesContext context, Flow flow)booleanResourceHandler. isResourceRendered(FacesContext context, String resourceName, String libraryName)Returns whether the resource as identified by given resource and library name has been rendered.booleanResourceHandlerWrapper. isResourceRendered(FacesContext context, String resourceName, String libraryName)The default behavior of this method is to callResourceHandler.isResourceRendered(FacesContext, String, String)on the wrappedResourceHandlerobject.abstract booleanResourceHandler. isResourceRequest(FacesContext context)Returntrueif the current request is a resource request.booleanResourceHandlerWrapper. isResourceRequest(FacesContext context)The default behavior of this method is to callResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)on the wrappedResourceHandlerobject.booleanStateManager. isSavingStateInClient(FacesContext context)Method to determine if the state is saved on the client.booleanStateManagerWrapper. isSavingStateInClient(FacesContext context)The default behavior of this method is to callStateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)on the wrappedStateManagerobject.voidResourceHandler. markResourceRendered(FacesContext context, String resourceName, String libraryName)Mark the resource as identified by given resource and library name as rendered.voidResourceHandlerWrapper. markResourceRendered(FacesContext context, String resourceName, String libraryName)The default behavior of this method is to callResourceHandler.markResourceRendered(FacesContext, String, String)on the wrappedResourceHandlerobject.voidApplication. publishEvent(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source)This method functions exactly likeApplication.publishEvent(FacesContext,Class,Object), except the run-time must use the argumentsourceBaseTypeto find the matching listener instead of using theClassof thesourceargument.voidApplication. publishEvent(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source)IfisProcessingEvents()istrueand there are one or more listeners for events of the type represented bysystemEventClass, call those listeners, passingsourceas the source of the event.voidApplicationWrapper. publishEvent(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source)The default behavior of this method is to callApplication.publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object)on the wrappedApplicationobject.voidApplicationWrapper. publishEvent(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source)The default behavior of this method is to callApplication.publishEvent(jakarta.faces.context.FacesContext, Class, Object)on the wrappedApplicationobject.abstract voidViewHandler. renderView(FacesContext context, UIViewRoot viewToRender)Perform whatever actions are required to render the response view to the response object associated with the currentFacesContext.voidViewHandlerWrapper. renderView(FacesContext context, UIViewRoot viewToRender)The default behavior of this method is to callViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)on the wrappedViewHandlerobject.abstract UIViewRootViewHandler. restoreView(FacesContext context, String viewId)Perform whatever actions are required to restore the view associated with the specifiedFacesContextandviewId.UIViewRootViewHandlerWrapper. restoreView(FacesContext context, String viewId)The default behavior of this method is to callViewHandler.restoreView(jakarta.faces.context.FacesContext, String)on the wrappedViewHandlerobject.abstract booleanResource. userAgentNeedsUpdate(FacesContext context)Returntrueif the user-agent requesting this resource needs an update.booleanResourceWrapper. userAgentNeedsUpdate(FacesContext context)The default behavior of this method is to callResource.userAgentNeedsUpdate(jakarta.faces.context.FacesContext)on the wrappedResourceHandlerobject.voidStateManager. writeState(FacesContext context, Object state)Save the state represented in the specified stateObjectinstance, in an implementation dependent manner.voidStateManagerWrapper. writeState(FacesContext context, Object state)The default behavior of this method is to callStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)on the wrappedStateManagerobject.abstract voidViewHandler. writeState(FacesContext context)Take any appropriate action to either immediately write out the current state information (by callingStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object), or noting where state information should later be written.voidViewHandlerWrapper. writeState(FacesContext context)The default behavior of this method is to callViewHandler.writeState(jakarta.faces.context.FacesContext)on the wrappedViewHandlerobject. -
Uses of FacesContext in jakarta.faces.component
Methods in jakarta.faces.component that return FacesContext Modifier and Type Method Description protected abstract FacesContextUIComponent. getFacesContext()Convenience method to return theFacesContextinstance for the current request.protected FacesContextUIComponentBase. getFacesContext()Methods in jakarta.faces.component with parameters of type FacesContext Modifier and Type Method Description voidUIViewRoot. addComponentResource(FacesContext context, UIComponent componentResource)Add argumentcomponent, which is assumed to represent a resource instance, as a resource to this view.voidUIViewRoot. addComponentResource(FacesContext context, UIComponent componentResource, String target)Add argumentcomponent, which is assumed to represent a resource instance, as a resource to this view.voidUIViewRoot. broadcastEvents(FacesContext context, PhaseId phaseId)Broadcast any events that have been queued.StringUIData. createUniqueId(FacesContext context, String seed)StringUIForm. createUniqueId(FacesContext context, String seed)Generate an identifier for a component.StringUINamingContainer. createUniqueId(FacesContext context, String seed)StringUIViewRoot. createUniqueId(FacesContext context, String seed)Generate an identifier for a component.StringUniqueIdVendor. createUniqueId(FacesContext context, String seed)Generate an identifier for a component.abstract voidUIComponent. decode(FacesContext context)Decode any new state of thisUIComponentfrom the request contained in the specifiedFacesContext, and store this state as needed.voidUIComponentBase. decode(FacesContext context)voidUIInput. decode(FacesContext context)voidUIViewAction. decode(FacesContext context)Override behavior from the superclass to queue anActionEventthat may result in the invocation of theactionor anyactionListeners that may be associated with this instance.voidUIViewParameter. decode(FacesContext context)Override behavior from superclass to pull a value from the incoming request parameter map under the name given byUIViewParameter.getName()and store it with a call toUIInput.setSubmittedValue(java.lang.Object).voidUIComponent. encodeAll(FacesContext context)If this component returnstruefromUIComponent.isRendered(), take the following action.voidUIViewParameter. encodeAll(FacesContext context)Called specially byUIViewRoot.encodeEnd(jakarta.faces.context.FacesContext), this method simply sets the submitted value to be the return fromUIViewParameter.getStringValue(jakarta.faces.context.FacesContext).abstract voidUIComponent. encodeBegin(FacesContext context)If ourrenderedproperty istrue, render the beginning of the current state of thisUIComponentto the response contained in the specifiedFacesContext.voidUIComponentBase. encodeBegin(FacesContext context)voidUIData. encodeBegin(FacesContext context)In addition to the default behavior, ensure that any saved per-row state for our child input components is discarded unless it is needed to rerender the current page with errors.voidUIViewRoot. encodeBegin(FacesContext context)Override the defaultUIComponentBase.encodeBegin(jakarta.faces.context.FacesContext)behavior.abstract voidUIComponent. encodeChildren(FacesContext context)voidUIComponentBase. encodeChildren(FacesContext context)voidUIViewRoot. encodeChildren(FacesContext context)IfPartialViewContext.isAjaxRequest()returnstrue, perform partial rendering by callingPartialViewContext.processPartial(jakarta.faces.event.PhaseId)withPhaseId.RENDER_RESPONSE.abstract voidUIComponent. encodeEnd(FacesContext context)voidUIComponentBase. encodeEnd(FacesContext context)voidUIViewRoot. encodeEnd(FacesContext context)IfUIViewRoot.getAfterPhaseListener()returns non-null, invoke it, passing aPhaseEventfor thePhaseId.RENDER_RESPONSEphase.abstract StringUIComponent. getClientId(FacesContext context)Return a client-side identifier for this component, generating one if necessary.StringUIComponentBase. getClientId(FacesContext context)StringUIData. getClientId(FacesContext context)Return a client identifier for this component that includes the current value of therowIndexproperty, if it is not set to -1.List<UIComponent>UIViewRoot. getComponentResources(FacesContext context)Return an unmodifiable orderedListof allUIComponentresources of all supported targets.List<UIComponent>UIViewRoot. getComponentResources(FacesContext context, String target)StringUIComponent. getContainerClientId(FacesContext context)Allow components that implementNamingContainerto selectively disable prepending their clientId to their descendent's clientIds by breaking the prepending logic into a separately callable method.StringUIForm. getContainerClientId(FacesContext context)Override theUIComponent.getContainerClientId(jakarta.faces.context.FacesContext)to allow users to disable this form from prepending itsclientIdto its descendent'sclientIdsdepending on the value of this form'sUIForm.isPrependId()property.protected ObjectUIInput. getConvertedValue(FacesContext context, Object newSubmittedValue)Convert the submitted value into a "local value" of the appropriate data type, if necessary.protected ObjectUIViewParameter. getConvertedValue(FacesContext context, Object submittedValue)Because this class has noRenderer, leverage the one from the standard HTML_BASICRenderKitwithcomponent-family: jakarta.faces.Inputandrenderer-type: jakarta.faces.Textand call itsRenderer.getConvertedValue(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)method.static UIComponentUIComponent. getCurrentComponent(FacesContext context)Return theUIComponentinstance that is currently processing.static UIComponentUIComponent. getCurrentCompositeComponent(FacesContext context)Return the closest ancestor component, relative to the component returned fromUIComponent.getCurrentComponent(jakarta.faces.context.FacesContext), that is a composite component, ornullif no such component exists.protected abstract RendererUIComponent. getRenderer(FacesContext context)Convenience method to return theRendererinstance associated with this component, if any; otherwise, returnnull.protected RendererUIComponentBase. getRenderer(FacesContext context)static charUINamingContainer. getSeparatorChar(FacesContext context)Return the character used to separate segments of a clientId.StringUIViewParameter. getStringValue(FacesContext context)If the value of this parameter comes from aValueExpressionreturn the value of the expression, otherwise, return the local value.StringUIViewParameter. getStringValueFromModel(FacesContext context)Manually perform standard conversion steps to get a string value from the value expression.UIViewParameterUIViewParameter.Reference. getUIViewParameter(FacesContext context)Return theUIViewParameterto which this instance refers.voidContextCallback. invokeContextCallback(FacesContext context, UIComponent target)This method will be called by an implementation ofUIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)and must be passed the component with theclientIdgiven as an argument toinvokeOnComponent.booleanUIComponent. invokeOnComponent(FacesContext context, String clientId, ContextCallback callback)Starting at this component in the View hierarchy, search for a component with aclientIdequal to the argumentclientIdand, if found, call theContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)method on the argumentcallback, passing the currentFacesContextand the found component as arguments.booleanUIComponentBase. invokeOnComponent(FacesContext context, String clientId, ContextCallback callback)Starting at this component in the View hierarchy, search for a component with aclientIdequal to the argumentclientIdand, if found, call theContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)method on the argumentcallback, passing the currentFacesContextand the found component as arguments.booleanUIData. invokeOnComponent(FacesContext context, String clientId, ContextCallback callback)Override behavior fromUIComponentBase.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)to provide special care for positioning the data properly before finding the component and invoking the callback on it.booleanUIForm. invokeOnComponent(FacesContext context, String clientId, ContextCallback callback)static booleanUIViewAction. isProcessingBroadcast(FacesContext context)Returnstrueif the current request processing lifecycle is in the midst of processing the broadcast of an event queued during a call toUIViewAction.decode(jakarta.faces.context.FacesContext).voidUIComponent. popComponentFromEL(FacesContext context)Pop the currentUIComponentfrom theFacesContextattributes map so that the previousUIComponent, if any, becomes the current component.voidUIViewRoot. processApplication(FacesContext context)Broadcast any events that have been queued for the Invoke Application phase of the request processing lifecycle and to clear out any events for later phases if the event processing for this phase causedrenderResponse()orresponseComplete()to be called.abstract voidUIComponent. processDecodes(FacesContext context)Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.voidUIComponentBase. processDecodes(FacesContext context)voidUIData. processDecodes(FacesContext context)Override the defaultUIComponentBase.processDecodes(jakarta.faces.context.FacesContext)processing to perform the following steps.voidUIForm. processDecodes(FacesContext context)OverrideUIComponent.processDecodes(jakarta.faces.context.FacesContext)to ensure that the form is decoded before its children.voidUIInput. processDecodes(FacesContext context)Specialized decode behavior on top of that provided by the superclass.voidUIViewRoot. processDecodes(FacesContext context)abstract voidUIComponent. processRestoreState(FacesContext context, Object state)Perform the component tree processing required by the Restore View phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.voidUIComponentBase. processRestoreState(FacesContext context, Object state)voidUIViewRoot. processRestoreState(FacesContext context, Object state)The default implementation must callUIComponentBase.processRestoreState(jakarta.faces.context.FacesContext, java.lang.Object)from within atryblock.abstract ObjectUIComponent. processSaveState(FacesContext context)Perform the component tree processing required by the state saving portion of the Render Response phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.ObjectUIComponentBase. processSaveState(FacesContext context)abstract voidUIComponent. processUpdates(FacesContext context)Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.voidUIComponentBase. processUpdates(FacesContext context)voidUIData. processUpdates(FacesContext context)Override the defaultUIComponentBase.processUpdates(jakarta.faces.context.FacesContext)processing to perform the following steps.voidUIForm. processUpdates(FacesContext context)OverrideUIComponent.processUpdates(jakarta.faces.context.FacesContext)to ensure that the children of thisUIForminstance are only processed ifUIForm.isSubmitted()returnstrue.voidUIInput. processUpdates(FacesContext context)In addition to the standardprocessUpdatesbehavior inherited fromUIComponentBase, callsupdateModel().voidUIViewRoot. processUpdates(FacesContext context)abstract voidUIComponent. processValidators(FacesContext context)Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows.voidUIComponentBase. processValidators(FacesContext context)voidUIData. processValidators(FacesContext context)Override the defaultUIComponentBase.processValidators(jakarta.faces.context.FacesContext)processing to perform the following steps.voidUIForm. processValidators(FacesContext context)OverrideUIComponent.processValidators(jakarta.faces.context.FacesContext)to ensure that the children of thisUIForminstance are only processed ifUIForm.isSubmitted()returnstrue.voidUIInput. processValidators(FacesContext context)In addition to the standardprocessValidatorsbehavior inherited fromUIComponentBase, callsvalidate()if theimmediateproperty is false (which is the default); if the component is invalid afterwards, callsrenderResponse().voidUISelectOne. processValidators(FacesContext context)IfUISelectOne.getGroup()is set, andUIInput.getSubmittedValue()is empty, and at least one other component having the same group within aUIFormparent has a non-emptyUIInput.getSubmittedValue()or returnstrueonUIInput.isLocalValueSet()or returnsfalseonUIInput.isValid(), then skip validation for current component, else perform standard superclass processing bysuper.processValidators(context).voidUIViewParameter. processValidators(FacesContext context)Specialize superclass behavior to treatnulldifferently.voidUIViewRoot. processValidators(FacesContext context)voidUIComponent. pushComponentToEL(FacesContext context, UIComponent component)Push the currentUIComponentthisto theFacesContextattribute map saving the previousUIComponentfor a subsequent call toUIComponent.popComponentFromEL(jakarta.faces.context.FacesContext).voidUIViewRoot. removeComponentResource(FacesContext context, UIComponent componentResource)Remove argumentcomponent, which is assumed to represent a resource instance, as a resource to this view.voidUIViewRoot. removeComponentResource(FacesContext context, UIComponent componentResource, String target)Remove argumentcomponent, which is assumed to represent a resource instance, as a resource to this view.voidUIViewRoot. resetValues(FacesContext context, Collection<String> clientIds)Visit the clientIds and, if the component is an instance ofEditableValueHolder, call itsEditableValueHolder.resetValue()method.static ObjectUIComponentBase. restoreAttachedState(FacesContext context, Object stateObj)This method is called byUIComponentsubclasses that need to restore the objects they saved usingUIComponentBase.saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object).voidStateHolder. restoreState(FacesContext context, Object state)Perform any processing required to restore the state from the entries in the state Object.voidUIComponentBase. restoreState(FacesContext context, Object state)voidUIData. restoreState(FacesContext context, Object state)voidUIInput. restoreState(FacesContext context, Object state)voidUIOutput. restoreState(FacesContext context, Object state)voidUIViewRoot. restoreState(FacesContext context, Object state)voidTransientStateHolder. restoreTransientState(FacesContext context, Object state)Restore the "transient state" using the object passed as state.voidUIComponent. restoreTransientState(FacesContext context, Object state)For components that need to support the concept of transient state, this method will restore any state saved on a prior call toUIComponent.saveTransientState(jakarta.faces.context.FacesContext).voidUIViewRoot. restoreViewScopeState(FacesContext context, Object state)Restore ViewScope state.static ObjectUIComponentBase. saveAttachedState(FacesContext context, Object attachedObject)This method is called byUIComponentsubclasses that want to save one or more attached objects.ObjectStateHolder. saveState(FacesContext context)Gets the state of the instance as aSerializableObject.ObjectUIComponentBase. saveState(FacesContext context)ObjectUIData. saveState(FacesContext context)ObjectUIInput. saveState(FacesContext context)ObjectUIOutput. saveState(FacesContext context)ObjectUIViewRoot. saveState(FacesContext context)ObjectTransientStateHolder. saveTransientState(FacesContext context)Return the object containing related "transient states".ObjectUIComponent. saveTransientState(FacesContext context)For components that need to support the concept of transient state, this method will save any state that is known to be transient in nature.voidUIInput. updateModel(FacesContext context)Perform the following algorithm to update the model data associated with thisUIInput, if any, as appropriate.voidUIViewParameter. updateModel(FacesContext context)Call through to superclassUIInput.updateModel(jakarta.faces.context.FacesContext)then take the additional action of pushing the value into request scope if and only if the value is not a value expression, is valid, and the local value was set on this lifecycle execution.voidUIInput. validate(FacesContext context)Perform the following algorithm to validate the local value of thisUIInput.protected voidUIInput. validateValue(FacesContext context, Object newValue)Set the "valid" property according to the below algorithm.protected voidUISelectMany. validateValue(FacesContext context, Object value)In addition to the standard validation behavior inherited fromUIInput, ensure that any specified values are equal to one of the available options.protected voidUISelectOne. validateValue(FacesContext context, Object value)In addition to the standard validation behavior inherited fromUIInput, ensure that any specified value is equal to one of the available options.Constructors in jakarta.faces.component with parameters of type FacesContext Constructor Description Reference(FacesContext context, UIViewParameter param, int indexInParent, String viewIdAtTimeOfConstruction)Construct a reference to aUIViewParameter. -
Uses of FacesContext in jakarta.faces.component.behavior
Methods in jakarta.faces.component.behavior that return FacesContext Modifier and Type Method Description abstract FacesContextClientBehaviorContext. getFacesContext()Returns theFacesContextfor the current request.Methods in jakarta.faces.component.behavior with parameters of type FacesContext Modifier and Type Method Description static ClientBehaviorContextClientBehaviorContext. createClientBehaviorContext(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters)Creates a ClientBehaviorContext instance.voidClientBehavior. decode(FacesContext context, UIComponent component)Decode any new state of thisClientBehaviorfrom the request contained in the specifiedFacesContext.voidClientBehaviorBase. decode(FacesContext context, UIComponent component)Default implementation of ofClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).protected ClientBehaviorRendererClientBehaviorBase. getRenderer(FacesContext context)Convenience method to return theClientBehaviorRendererinstance associated with thisClientBehavior, if any; otherwise, returnnull.voidAjaxBehavior. restoreState(FacesContext context, Object state)voidBehaviorBase. restoreState(FacesContext context, Object state)ObjectAjaxBehavior. saveState(FacesContext context)ObjectBehaviorBase. saveState(FacesContext context)Implementation ofStateHolder.saveState(jakarta.faces.context.FacesContext). -
Uses of FacesContext in jakarta.faces.component.html
Methods in jakarta.faces.component.html with parameters of type FacesContext Modifier and Type Method Description ObjectHtmlInputFile. saveState(FacesContext context) -
Uses of FacesContext in jakarta.faces.component.search
Methods in jakarta.faces.component.search that return FacesContext Modifier and Type Method Description abstract FacesContextSearchExpressionContext. getFacesContext()Returns the FacesContext for the current request.Methods in jakarta.faces.component.search with parameters of type FacesContext Modifier and Type Method Description static SearchExpressionContextSearchExpressionContext. createSearchExpressionContext(FacesContext context, UIComponent source)Creates aSearchExpressionContextinstance for use with theSearchExpressionHandler.static SearchExpressionContextSearchExpressionContext. createSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)Creates aSearchExpressionContextinstance for use with theSearchExpressionHandler.char[]SearchExpressionHandler. getExpressionSeperatorChars(FacesContext context)Return the characters used to separate expressions in a series of expressions.char[]SearchExpressionHandlerWrapper. getExpressionSeperatorChars(FacesContext context)abstract SearchExpressionContextSearchExpressionContextFactory. getSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)Creates aSearchExpressionContextinstance for use with theSearchExpressionHandler.abstract String[]SearchExpressionHandler. splitExpressions(FacesContext context, String expressions)Splits an string, based onSearchExpressionHandler.getExpressionSeperatorChars(jakarta.faces.context.FacesContext)with possible multiple expressions into an array.String[]SearchExpressionHandlerWrapper. splitExpressions(FacesContext context, String expressions) -
Uses of FacesContext in jakarta.faces.component.visit
Methods in jakarta.faces.component.visit that return FacesContext Modifier and Type Method Description abstract FacesContextVisitContext. getFacesContext()Returns the FacesContext for the current request.FacesContextVisitContextWrapper. getFacesContext()Methods in jakarta.faces.component.visit with parameters of type FacesContext Modifier and Type Method Description static VisitContextVisitContext. createVisitContext(FacesContext context)Creates a VisitContext instance for use withUIComponent.visitTree().static VisitContextVisitContext. createVisitContext(FacesContext context, Collection<String> ids, Set<VisitHint> hints)Returns a VisitContext instance that is initialized with the specified ids and hintsfor use withUIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback).abstract VisitContextVisitContextFactory. getVisitContext(FacesContext context, Collection<String> ids, Set<VisitHint> hints)Return a newVisitContextinstance. -
Uses of FacesContext in jakarta.faces.context
Subclasses of FacesContext in jakarta.faces.context Modifier and Type Class Description classFacesContextWrapperProvides a simple implementation ofFacesContextthat can be subclassed by developers wishing to provide specialized behavior to an existingFacesContextinstance.Methods in jakarta.faces.context that return FacesContext Modifier and Type Method Description static FacesContextFacesContext. getCurrentInstance()Return theFacesContextinstance for the request that is being processed by the current thread.abstract FacesContextFacesContextFactory. getFacesContext(Object context, Object request, Object response, Lifecycle lifecycle)Create (if needed) and return aFacesContextinstance that is initialized for the processing of the specified request and response objects, utilizing the specifiedLifecycleinstance, for this web application.FacesContextFacesContextWrapper. getWrapped()Methods in jakarta.faces.context with parameters of type FacesContext Modifier and Type Method Description abstract voidFlash. doPostPhaseActions(FacesContext ctx)Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.voidFlashWrapper. doPostPhaseActions(FacesContext ctx)The default behavior of this method is to callFlash.doPostPhaseActions(FacesContext)on the wrappedFlashobject.abstract voidFlash. doPrePhaseActions(FacesContext ctx)Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.voidFlashWrapper. doPrePhaseActions(FacesContext ctx)The default behavior of this method is to callFlash.doPrePhaseActions(FacesContext)on the wrappedFlashobject.abstract PartialViewContextPartialViewContextFactory. getPartialViewContext(FacesContext context)Create (if needed) and return aPartialViewContextinstance that is initialized using the currentFacesContextinstance.protected static voidFacesContext. setCurrentInstance(FacesContext context)Set theFacesContextinstance for the request that is being processed by the current thread.Constructors in jakarta.faces.context with parameters of type FacesContext Constructor Description FacesContextWrapper(FacesContext wrapped)If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. -
Uses of FacesContext in jakarta.faces.convert
Methods in jakarta.faces.convert with parameters of type FacesContext Modifier and Type Method Description ObjectBigDecimalConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectBigIntegerConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectBooleanConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectByteConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectCharacterConverter. getAsObject(FacesContext context, UIComponent component, String value)TConverter. getAsObject(FacesContext context, UIComponent component, String value)Convert the specified string value, which is associated with the specifiedUIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.ObjectDateTimeConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectDoubleConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectEnumConverter. getAsObject(FacesContext context, UIComponent component, String value)Convert thevalueargument to one of the enum constants of the class provided in our constructor.ObjectFloatConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectIntegerConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectLongConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectNumberConverter. getAsObject(FacesContext context, UIComponent component, String value)ObjectShortConverter. getAsObject(FacesContext context, UIComponent component, String value)StringBigDecimalConverter. getAsString(FacesContext context, UIComponent component, Object value)StringBigIntegerConverter. getAsString(FacesContext context, UIComponent component, Object value)StringBooleanConverter. getAsString(FacesContext context, UIComponent component, Object value)StringByteConverter. getAsString(FacesContext context, UIComponent component, Object value)StringCharacterConverter. getAsString(FacesContext context, UIComponent component, Object value)StringConverter. getAsString(FacesContext context, UIComponent component, T value)Convert the specified model object value, which is associated with the specifiedUIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.StringDateTimeConverter. getAsString(FacesContext context, UIComponent component, Object value)StringDoubleConverter. getAsString(FacesContext context, UIComponent component, Object value)StringEnumConverter. getAsString(FacesContext context, UIComponent component, Object value)Convert the enum constant given by thevalueargument into a String.StringFloatConverter. getAsString(FacesContext context, UIComponent component, Object value)StringIntegerConverter. getAsString(FacesContext context, UIComponent component, Object value)StringLongConverter. getAsString(FacesContext context, UIComponent component, Object value)StringNumberConverter. getAsString(FacesContext context, UIComponent component, Object value)StringShortConverter. getAsString(FacesContext context, UIComponent component, Object value)voidDateTimeConverter. restoreState(FacesContext context, Object state)voidEnumConverter. restoreState(FacesContext facesContext, Object object)voidNumberConverter. restoreState(FacesContext context, Object state)ObjectDateTimeConverter. saveState(FacesContext context)ObjectEnumConverter. saveState(FacesContext facesContext)ObjectNumberConverter. saveState(FacesContext context) -
Uses of FacesContext in jakarta.faces.event
Methods in jakarta.faces.event that return FacesContext Modifier and Type Method Description FacesContextExceptionQueuedEventContext. getContext()TheFacesContextfor this request.FacesContextFacesEvent. getFacesContext()Get the Faces context.FacesContextPhaseEvent. getFacesContext()Return theFacesContextfor the request being processed.FacesContextSystemEvent. getFacesContext()Get the Faces context.Methods in jakarta.faces.event with parameters of type FacesContext Modifier and Type Method Description voidMethodExpressionActionListener. restoreState(FacesContext context, Object state)BothMethodExpressioninstances described in the constructor must be restored.voidMethodExpressionValueChangeListener. restoreState(FacesContext context, Object state)BothMethodExpressioninstances described in the constructor must be restored.ObjectMethodExpressionActionListener. saveState(FacesContext context)BothMethodExpressioninstances described in the constructor must be saved.ObjectMethodExpressionValueChangeListener. saveState(FacesContext context)BothMethodExpressioninstances described in the constructor must be saved.Constructors in jakarta.faces.event with parameters of type FacesContext Constructor Description ActionEvent(FacesContext facesContext, UIComponent component)Construct a new event object from the Faces context, specified source component and action command.AjaxBehaviorEvent(FacesContext facesContext, UIComponent component, Behavior behavior)Construct a new event object from the Faces context, specified source component and Ajax behavior.BehaviorEvent(FacesContext facesContext, UIComponent component, Behavior behavior)Construct a new event object from the Faces context, specified source component and behavior.ComponentSystemEvent(FacesContext facesContext, UIComponent component)Pass the argumentcomponentto the superclass constructor.ExceptionQueuedEvent(FacesContext facesContext, ExceptionQueuedEventContext eventContext)Instantiate a newExceptionQueuedEventthat indicates the argumentExceptionQueuedEventContextoccurred.ExceptionQueuedEventContext(FacesContext context, Throwable thrown)Instantiate a newExceptionQueuedEventContextthat indicates the argumentThrowablejust occurred.ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)Instantiate a newExceptionQueuedEventContextthat indicates the argumentThrowablejust occurred, relevant to the argumentcomponent.ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)Instantiate a newExceptionQueuedEventContextthat indicates the argumentThrowablejust occurred, relevant to the argumentcomponent, during the lifecycle phasephaseId.FacesEvent(FacesContext facesContext, UIComponent component)Construct a new event object from the Faces context and specified source component.PhaseEvent(FacesContext context, PhaseId phaseId, Lifecycle lifecycle)Construct a new event object from the specified parameters.PostAddToViewEvent(FacesContext facesContext, UIComponent component)Instantiate a newPostAddToViewEventthat indicates the argumentcomponentwas just added to the view.PostConstructApplicationEvent(FacesContext facesContext, Application application)Constructs a newPostConstructApplicationEventfor this application.PostConstructCustomScopeEvent(FacesContext facesContext, ScopeContext scopeContext)An instance of this event indicates that the custom scope enclosed within the argumentscopeContextwas just created.PostConstructViewMapEvent(FacesContext facesContext, UIViewRoot root)Instantiate a newPostConstructViewMapEventthat indicates the argumentrootwas just associated with its view map.PostKeepFlashValueEvent(FacesContext facesContext, String key)Instantiate a newPostKeepFlashValueEventthat indicates the argumentkeywas just kept in the flash.PostPutFlashValueEvent(FacesContext facesContext, String key)Instantiate a newPostPutFlashValueEventthat indicates the argumentkeywas just put to the flash.PostRenderViewEvent(FacesContext facesContext, UIViewRoot root)Instantiate a newPostRenderViewEventthat indicates the argumentroothas just been rendered.PostRestoreStateEvent(FacesContext facesContext, UIComponent component)Instantiate a newPostRestoreStateEventthat indicates the argumentcomponentjust had its state restored.PostValidateEvent(FacesContext facesContext, UIComponent component)ConstructorPreClearFlashEvent(FacesContext facesContext, Map<String,Object> source)Instantiate a newPreClearFlashEventthat indicates the argumentkeywas just put to the flash.PreDestroyApplicationEvent(FacesContext facesContext, Application application)Constructs a newPreDestroyApplicationEventfor this application.PreDestroyCustomScopeEvent(FacesContext facesContext, ScopeContext scopeContext)An instance of this event indicates that the custom scope enclosed within the argumentscopeContextis about to end.PreDestroyViewMapEvent(FacesContext facesContext, UIViewRoot root)Instantiate a newViewMapDestroydEventthat indicates the argumentrootjust had its associated view map destroyed.PreRemoveFlashValueEvent(FacesContext facesContext, String key)Instantiate a newPreRemoveFlashValueEventthat indicates the argumentkeywill be removed from the flash.PreRemoveFromViewEvent(FacesContext facesContext, UIComponent component)Instantiate a newBeforeRemoveFromViewthat indicates the argumentcomponentis about to be removed from the view.PreRenderComponentEvent(FacesContext facesContext, UIComponent component)Instantiate a newPreRenderComponentEventthat indicates the argumentcomponentis about to be rendered.PreRenderViewEvent(FacesContext facesContext, UIViewRoot root)Instantiate a newPreRenderViewEventthat indicates the argumentrootis about to be rendered.PreValidateEvent(FacesContext facesContext, UIComponent component)ConstructorSystemEvent(FacesContext facesContext, Object source)Pass the argumentsourceto the superclass constructor.ValueChangeEvent(FacesContext facesContext, UIComponent component, Object oldValue, Object newValue)Construct a new event object from the Faces context, specified source component, old value and new value. -
Uses of FacesContext in jakarta.faces.flow
Methods in jakarta.faces.flow with parameters of type FacesContext Modifier and Type Method Description abstract voidFlowHandler. addFlow(FacesContext context, Flow toAdd)Add the argumentFlowto the collection ofFlows known to the current application.abstract voidFlowHandler. clientWindowTransition(FacesContext context)Allow for flow transitions in the case of components rendered by the renderers from component-familyjakarta.faces.OutcomeTarget.abstract FlowHandlerFlowHandlerFactory. createFlowHandler(FacesContext context)Create the singleton instance ofFlowHandler.FlowHandlerFlowHandlerFactoryWrapper. createFlowHandler(FacesContext context)abstract StringFlowCallNode. getCalledFlowDocumentId(FacesContext context)abstract StringFlowCallNode. getCalledFlowId(FacesContext context)abstract BooleanSwitchCase. getCondition(FacesContext context)Returntrueif this case should be taken,falseotherwise.abstract FlowFlowHandler. getCurrentFlow(FacesContext context)abstract StringSwitchNode. getDefaultOutcome(FacesContext context)Return the default outcome in this switch.abstract FlowFlowHandler. getFlow(FacesContext context, String definingDocumentId, String id)Return theFlowwhoseidis equivalent to the argumentid, within the scope of the argumentdefiningDocument.abstract StringReturnNode. getFromOutcome(FacesContext context)Return thefromOutcometo be used when control passes to this return node.abstract StringFlowHandler. getLastDisplayedViewId(FacesContext context)Return the last displayed viewId for the current flow, as returned byFlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext), ornullif there is no current flow.abstract booleanFlowHandler. isActive(FacesContext context, String definingDocument, String id)Returntrueif and only if the flow referenced by the argumentdefiningDocumentandidis currently active.abstract voidFlowHandler. popReturnMode(FacesContext context)Enable the correct handling of navigation when processing a return node.abstract voidFlowHandler. pushReturnMode(FacesContext context)Enable the correct handling of navigation when processing a return node.abstract voidFlowHandler. transition(FacesContext context, Flow sourceFlow, Flow targetFlow, FlowCallNode outboundCallNode, String toViewId)Perform a transition in the flow graph for the current user'sClientWindow. -
Uses of FacesContext in jakarta.faces.lifecycle
Methods in jakarta.faces.lifecycle with parameters of type FacesContext Modifier and Type Method Description voidLifecycle. attachWindow(FacesContext context)Create or restore theClientWindowto be used to display theUIViewRootfor this run through the lifecycle.voidLifecycleWrapper. attachWindow(FacesContext context)abstract voidClientWindow. decode(FacesContext context)The implementation is responsible for examining the incoming request and extracting the value that must be returned from theClientWindow.getId()method.voidClientWindowWrapper. decode(FacesContext context)voidClientWindow. disableClientWindowRenderMode(FacesContext context)Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs.voidClientWindowWrapper. disableClientWindowRenderMode(FacesContext context)voidClientWindow. enableClientWindowRenderMode(FacesContext context)Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs.voidClientWindowWrapper. enableClientWindowRenderMode(FacesContext context)abstract voidLifecycle. execute(FacesContext context)Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase, as described in section 2 "Request Processing Lifecycle" of the Jakarta Faces Specification Document, in the specified order.voidLifecycleWrapper. execute(FacesContext context)abstract ClientWindowClientWindowFactory. getClientWindow(FacesContext context)The implementation is responsible for creating theClientWindowinstance for this request.abstract Map<String,String>ClientWindow. getQueryURLParameters(FacesContext context)This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL.Map<String,String>ClientWindowWrapper. getQueryURLParameters(FacesContext context)booleanClientWindow. isClientWindowRenderModeEnabled(FacesContext context)Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.booleanClientWindowWrapper. isClientWindowRenderModeEnabled(FacesContext context)abstract voidLifecycle. render(FacesContext context)Execute the Render Response phase of the request processing lifecycle, unless theresponseComplete()method has been called on theFacesContextinstance associated with the current request.voidLifecycleWrapper. render(FacesContext context) -
Uses of FacesContext in jakarta.faces.render
Methods in jakarta.faces.render with parameters of type FacesContext Modifier and Type Method Description StringRenderer. convertClientId(FacesContext context, String clientId)Convert the component generated client id to a form suitable for transmission to the client.StringRendererWrapper. convertClientId(FacesContext context, String clientId)voidClientBehaviorRenderer. decode(FacesContext context, UIComponent component, ClientBehavior behavior)Decode any new state of thisClientBehaviorfrom the request contained in the specifiedFacesContext.voidRenderer. decode(FacesContext context, T component)Decode any new state of the specifiedUIComponentfrom the request contained in the specifiedFacesContext, and store that state on theUIComponent.voidRendererWrapper. decode(FacesContext context, UIComponent component)voidRenderer. encodeBegin(FacesContext context, T component)Render the beginning specifiedUIComponentto the output stream or writer associated with the response we are creating.voidRendererWrapper. encodeBegin(FacesContext context, UIComponent component)voidRenderer. encodeChildren(FacesContext context, T component)Render the child components of thisUIComponent, following the rules described forencodeBegin()to acquire the appropriate value to be rendered.voidRendererWrapper. encodeChildren(FacesContext context, UIComponent component)voidRenderer. encodeEnd(FacesContext context, T component)Render the ending of the current state of the specifiedUIComponent, following the rules described forencodeBegin()to acquire the appropriate value to be rendered.voidRendererWrapper. encodeEnd(FacesContext context, UIComponent component)ObjectRenderer. getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registeredConverterfor this component, if there is one).ObjectRendererWrapper. getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)StringResponseStateManager. getCryptographicallyStrongTokenFromSession(FacesContext context)Compliant implementations must return a cryptographically strong token for use to protect views in this application.abstract RenderKitRenderKitFactory. getRenderKit(FacesContext context, String renderKitId)Return aRenderKitinstance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specifiedFacesContext, if non-null.ObjectResponseStateManager. getState(FacesContext context, String viewId)The implementation must inspect the current request and return an Object representing the tree structure and component state passed in to a previous invocation ofResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object).StringResponseStateManager. getViewState(FacesContext context, Object state)Return the specified state as aStringwithout any markup related to the rendering technology supported by this ResponseStateManager.booleanResponseStateManager. isPostback(FacesContext context)Return true if the current request is a postback.booleanResponseStateManager. isStateless(FacesContext context, String viewId)If the preceding call toResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)was stateless, returntrue.voidResponseStateManager. writeState(FacesContext context, Object state)Take the argumentstateand write it into the output using the currentResponseWriter, which must be correctly positioned already. -
Uses of FacesContext in jakarta.faces.validator
Methods in jakarta.faces.validator with parameters of type FacesContext Modifier and Type Method Description voidBeanValidator. restoreState(FacesContext context, Object state)voidDoubleRangeValidator. restoreState(FacesContext context, Object state)voidLengthValidator. restoreState(FacesContext context, Object state)voidLongRangeValidator. restoreState(FacesContext context, Object state)voidMethodExpressionValidator. restoreState(FacesContext context, Object state)voidRegexValidator. restoreState(FacesContext context, Object state)ObjectBeanValidator. saveState(FacesContext context)ObjectDoubleRangeValidator. saveState(FacesContext context)ObjectLengthValidator. saveState(FacesContext context)ObjectLongRangeValidator. saveState(FacesContext context)ObjectMethodExpressionValidator. saveState(FacesContext context)ObjectRegexValidator. saveState(FacesContext context)voidBeanValidator. validate(FacesContext context, UIComponent component, Object value)Verify that the value is valid according to the Bean Validation constraints.voidDoubleRangeValidator. validate(FacesContext context, UIComponent component, Object value)voidLengthValidator. validate(FacesContext context, UIComponent component, Object value)voidLongRangeValidator. validate(FacesContext context, UIComponent component, Object value)voidMethodExpressionValidator. validate(FacesContext context, UIComponent component, Object value)voidRegexValidator. validate(FacesContext context, UIComponent component, Object value)Validate a String against a regular expression pattern.voidRequiredValidator. validate(FacesContext context, UIComponent component, Object value)Verify that the converted object value is not null.voidValidator. validate(FacesContext context, UIComponent component, T value) -
Uses of FacesContext in jakarta.faces.view
Methods in jakarta.faces.view with parameters of type FacesContext Modifier and Type Method Description voidAttachedObjectHandler. applyAttachedObject(FacesContext context, UIComponent parent)Take the argumentparentand apply this attached object to it.abstract voidViewDeclarationLanguage. buildView(FacesContext context, UIViewRoot root)Take any actions specific to this VDL implementation to cause the argumentUIViewRootwhich must have been created via a call toViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String), to be populated with children.voidViewDeclarationLanguageWrapper. buildView(FacesContext context, UIViewRoot root)List<String>ViewDeclarationLanguage. calculateResourceLibraryContracts(FacesContext context, String viewId)Return the list of resource library contracts that will be made available for use in the view specified by the argumentviewId.List<String>ViewDeclarationLanguageWrapper. calculateResourceLibraryContracts(FacesContext context, String viewId)UIComponentViewDeclarationLanguage. createComponent(FacesContext context, String taglibURI, String tagName, Map<String,Object> attributes)Create a component given aViewDeclarationLanguagespecific tag library URI and tag name.UIComponentViewDeclarationLanguageWrapper. createComponent(FacesContext context, String taglibURI, String tagName, Map<String,Object> attributes)abstract UIViewRootViewMetadata. createMetadataView(FacesContext context)Creates a newUIViewRootcontaining only view parameter metadata.abstract UIViewRootViewDeclarationLanguage. createView(FacesContext context, String viewId)Create aUIViewRootfrom the VDL contained in the artifact referenced by the argumentviewId.UIViewRootViewDeclarationLanguageWrapper. createView(FacesContext context, String viewId)abstract BeanInfoViewDeclarationLanguage. getComponentMetadata(FacesContext context, Resource componentResource)Return a reference to the component metadata for the composite component represented by the argumentcomponentResource, ornullif the metadata cannot be found.BeanInfoViewDeclarationLanguageWrapper. getComponentMetadata(FacesContext context, Resource componentResource)abstract ResourceViewDeclarationLanguage. getScriptComponentResource(FacesContext context, Resource componentResource)Take implementation specific action to discover aResourcegiven the argumentcomponentResource.ResourceViewDeclarationLanguageWrapper. getScriptComponentResource(FacesContext context, Resource componentResource)abstract StateManagementStrategyViewDeclarationLanguage. getStateManagementStrategy(FacesContext context, String viewId)For implementations that want to control the implementation of state saving and restoring, theStateManagementStrategyallows them to do so.StateManagementStrategyViewDeclarationLanguageWrapper. getStateManagementStrategy(FacesContext context, String viewId)abstract ViewMetadataViewDeclarationLanguage. getViewMetadata(FacesContext context, String viewId)Return a reference to the view metadata for the view represented by the argumentviewId, ornullif the metadata cannot be found.ViewMetadataViewDeclarationLanguageWrapper. getViewMetadata(FacesContext context, String viewId)Stream<String>ViewDeclarationLanguage. getViews(FacesContext facesContext, String path, int maxDepth, ViewVisitOption... options)Return aStreampossibly lazily populated by walking the view tree rooted at a given initial path.Stream<String>ViewDeclarationLanguage. getViews(FacesContext facesContext, String path, ViewVisitOption... options)Return aStreampossibly lazily populated by walking the view tree rooted at a given initial path.Stream<String>ViewDeclarationLanguageWrapper. getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options)Stream<String>ViewDeclarationLanguageWrapper. getViews(FacesContext context, String path, ViewVisitOption... options)abstract voidViewDeclarationLanguage. renderView(FacesContext context, UIViewRoot view)Render a view rooted at argumentview.voidViewDeclarationLanguageWrapper. renderView(FacesContext context, UIViewRoot view)abstract UIViewRootStateManagementStrategy. restoreView(FacesContext context, String viewId, String renderKitId)Restore the state of the view with information in the request.abstract UIViewRootViewDeclarationLanguage. restoreView(FacesContext context, String viewId)Restore aUIViewRootfrom a previously created view.UIViewRootViewDeclarationLanguageWrapper. restoreView(FacesContext context, String viewId)voidViewDeclarationLanguage. retargetAttachedObjects(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers)Assuming the component metadata for argumenttopLevelComponenthas been made available by an earlier call toViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource), leverage the component metadata for the purpose of re-targeting attached objects from the top level composite component to the individualAttachedObjectTargetinstances inside the composite component.voidViewDeclarationLanguageWrapper. retargetAttachedObjects(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers)voidViewDeclarationLanguage. retargetMethodExpressions(FacesContext context, UIComponent topLevelComponent)Assuming the component metadata for argumenttopLevelComponenthas been made available by an earlier call toViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource), leverage the component metadata for the purpose of re-targeting any method expressions from the top level component to the appropriate inner component.voidViewDeclarationLanguageWrapper. retargetMethodExpressions(FacesContext context, UIComponent topLevelComponent)abstract ObjectStateManagementStrategy. saveView(FacesContext context)Return the state of the current view in anObjectthat implementsSerializableand can be passed tojava.io.ObjectOutputStream.writeObject()without causing ajava.io.NotSerializableExceptionto be thrown. The default implementation must perform the following algorithm or its semantic equivalent, explicitly performing all the steps listed here.booleanViewDeclarationLanguage. viewExists(FacesContext context, String viewId)Tests whether a physical resource corresponding to the specified viewId exists.booleanViewDeclarationLanguageWrapper. viewExists(FacesContext context, String viewId) -
Uses of FacesContext in jakarta.faces.view.facelets
Methods in jakarta.faces.view.facelets that return FacesContext Modifier and Type Method Description abstract FacesContextFaceletContext. getFacesContext()The current FacesContext bound to this "request".Methods in jakarta.faces.view.facelets with parameters of type FacesContext Modifier and Type Method Description abstract voidFacelet. apply(FacesContext facesContext, UIComponent parent)The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.voidFaceletsAttachedObjectHandler. applyAttachedObject(FacesContext ctx, UIComponent parent)Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this class to the argumentparent.voidFacelet. applyMetadata(FacesContext facesContext, UIComponent parent)The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per thef:metadatatag.
-