Uses of Class
jakarta.faces.context.FacesContext
Package
Description
-
Uses of FacesContext in jakarta.faces.application
Modifier and TypeMethodDescriptionViewHandler.calculateCharacterEncoding
(FacesContext context) Returns the correct character encoding to be used for this request.ViewHandlerWrapper.calculateCharacterEncoding
(FacesContext context) The default behavior of this method is to callViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)
on the wrappedViewHandler
object.abstract Locale
ViewHandler.calculateLocale
(FacesContext context) Returns an appropriateLocale
to use for this and subsequent requests for the current client.ViewHandlerWrapper.calculateLocale
(FacesContext context) The default behavior of this method is to callViewHandler.calculateLocale(jakarta.faces.context.FacesContext)
on the wrappedViewHandler
object.abstract String
ViewHandler.calculateRenderKitId
(FacesContext context) Return an appropriaterenderKitId
for this and subsequent requests from the current client.ViewHandlerWrapper.calculateRenderKitId
(FacesContext context) The default behavior of this method is to callViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)
on the wrappedViewHandler
object.Application.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType) Application.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType, String rendererType) LikeApplication.createComponent(ValueExpression, FacesContext, String)
except theRenderer
for 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.Application.createComponent
(FacesContext context, Resource componentResource) Application.createComponent
(FacesContext context, String componentType, String rendererType) LikeApplication.createComponent(String)
except theRenderer
for 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.ApplicationWrapper.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 wrappedApplication
object.ApplicationWrapper.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 wrappedApplication
object.ApplicationWrapper.createComponent
(FacesContext context, Resource componentResource) The default behavior of this method is to callApplication.createComponent(jakarta.faces.context.FacesContext, Resource)
on the wrappedApplication
object.ApplicationWrapper.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 wrappedApplication
object.abstract UIViewRoot
ViewHandler.createView
(FacesContext context, String viewId) Create and return a newUIViewRoot
instance initialized with information from the argumentFacesContext
andviewId
.ViewHandlerWrapper.createView
(FacesContext context, String viewId) The default behavior of this method is to callViewHandler.createView(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.ResourceHandler.createViewResource
(FacesContext context, String resourceName) Create an instance ofResource
given the argumentresourceName
, which may contain "/" characters.ResourceHandlerWrapper.createViewResource
(FacesContext context, String resourceName) The default behavior of this method is to callResourceHandler.createViewResource(jakarta.faces.context.FacesContext, java.lang.String)
on the wrappedResourceHandler
object.ViewHandler.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.ViewHandlerWrapper.deriveLogicalViewId
(FacesContext context, String requestViewId) The default behavior of this method is to callViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.ViewHandler.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.ViewHandlerWrapper.deriveViewId
(FacesContext context, String requestViewId) The default behavior of this method is to callViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.<T> T
Application.evaluateExpressionGet
(FacesContext context, String expression, Class<? extends T> expectedType) Get a value by evaluating an expression.<T> T
ApplicationWrapper.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 wrappedApplication
object.NavigationCase.getActionURL
(FacesContext context) Construct an absolute URL to thisNavigationCase
instance usingViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String)
on the path portion of the url.NavigationCaseWrapper.getActionURL
(FacesContext context) abstract String
ViewHandler.getActionURL
(FacesContext context, String viewId) If the value returned from this method is used as thefile
argument 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 thatURL
will select the argumentviewId
for traversing the Jakarta Faces lifecycle.ViewHandlerWrapper.getActionURL
(FacesContext context, String viewId) The default behavior of this method is to callViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.NavigationCase.getBookmarkableURL
(FacesContext context) Construct an absolute URL suitable for a bookmarkable link to thisNavigationCase
instance 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.NavigationCaseWrapper.getBookmarkableURL
(FacesContext context) ViewHandler.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.ViewHandlerWrapper.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 wrappedViewHandler
object.NavigationCase.getCondition
(FacesContext context) Evaluates the<if>
for this<navigation-case>
, if any.NavigationCaseWrapper.getCondition
(FacesContext context) abstract NavigationCase
ConfigurableNavigationHandler.getNavigationCase
(FacesContext context, String fromAction, String outcome) Return theNavigationCase
representing the navigation that would be taken hadNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments ornull
if there is no such case.ConfigurableNavigationHandler.getNavigationCase
(FacesContext context, String fromAction, String outcome, String toFlowDocumentId) Return theNavigationCase
representing the navigation that would be taken hadNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments ornull
if there is no such case.ConfigurableNavigationHandlerWrapper.getNavigationCase
(FacesContext context, String fromAction, String outcome) ConfigurableNavigationHandlerWrapper.getNavigationCase
(FacesContext context, String fromAction, String outcome, String toFlowDocumentId) NavigationCase.getRedirectURL
(FacesContext context) Construct an absolute URL suitable for a "redirect" to thisNavigationCase
instance 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.NavigationCaseWrapper.getRedirectURL
(FacesContext context) ViewHandler.getRedirectURL
(FacesContext context, String viewId, Map<String, List<String>> parameters, boolean includeViewParams) Return a Jakarta Faces action URL derived from theviewId
argument that is suitable to be used by theNavigationHandler
to issue a redirect request to the URL using a NonFaces request.ViewHandlerWrapper.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 wrappedViewHandler
object.Application.getResourceBundle
(FacesContext ctx, String name) Find aResourceBundle
as defined in the application configuration resources under the specified name.ApplicationWrapper.getResourceBundle
(FacesContext ctx, String name) The default behavior of this method is to callApplication.getResourceBundle(jakarta.faces.context.FacesContext, String)
on the wrappedApplication
object.NavigationCase.getResourceURL
(FacesContext context) Construct an absolute URL to thisNavigationCase
instance usingViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String)
on the path portion of the url.NavigationCaseWrapper.getResourceURL
(FacesContext context) abstract String
ViewHandler.getResourceURL
(FacesContext context, String path) If the value returned from this method is used as thefile
argument 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 thatURL
will select the argumentpath
for direct rendering.ViewHandlerWrapper.getResourceURL
(FacesContext context, String path) The default behavior of this method is to callViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.NavigationCase.getToViewId
(FacesContext context) Evaluates the<to-view-id>
for this<navigation-case>
NavigationCaseWrapper.getToViewId
(FacesContext context) ViewHandler.getViewDeclarationLanguage
(FacesContext context, String viewId) ViewHandlerWrapper.getViewDeclarationLanguage
(FacesContext context, String viewId) The default behavior of this method is to callViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String)
on the wrappedViewHandler
object.ResourceHandler.getViewResources
(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options) Return aStream
possibly lazily populated by walking the resource tree rooted at a given initial path.ResourceHandler.getViewResources
(FacesContext facesContext, String path, ResourceVisitOption... options) Return aStream
possibly lazily populated by walking the resource tree rooted at a given initial path.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 wrappedResourceHandler
object.ResourceHandlerWrapper.getViewResources
(FacesContext facesContext, String path, ResourceVisitOption... options) The default behavior of this method is to callResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...)
on the wrappedResourceHandler
object.ViewHandler.getViews
(FacesContext facesContext, String path, int maxDepth, ViewVisitOption... options) Return aStream
possibly lazily populated by walking the view trees of every activeViewDeclarationLanguage
rooted at a given initial path.ViewHandler.getViews
(FacesContext facesContext, String path, ViewVisitOption... options) Return aStream
possibly lazily populated by walking the view trees of every activeViewDeclarationLanguage
rooted at a given initial path.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 wrappedViewHandler
object.ViewHandlerWrapper.getViews
(FacesContext context, String path, ViewVisitOption... options) The default behavior of this method is to callViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrappedViewHandler
object.StateManager.getViewState
(FacesContext context) Convenience method to return the view state as aString
with noRenderKit
specific markup.StateManagerWrapper.getViewState
(FacesContext context) The default behavior of this method is to callStateManager.getViewState(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.abstract String
ViewHandler.getWebsocketURL
(FacesContext context, String channel) If the value returned from this method is used as thefile
argument 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 thatURL
will select the argumentchannel
for connecting the websocket push channel in the current view.ViewHandlerWrapper.getWebsocketURL
(FacesContext context, String channel) The default behavior of this method is to callViewHandler.getWebsocketURL(FacesContext, String)
on the wrappedViewHandler
object.void
ConfigurableNavigationHandlerWrapper.handleNavigation
(FacesContext context, String fromAction, String outcome) abstract void
NavigationHandler.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.void
NavigationHandler.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.void
NavigationHandlerWrapper.handleNavigation
(FacesContext context, String fromAction, String outcome) void
NavigationHandlerWrapper.handleNavigation
(FacesContext context, String fromAction, String outcome, String toFlowDocumentId) abstract void
ResourceHandler.handleResourceRequest
(FacesContext context) This method specifies the contract for satisfying resource requests.void
ResourceHandlerWrapper.handleResourceRequest
(FacesContext context) The default behavior of this method is to callResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
on the wrappedResourceHandler
object.void
ViewHandler.initView
(FacesContext context) Initialize the view for the request processing lifecycle.void
ViewHandlerWrapper.initView
(FacesContext context) The default behavior of this method is to callViewHandler.initView(jakarta.faces.context.FacesContext)
on the wrappedViewHandler
object.void
ConfigurableNavigationHandler.inspectFlow
(FacesContext context, Flow flow) Called by the flow system to cause the flow to be inspected for navigation rules.void
ConfigurableNavigationHandlerWrapper.inspectFlow
(FacesContext context, Flow flow) boolean
ResourceHandler.isResourceRendered
(FacesContext context, String resourceName, String libraryName) Returns whether the resource as identified by given resource and library name has been rendered.boolean
ResourceHandlerWrapper.isResourceRendered
(FacesContext context, String resourceName, String libraryName) The default behavior of this method is to callResourceHandler.isResourceRendered(FacesContext, String, String)
on the wrappedResourceHandler
object.abstract boolean
ResourceHandler.isResourceRequest
(FacesContext context) Returntrue
if the current request is a resource request.boolean
ResourceHandlerWrapper.isResourceRequest
(FacesContext context) The default behavior of this method is to callResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)
on the wrappedResourceHandler
object.boolean
StateManager.isSavingStateInClient
(FacesContext context) Method to determine if the state is saved on the client.boolean
StateManagerWrapper.isSavingStateInClient
(FacesContext context) The default behavior of this method is to callStateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.void
ResourceHandler.markResourceRendered
(FacesContext context, String resourceName, String libraryName) Mark the resource as identified by given resource and library name as rendered.void
ResourceHandlerWrapper.markResourceRendered
(FacesContext context, String resourceName, String libraryName) The default behavior of this method is to callResourceHandler.markResourceRendered(FacesContext, String, String)
on the wrappedResourceHandler
object.void
Application.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 argumentsourceBaseType
to find the matching listener instead of using theClass
of thesource
argument.void
Application.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source) IfisProcessingEvents()
istrue
and there are one or more listeners for events of the type represented bysystemEventClass
, call those listeners, passingsource
as the source of the event.void
ApplicationWrapper.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 wrappedApplication
object.void
ApplicationWrapper.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 wrappedApplication
object.abstract void
ViewHandler.renderView
(FacesContext context, UIViewRoot viewToRender) Perform whatever actions are required to render the response view to the response object associated with the currentFacesContext
.void
ViewHandlerWrapper.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 wrappedViewHandler
object.abstract UIViewRoot
ViewHandler.restoreView
(FacesContext context, String viewId) Perform whatever actions are required to restore the view associated with the specifiedFacesContext
andviewId
.ViewHandlerWrapper.restoreView
(FacesContext context, String viewId) The default behavior of this method is to callViewHandler.restoreView(jakarta.faces.context.FacesContext, String)
on the wrappedViewHandler
object.abstract boolean
Resource.userAgentNeedsUpdate
(FacesContext context) Returntrue
if the user-agent requesting this resource needs an update.boolean
ResourceWrapper.userAgentNeedsUpdate
(FacesContext context) The default behavior of this method is to callResource.userAgentNeedsUpdate(jakarta.faces.context.FacesContext)
on the wrappedResourceHandler
object.void
StateManager.writeState
(FacesContext context, Object state) Save the state represented in the specified stateObject
instance, in an implementation dependent manner.void
StateManagerWrapper.writeState
(FacesContext context, Object state) The default behavior of this method is to callStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
on the wrappedStateManager
object.abstract void
ViewHandler.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.void
ViewHandlerWrapper.writeState
(FacesContext context) The default behavior of this method is to callViewHandler.writeState(jakarta.faces.context.FacesContext)
on the wrappedViewHandler
object. -
Uses of FacesContext in jakarta.faces.component
Modifier and TypeMethodDescriptionprotected abstract FacesContext
UIComponent.getFacesContext()
Convenience method to return theFacesContext
instance for the current request.protected FacesContext
UIComponentBase.getFacesContext()
Modifier and TypeMethodDescriptionvoid
UIViewRoot.addComponentResource
(FacesContext context, UIComponent componentResource) Add argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.addComponentResource
(FacesContext context, UIComponent componentResource, String target) Add argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.broadcastEvents
(FacesContext context, PhaseId phaseId) Broadcast any events that have been queued.UIData.createUniqueId
(FacesContext context, String seed) UIForm.createUniqueId
(FacesContext context, String seed) Generate an identifier for a component.UINamingContainer.createUniqueId
(FacesContext context, String seed) UIViewRoot.createUniqueId
(FacesContext context, String seed) Generate an identifier for a component.UniqueIdVendor.createUniqueId
(FacesContext context, String seed) Generate an identifier for a component.abstract void
UIComponent.decode
(FacesContext context) Decode any new state of thisUIComponent
from the request contained in the specifiedFacesContext
, and store this state as needed.void
UIComponentBase.decode
(FacesContext context) void
UIInput.decode
(FacesContext context) void
UIViewAction.decode
(FacesContext context) Override behavior from the superclass to queue anActionEvent
that may result in the invocation of theaction
or anyactionListener
s that may be associated with this instance.void
UIViewParameter.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)
.void
UIComponent.encodeAll
(FacesContext context) If this component returnstrue
fromUIComponent.isRendered()
, take the following action.void
UIViewParameter.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 void
UIComponent.encodeBegin
(FacesContext context) If ourrendered
property istrue
, render the beginning of the current state of thisUIComponent
to the response contained in the specifiedFacesContext
.void
UIComponentBase.encodeBegin
(FacesContext context) void
UIData.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.void
UIViewRoot.encodeBegin
(FacesContext context) Override the defaultUIComponentBase.encodeBegin(jakarta.faces.context.FacesContext)
behavior.abstract void
UIComponent.encodeChildren
(FacesContext context) void
UIComponentBase.encodeChildren
(FacesContext context) void
UIViewRoot.encodeChildren
(FacesContext context) IfPartialViewContext.isAjaxRequest()
returnstrue
, perform partial rendering by callingPartialViewContext.processPartial(jakarta.faces.event.PhaseId)
withPhaseId.RENDER_RESPONSE
.abstract void
UIComponent.encodeEnd
(FacesContext context) void
UIComponentBase.encodeEnd
(FacesContext context) void
UIViewRoot.encodeEnd
(FacesContext context) IfUIViewRoot.getAfterPhaseListener()
returns non-null
, invoke it, passing aPhaseEvent
for thePhaseId.RENDER_RESPONSE
phase.abstract String
UIComponent.getClientId
(FacesContext context) Return a client-side identifier for this component, generating one if necessary.UIComponentBase.getClientId
(FacesContext context) UIData.getClientId
(FacesContext context) Return a client identifier for this component that includes the current value of therowIndex
property, if it is not set to -1.UIViewRoot.getComponentResources
(FacesContext context) Return an unmodifiable orderedList
of allUIComponent
resources of all supported targets.UIViewRoot.getComponentResources
(FacesContext context, String target) UIComponent.getContainerClientId
(FacesContext context) Allow components that implementNamingContainer
to selectively disable prepending their clientId to their descendent's clientIds by breaking the prepending logic into a separately callable method.UIForm.getContainerClientId
(FacesContext context) Override theUIComponent.getContainerClientId(jakarta.faces.context.FacesContext)
to allow users to disable this form from prepending itsclientId
to its descendent'sclientIds
depending on the value of this form'sUIForm.isPrependId()
property.protected Object
UIInput.getConvertedValue
(FacesContext context, Object newSubmittedValue) Convert the submitted value into a "local value" of the appropriate data type, if necessary.protected Object
UIViewParameter.getConvertedValue
(FacesContext context, Object submittedValue) Because this class has noRenderer
, leverage the one from the standard HTML_BASICRenderKit
withcomponent-family: jakarta.faces.Input
andrenderer-type: jakarta.faces.Text
and call itsRenderer.getConvertedValue(jakarta.faces.context.FacesContext, T, java.lang.Object)
method.static UIComponent
UIComponent.getCurrentComponent
(FacesContext context) Return theUIComponent
instance that is currently processing.static UIComponent
UIComponent.getCurrentCompositeComponent
(FacesContext context) Return the closest ancestor component, relative to the component returned fromUIComponent.getCurrentComponent(jakarta.faces.context.FacesContext)
, that is a composite component, ornull
if no such component exists.protected abstract Renderer
UIComponent.getRenderer
(FacesContext context) Convenience method to return theRenderer
instance associated with this component, if any; otherwise, returnnull
.protected Renderer
UIComponentBase.getRenderer
(FacesContext context) static char
UINamingContainer.getSeparatorChar
(FacesContext context) Return the character used to separate segments of a clientId.UIViewParameter.getStringValue
(FacesContext context) If the value of this parameter comes from aValueExpression
return the value of the expression, otherwise, return the local value.UIViewParameter.getStringValueFromModel
(FacesContext context) Manually perform standard conversion steps to get a string value from the value expression.UIViewParameter.Reference.getUIViewParameter
(FacesContext context) Return theUIViewParameter
to which this instance refers.void
ContextCallback.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 theclientId
given as an argument toinvokeOnComponent
.boolean
UIComponent.invokeOnComponent
(FacesContext context, String clientId, ContextCallback callback) Starting at this component in the View hierarchy, search for a component with aclientId
equal to the argumentclientId
and, if found, call theContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argumentcallback
, passing the currentFacesContext
and the found component as arguments.boolean
UIComponentBase.invokeOnComponent
(FacesContext context, String clientId, ContextCallback callback) Starting at this component in the View hierarchy, search for a component with aclientId
equal to the argumentclientId
and, if found, call theContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argumentcallback
, passing the currentFacesContext
and the found component as arguments.boolean
UIData.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.boolean
UIForm.invokeOnComponent
(FacesContext context, String clientId, ContextCallback callback) static boolean
UIViewAction.isProcessingBroadcast
(FacesContext context) Returnstrue
if 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)
.void
UIComponent.popComponentFromEL
(FacesContext context) Pop the currentUIComponent
from theFacesContext
attributes map so that the previousUIComponent
, if any, becomes the current component.void
UIViewRoot.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 void
UIComponent.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.void
UIComponentBase.processDecodes
(FacesContext context) void
UIData.processDecodes
(FacesContext context) Override the defaultUIComponentBase.processDecodes(jakarta.faces.context.FacesContext)
processing to perform the following steps.void
UIForm.processDecodes
(FacesContext context) OverrideUIComponent.processDecodes(jakarta.faces.context.FacesContext)
to ensure that the form is decoded before its children.void
UIInput.processDecodes
(FacesContext context) Specialized decode behavior on top of that provided by the superclass.void
UIViewRoot.processDecodes
(FacesContext context) abstract void
UIComponent.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.void
UIComponentBase.processRestoreState
(FacesContext context, Object state) void
UIViewRoot.processRestoreState
(FacesContext context, Object state) The default implementation must callUIComponentBase.processRestoreState(jakarta.faces.context.FacesContext, java.lang.Object)
from within atry
block.abstract Object
UIComponent.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.UIComponentBase.processSaveState
(FacesContext context) abstract void
UIComponent.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.void
UIComponentBase.processUpdates
(FacesContext context) void
UIData.processUpdates
(FacesContext context) Override the defaultUIComponentBase.processUpdates(jakarta.faces.context.FacesContext)
processing to perform the following steps.void
UIForm.processUpdates
(FacesContext context) OverrideUIComponent.processUpdates(jakarta.faces.context.FacesContext)
to ensure that the children of thisUIForm
instance are only processed ifUIForm.isSubmitted()
returnstrue
.void
UIInput.processUpdates
(FacesContext context) In addition to the standardprocessUpdates
behavior inherited fromUIComponentBase
, callsupdateModel()
.void
UIViewRoot.processUpdates
(FacesContext context) abstract void
UIComponent.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.void
UIComponentBase.processValidators
(FacesContext context) void
UIData.processValidators
(FacesContext context) Override the defaultUIComponentBase.processValidators(jakarta.faces.context.FacesContext)
processing to perform the following steps.void
UIForm.processValidators
(FacesContext context) OverrideUIComponent.processValidators(jakarta.faces.context.FacesContext)
to ensure that the children of thisUIForm
instance are only processed ifUIForm.isSubmitted()
returnstrue
.void
UIInput.processValidators
(FacesContext context) In addition to the standardprocessValidators
behavior inherited fromUIComponentBase
, callsvalidate()
if theimmediate
property is false (which is the default); if the component is invalid afterwards, callsrenderResponse()
.void
UISelectOne.processValidators
(FacesContext context) IfUISelectOne.getGroup()
is set, andUIInput.getSubmittedValue()
is empty, and at least one other component having the same group within aUIForm
parent has a non-emptyUIInput.getSubmittedValue()
or returnstrue
onUIInput.isLocalValueSet()
or returnsfalse
onUIInput.isValid()
, then skip validation for current component, else perform standard superclass processing bysuper.processValidators(context)
.void
UIViewParameter.processValidators
(FacesContext context) Specialize superclass behavior to treatnull
differently.void
UIViewRoot.processValidators
(FacesContext context) void
UIComponent.pushComponentToEL
(FacesContext context, UIComponent component) Push the currentUIComponent
this
to theFacesContext
attribute map saving the previousUIComponent
for a subsequent call toUIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)
.void
UIViewRoot.removeComponentResource
(FacesContext context, UIComponent componentResource) Remove argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.removeComponentResource
(FacesContext context, UIComponent componentResource, String target) Remove argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.resetValues
(FacesContext context, Collection<String> clientIds) Visit the clientIds and, if the component is an instance ofEditableValueHolder
, call itsEditableValueHolder.resetValue()
method.static Object
UIComponentBase.restoreAttachedState
(FacesContext context, Object stateObj) This method is called byUIComponent
subclasses that need to restore the objects they saved usingUIComponentBase.saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)
.void
StateHolder.restoreState
(FacesContext context, Object state) Perform any processing required to restore the state from the entries in the state Object.void
UIComponentBase.restoreState
(FacesContext context, Object state) void
UIData.restoreState
(FacesContext context, Object state) void
UIInput.restoreState
(FacesContext context, Object state) void
UIOutput.restoreState
(FacesContext context, Object state) void
UIViewRoot.restoreState
(FacesContext context, Object state) void
TransientStateHolder.restoreTransientState
(FacesContext context, Object state) Restore the "transient state" using the object passed as state.void
UIComponent.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)
.void
UIViewRoot.restoreViewScopeState
(FacesContext context, Object state) Restore ViewScope state.static Object
UIComponentBase.saveAttachedState
(FacesContext context, Object attachedObject) This method is called byUIComponent
subclasses that want to save one or more attached objects.StateHolder.saveState
(FacesContext context) Gets the state of the instance as aSerializable
Object.UIComponentBase.saveState
(FacesContext context) UIData.saveState
(FacesContext context) UIInput.saveState
(FacesContext context) UIOutput.saveState
(FacesContext context) UIViewRoot.saveState
(FacesContext context) TransientStateHolder.saveTransientState
(FacesContext context) Return the object containing related "transient states".UIComponent.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.void
UIInput.updateModel
(FacesContext context) Perform the following algorithm to update the model data associated with thisUIInput
, if any, as appropriate.void
UIViewParameter.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.void
UIInput.validate
(FacesContext context) Perform the following algorithm to validate the local value of thisUIInput
.protected void
UIInput.validateValue
(FacesContext context, Object newValue) Set the "valid" property according to the below algorithm.protected void
UISelectMany.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 void
UISelectOne.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.ModifierConstructorDescriptionReference
(FacesContext context, UIViewParameter param, int indexInParent, String viewIdAtTimeOfConstruction) Construct a reference to aUIViewParameter
. -
Uses of FacesContext in jakarta.faces.component.behavior
Modifier and TypeMethodDescriptionabstract FacesContext
ClientBehaviorContext.getFacesContext()
Returns theFacesContext
for the current request.Modifier and TypeMethodDescriptionstatic ClientBehaviorContext
ClientBehaviorContext.createClientBehaviorContext
(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters) Creates a ClientBehaviorContext instance.void
ClientBehavior.decode
(FacesContext context, UIComponent component) Decode any new state of thisClientBehavior
from the request contained in the specifiedFacesContext
.void
ClientBehaviorBase.decode
(FacesContext context, UIComponent component) Default implementation of ofClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
.protected ClientBehaviorRenderer
ClientBehaviorBase.getRenderer
(FacesContext context) Convenience method to return theClientBehaviorRenderer
instance associated with thisClientBehavior
, if any; otherwise, returnnull
.void
AjaxBehavior.restoreState
(FacesContext context, Object state) void
BehaviorBase.restoreState
(FacesContext context, Object state) AjaxBehavior.saveState
(FacesContext context) BehaviorBase.saveState
(FacesContext context) Implementation ofStateHolder.saveState(jakarta.faces.context.FacesContext)
. -
Uses of FacesContext in jakarta.faces.component.search
Modifier and TypeMethodDescriptionabstract FacesContext
SearchExpressionContext.getFacesContext()
Returns the FacesContext for the current request.Modifier and TypeMethodDescriptionstatic SearchExpressionContext
SearchExpressionContext.createSearchExpressionContext
(FacesContext context, UIComponent source) Creates aSearchExpressionContext
instance for use with theSearchExpressionHandler
.static SearchExpressionContext
SearchExpressionContext.createSearchExpressionContext
(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints) Creates aSearchExpressionContext
instance 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 SearchExpressionContext
SearchExpressionContextFactory.getSearchExpressionContext
(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints) Creates aSearchExpressionContext
instance 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
Modifier and TypeMethodDescriptionabstract FacesContext
VisitContext.getFacesContext()
Returns the FacesContext for the current request.VisitContextWrapper.getFacesContext()
Modifier and TypeMethodDescriptionstatic VisitContext
VisitContext.createVisitContext
(FacesContext context) Creates a VisitContext instance for use withUIComponent.visitTree()
.static VisitContext
VisitContext.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 VisitContext
VisitContextFactory.getVisitContext
(FacesContext context, Collection<String> ids, Set<VisitHint> hints) Return a newVisitContext
instance. -
Uses of FacesContext in jakarta.faces.context
Modifier and TypeClassDescriptionclass
Provides a simple implementation ofFacesContext
that can be subclassed by developers wishing to provide specialized behavior to an existingFacesContext
instance.Modifier and TypeMethodDescriptionstatic FacesContext
FacesContext.getCurrentInstance()
Return theFacesContext
instance for the request that is being processed by the current thread.abstract FacesContext
FacesContextFactory.getFacesContext
(Object context, Object request, Object response, Lifecycle lifecycle) Create (if needed) and return aFacesContext
instance that is initialized for the processing of the specified request and response objects, utilizing the specifiedLifecycle
instance, for this web application.FacesContextWrapper.getWrapped()
Modifier and TypeMethodDescriptionabstract void
Flash.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.void
FlashWrapper.doPostPhaseActions
(FacesContext ctx) The default behavior of this method is to callFlash.doPostPhaseActions(FacesContext)
on the wrappedFlash
object.abstract void
Flash.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.void
FlashWrapper.doPrePhaseActions
(FacesContext ctx) The default behavior of this method is to callFlash.doPrePhaseActions(FacesContext)
on the wrappedFlash
object.abstract PartialViewContext
PartialViewContextFactory.getPartialViewContext
(FacesContext context) Create (if needed) and return aPartialViewContext
instance that is initialized using the currentFacesContext
instance.protected static void
FacesContext.setCurrentInstance
(FacesContext context) Set theFacesContext
instance for the request that is being processed by the current thread.ModifierConstructorDescriptionFacesContextWrapper
(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
Modifier and TypeMethodDescriptionBigDecimalConverter.getAsObject
(FacesContext context, UIComponent component, String value) BigIntegerConverter.getAsObject
(FacesContext context, UIComponent component, String value) BooleanConverter.getAsObject
(FacesContext context, UIComponent component, String value) ByteConverter.getAsObject
(FacesContext context, UIComponent component, String value) CharacterConverter.getAsObject
(FacesContext context, UIComponent component, String value) Converter.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.DateTimeConverter.getAsObject
(FacesContext context, UIComponent component, String value) DoubleConverter.getAsObject
(FacesContext context, UIComponent component, String value) EnumConverter.getAsObject
(FacesContext context, UIComponent component, String value) Convert thevalue
argument to one of the enum constants of the class provided in our constructor.FloatConverter.getAsObject
(FacesContext context, UIComponent component, String value) IntegerConverter.getAsObject
(FacesContext context, UIComponent component, String value) LongConverter.getAsObject
(FacesContext context, UIComponent component, String value) NumberConverter.getAsObject
(FacesContext context, UIComponent component, String value) ShortConverter.getAsObject
(FacesContext context, UIComponent component, String value) UUIDConverter.getAsObject
(FacesContext context, UIComponent component, String value) BigDecimalConverter.getAsString
(FacesContext context, UIComponent component, Object value) BigIntegerConverter.getAsString
(FacesContext context, UIComponent component, Object value) BooleanConverter.getAsString
(FacesContext context, UIComponent component, Object value) ByteConverter.getAsString
(FacesContext context, UIComponent component, Object value) CharacterConverter.getAsString
(FacesContext context, UIComponent component, Object value) Converter.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.DateTimeConverter.getAsString
(FacesContext context, UIComponent component, Object value) DoubleConverter.getAsString
(FacesContext context, UIComponent component, Object value) EnumConverter.getAsString
(FacesContext context, UIComponent component, Object value) Convert the enum constant given by thevalue
argument into a String.FloatConverter.getAsString
(FacesContext context, UIComponent component, Object value) IntegerConverter.getAsString
(FacesContext context, UIComponent component, Object value) LongConverter.getAsString
(FacesContext context, UIComponent component, Object value) NumberConverter.getAsString
(FacesContext context, UIComponent component, Object value) ShortConverter.getAsString
(FacesContext context, UIComponent component, Object value) UUIDConverter.getAsString
(FacesContext context, UIComponent component, UUID value) void
DateTimeConverter.restoreState
(FacesContext context, Object state) void
EnumConverter.restoreState
(FacesContext facesContext, Object object) void
NumberConverter.restoreState
(FacesContext context, Object state) DateTimeConverter.saveState
(FacesContext context) EnumConverter.saveState
(FacesContext facesContext) NumberConverter.saveState
(FacesContext context) -
Uses of FacesContext in jakarta.faces.event
Modifier and TypeMethodDescriptionExceptionQueuedEventContext.getContext()
TheFacesContext
for this request.FacesEvent.getFacesContext()
Get the Faces context.PhaseEvent.getFacesContext()
Return theFacesContext
for the request being processed.SystemEvent.getFacesContext()
Get the Faces context.Modifier and TypeMethodDescriptionvoid
MethodExpressionActionListener.restoreState
(FacesContext context, Object state) BothMethodExpression
instances described in the constructor must be restored.void
MethodExpressionValueChangeListener.restoreState
(FacesContext context, Object state) BothMethodExpression
instances described in the constructor must be restored.MethodExpressionActionListener.saveState
(FacesContext context) BothMethodExpression
instances described in the constructor must be saved.MethodExpressionValueChangeListener.saveState
(FacesContext context) BothMethodExpression
instances described in the constructor must be saved.ModifierConstructorDescriptionActionEvent
(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 argumentcomponent
to the superclass constructor.ExceptionQueuedEvent
(FacesContext facesContext, ExceptionQueuedEventContext eventContext) Instantiate a newExceptionQueuedEvent
that indicates the argumentExceptionQueuedEventContext
occurred.ExceptionQueuedEventContext
(FacesContext context, Throwable thrown) Instantiate a newExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred.ExceptionQueuedEventContext
(FacesContext context, Throwable thrown, UIComponent component) Instantiate a newExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
.ExceptionQueuedEventContext
(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId) Instantiate a newExceptionQueuedEventContext
that indicates the argumentThrowable
just 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 newPostAddToViewEvent
that indicates the argumentcomponent
was just added to the view.PostConstructApplicationEvent
(FacesContext facesContext, Application application) Constructs a newPostConstructApplicationEvent
for this application.PostConstructCustomScopeEvent
(FacesContext facesContext, ScopeContext scopeContext) Deprecated, for removal: This API element is subject to removal in a future version.An instance of this event indicates that the custom scope enclosed within the argumentscopeContext
was just created.PostConstructViewMapEvent
(FacesContext facesContext, UIViewRoot root) Instantiate a newPostConstructViewMapEvent
that indicates the argumentroot
was just associated with its view map.PostKeepFlashValueEvent
(FacesContext facesContext, String key) Instantiate a newPostKeepFlashValueEvent
that indicates the argumentkey
was just kept in the flash.PostPutFlashValueEvent
(FacesContext facesContext, String key) Instantiate a newPostPutFlashValueEvent
that indicates the argumentkey
was just put to the flash.PostRenderViewEvent
(FacesContext facesContext, UIViewRoot root) Instantiate a newPostRenderViewEvent
that indicates the argumentroot
has just been rendered.PostRestoreStateEvent
(FacesContext facesContext, UIComponent component) Instantiate a newPostRestoreStateEvent
that indicates the argumentcomponent
just had its state restored.PostValidateEvent
(FacesContext facesContext, UIComponent component) ConstructorPreClearFlashEvent
(FacesContext facesContext, Map<String, Object> source) Instantiate a newPreClearFlashEvent
that indicates the argumentkey
was just put to the flash.PreDestroyApplicationEvent
(FacesContext facesContext, Application application) Constructs a newPreDestroyApplicationEvent
for this application.PreDestroyCustomScopeEvent
(FacesContext facesContext, ScopeContext scopeContext) Deprecated, for removal: This API element is subject to removal in a future version.An instance of this event indicates that the custom scope enclosed within the argumentscopeContext
is about to end.PreDestroyViewMapEvent
(FacesContext facesContext, UIViewRoot root) Instantiate a newViewMapDestroydEvent
that indicates the argumentroot
just had its associated view map destroyed.PreRemoveFlashValueEvent
(FacesContext facesContext, String key) Instantiate a newPreRemoveFlashValueEvent
that indicates the argumentkey
will be removed from the flash.PreRemoveFromViewEvent
(FacesContext facesContext, UIComponent component) Instantiate a newBeforeRemoveFromView
that indicates the argumentcomponent
is about to be removed from the view.PreRenderComponentEvent
(FacesContext facesContext, UIComponent component) Instantiate a newPreRenderComponentEvent
that indicates the argumentcomponent
is about to be rendered.PreRenderViewEvent
(FacesContext facesContext, UIViewRoot root) Instantiate a newPreRenderViewEvent
that indicates the argumentroot
is about to be rendered.PreValidateEvent
(FacesContext facesContext, UIComponent component) ConstructorSystemEvent
(FacesContext facesContext, Object source) Pass the argumentsource
to 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
Modifier and TypeMethodDescriptionabstract void
FlowHandler.addFlow
(FacesContext context, Flow toAdd) Add the argumentFlow
to the collection ofFlow
s known to the current application.abstract void
FlowHandler.clientWindowTransition
(FacesContext context) Allow for flow transitions in the case of components rendered by the renderers from component-familyjakarta.faces.OutcomeTarget
.abstract FlowHandler
FlowHandlerFactory.createFlowHandler
(FacesContext context) Create the singleton instance ofFlowHandler
.FlowHandlerFactoryWrapper.createFlowHandler
(FacesContext context) abstract String
FlowCallNode.getCalledFlowDocumentId
(FacesContext context) abstract String
FlowCallNode.getCalledFlowId
(FacesContext context) abstract Boolean
SwitchCase.getCondition
(FacesContext context) Returntrue
if this case should be taken,false
otherwise.abstract Flow
FlowHandler.getCurrentFlow
(FacesContext context) abstract String
SwitchNode.getDefaultOutcome
(FacesContext context) Return the default outcome in this switch.abstract Flow
FlowHandler.getFlow
(FacesContext context, String definingDocumentId, String id) Return theFlow
whoseid
is equivalent to the argumentid
, within the scope of the argumentdefiningDocument
.abstract String
ReturnNode.getFromOutcome
(FacesContext context) Return thefromOutcome
to be used when control passes to this return node.abstract String
FlowHandler.getLastDisplayedViewId
(FacesContext context) Return the last displayed viewId for the current flow, as returned byFlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext)
, ornull
if there is no current flow.abstract boolean
FlowHandler.isActive
(FacesContext context, String definingDocument, String id) Returntrue
if and only if the flow referenced by the argumentdefiningDocument
andid
is currently active.abstract void
FlowHandler.popReturnMode
(FacesContext context) Enable the correct handling of navigation when processing a return node.abstract void
FlowHandler.pushReturnMode
(FacesContext context) Enable the correct handling of navigation when processing a return node.abstract void
FlowHandler.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
Modifier and TypeMethodDescriptionvoid
Lifecycle.attachWindow
(FacesContext context) Create or restore theClientWindow
to be used to display theUIViewRoot
for this run through the lifecycle.void
LifecycleWrapper.attachWindow
(FacesContext context) abstract void
ClientWindow.decode
(FacesContext context) The implementation is responsible for examining the incoming request and extracting the value that must be returned from theClientWindow.getId()
method.void
ClientWindowWrapper.decode
(FacesContext context) void
ClientWindow.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.void
ClientWindowWrapper.disableClientWindowRenderMode
(FacesContext context) void
ClientWindow.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.void
ClientWindowWrapper.enableClientWindowRenderMode
(FacesContext context) abstract void
Lifecycle.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.void
LifecycleWrapper.execute
(FacesContext context) abstract ClientWindow
ClientWindowFactory.getClientWindow
(FacesContext context) The implementation is responsible for creating theClientWindow
instance for this request.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.ClientWindowWrapper.getQueryURLParameters
(FacesContext context) boolean
ClientWindow.isClientWindowRenderModeEnabled
(FacesContext context) Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.boolean
ClientWindowWrapper.isClientWindowRenderModeEnabled
(FacesContext context) abstract void
Lifecycle.render
(FacesContext context) Execute the Render Response phase of the request processing lifecycle, unless theresponseComplete()
method has been called on theFacesContext
instance associated with the current request.void
LifecycleWrapper.render
(FacesContext context) -
Uses of FacesContext in jakarta.faces.render
Modifier and TypeMethodDescriptionRenderer.convertClientId
(FacesContext context, String clientId) Convert the component generated client id to a form suitable for transmission to the client.RendererWrapper.convertClientId
(FacesContext context, String clientId) void
ClientBehaviorRenderer.decode
(FacesContext context, UIComponent component, ClientBehavior behavior) Decode any new state of thisClientBehavior
from the request contained in the specifiedFacesContext
.void
Renderer.decode
(FacesContext context, T component) Decode any new state of the specifiedUIComponent
from the request contained in the specifiedFacesContext
, and store that state on theUIComponent
.void
RendererWrapper.decode
(FacesContext context, UIComponent component) void
Renderer.encodeBegin
(FacesContext context, T component) Render the beginning specifiedUIComponent
to the output stream or writer associated with the response we are creating.void
RendererWrapper.encodeBegin
(FacesContext context, UIComponent component) void
Renderer.encodeChildren
(FacesContext context, T component) Render the child components of thisUIComponent
, following the rules described forencodeBegin()
to acquire the appropriate value to be rendered.void
RendererWrapper.encodeChildren
(FacesContext context, UIComponent component) void
Renderer.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.void
RendererWrapper.encodeEnd
(FacesContext context, UIComponent component) Renderer.getConvertedValue
(FacesContext context, T component, Object submittedValue) Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registeredConverter
for this component, if there is one).RendererWrapper.getConvertedValue
(FacesContext context, UIComponent component, Object submittedValue) ResponseStateManager.getCryptographicallyStrongTokenFromSession
(FacesContext context) Compliant implementations must return a cryptographically strong token for use to protect views in this application.abstract RenderKit
RenderKitFactory.getRenderKit
(FacesContext context, String renderKitId) Return aRenderKit
instance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specifiedFacesContext
, if non-null
.ResponseStateManager.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)
.ResponseStateManager.getViewState
(FacesContext context, Object state) Return the specified state as aString
without any markup related to the rendering technology supported by this ResponseStateManager.boolean
ResponseStateManager.isPostback
(FacesContext context) Return true if the current request is a postback.boolean
ResponseStateManager.isStateless
(FacesContext context, String viewId) If the preceding call toResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
was stateless, returntrue
.void
ResponseStateManager.writeState
(FacesContext context, Object state) Take the argumentstate
and write it into the output using the currentResponseWriter
, which must be correctly positioned already. -
Uses of FacesContext in jakarta.faces.validator
Modifier and TypeMethodDescriptionvoid
BeanValidator.restoreState
(FacesContext context, Object state) void
DoubleRangeValidator.restoreState
(FacesContext context, Object state) void
LengthValidator.restoreState
(FacesContext context, Object state) void
LongRangeValidator.restoreState
(FacesContext context, Object state) void
MethodExpressionValidator.restoreState
(FacesContext context, Object state) void
RegexValidator.restoreState
(FacesContext context, Object state) BeanValidator.saveState
(FacesContext context) DoubleRangeValidator.saveState
(FacesContext context) LengthValidator.saveState
(FacesContext context) LongRangeValidator.saveState
(FacesContext context) MethodExpressionValidator.saveState
(FacesContext context) RegexValidator.saveState
(FacesContext context) void
BeanValidator.validate
(FacesContext context, UIComponent component, Object value) Verify that the value is valid according to the Bean Validation constraints.void
DoubleRangeValidator.validate
(FacesContext context, UIComponent component, Object value) void
LengthValidator.validate
(FacesContext context, UIComponent component, Object value) void
LongRangeValidator.validate
(FacesContext context, UIComponent component, Object value) void
MethodExpressionValidator.validate
(FacesContext context, UIComponent component, Object value) void
RegexValidator.validate
(FacesContext context, UIComponent component, Object value) Validate a String against a regular expression pattern.void
RequiredValidator.validate
(FacesContext context, UIComponent component, Object value) Verify that the converted object value is not null.void
Validator.validate
(FacesContext context, UIComponent component, T value) -
Uses of FacesContext in jakarta.faces.view
Modifier and TypeMethodDescriptionvoid
AttachedObjectHandler.applyAttachedObject
(FacesContext context, UIComponent parent) Take the argumentparent
and apply this attached object to it.abstract void
ViewDeclarationLanguage.buildView
(FacesContext context, UIViewRoot root) Take any actions specific to this VDL implementation to cause the argumentUIViewRoot
which must have been created via a call toViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String)
, to be populated with children.void
ViewDeclarationLanguageWrapper.buildView
(FacesContext context, UIViewRoot root) 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
.ViewDeclarationLanguageWrapper.calculateResourceLibraryContracts
(FacesContext context, String viewId) ViewDeclarationLanguage.createComponent
(FacesContext context, String taglibURI, String tagName, Map<String, Object> attributes) Create a component given aViewDeclarationLanguage
specific tag library URI and tag name.ViewDeclarationLanguageWrapper.createComponent
(FacesContext context, String taglibURI, String tagName, Map<String, Object> attributes) abstract UIViewRoot
ViewMetadata.createMetadataView
(FacesContext context) Creates a newUIViewRoot
containing only view parameter metadata.abstract UIViewRoot
ViewDeclarationLanguage.createView
(FacesContext context, String viewId) Create aUIViewRoot
from the VDL contained in the artifact referenced by the argumentviewId
.ViewDeclarationLanguageWrapper.createView
(FacesContext context, String viewId) abstract BeanInfo
ViewDeclarationLanguage.getComponentMetadata
(FacesContext context, Resource componentResource) Return a reference to the component metadata for the composite component represented by the argumentcomponentResource
, ornull
if the metadata cannot be found.ViewDeclarationLanguageWrapper.getComponentMetadata
(FacesContext context, Resource componentResource) abstract Resource
ViewDeclarationLanguage.getScriptComponentResource
(FacesContext context, Resource componentResource) Take implementation specific action to discover aResource
given the argumentcomponentResource
.ViewDeclarationLanguageWrapper.getScriptComponentResource
(FacesContext context, Resource componentResource) abstract StateManagementStrategy
ViewDeclarationLanguage.getStateManagementStrategy
(FacesContext context, String viewId) For implementations that want to control the implementation of state saving and restoring, theStateManagementStrategy
allows them to do so.ViewDeclarationLanguageWrapper.getStateManagementStrategy
(FacesContext context, String viewId) abstract ViewMetadata
ViewDeclarationLanguage.getViewMetadata
(FacesContext context, String viewId) Return a reference to the view metadata for the view represented by the argumentviewId
, ornull
if the metadata cannot be found.ViewDeclarationLanguageWrapper.getViewMetadata
(FacesContext context, String viewId) ViewDeclarationLanguage.getViews
(FacesContext facesContext, String path, int maxDepth, ViewVisitOption... options) Return aStream
possibly lazily populated by walking the view tree rooted at a given initial path.ViewDeclarationLanguage.getViews
(FacesContext facesContext, String path, ViewVisitOption... options) Return aStream
possibly lazily populated by walking the view tree rooted at a given initial path.ViewDeclarationLanguageWrapper.getViews
(FacesContext context, String path, int maxDepth, ViewVisitOption... options) ViewDeclarationLanguageWrapper.getViews
(FacesContext context, String path, ViewVisitOption... options) abstract void
ViewDeclarationLanguage.renderView
(FacesContext context, UIViewRoot view) Render a view rooted at argumentview
.void
ViewDeclarationLanguageWrapper.renderView
(FacesContext context, UIViewRoot view) abstract UIViewRoot
StateManagementStrategy.restoreView
(FacesContext context, String viewId, String renderKitId) Restore the state of the view with information in the request.abstract UIViewRoot
ViewDeclarationLanguage.restoreView
(FacesContext context, String viewId) Restore aUIViewRoot
from a previously created view.ViewDeclarationLanguageWrapper.restoreView
(FacesContext context, String viewId) void
ViewDeclarationLanguage.retargetAttachedObjects
(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers) Assuming the component metadata for argumenttopLevelComponent
has 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 individualAttachedObjectTarget
instances inside the composite component.void
ViewDeclarationLanguageWrapper.retargetAttachedObjects
(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers) void
ViewDeclarationLanguage.retargetMethodExpressions
(FacesContext context, UIComponent topLevelComponent) Assuming the component metadata for argumenttopLevelComponent
has 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.void
ViewDeclarationLanguageWrapper.retargetMethodExpressions
(FacesContext context, UIComponent topLevelComponent) abstract Object
StateManagementStrategy.saveView
(FacesContext context) Return the state of the current view in anObject
that implementsSerializable
and can be passed tojava.io.ObjectOutputStream.writeObject()
without causing ajava.io.NotSerializableException
to be thrown. The default implementation must perform the following algorithm or its semantic equivalent, explicitly performing all the steps listed here.boolean
ViewDeclarationLanguage.viewExists
(FacesContext context, String viewId) Tests whether a physical resource corresponding to the specified viewId exists.boolean
ViewDeclarationLanguageWrapper.viewExists
(FacesContext context, String viewId) -
Uses of FacesContext in jakarta.faces.view.facelets
Modifier and TypeMethodDescriptionabstract FacesContext
FaceletContext.getFacesContext()
The current FacesContext bound to this "request".Modifier and TypeMethodDescriptionabstract void
Facelet.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.final void
FaceletsAttachedObjectHandler.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
.void
Facelet.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:metadata
tag.