ConfigProcessor that all concrete ConfigProcessor implementations should
extend.ConverterTags.ValidatorTags.
An ActionEvent represents the activation of a user interface component (such as a UICommand).
Construct a new event object from the specified source component and action command.
Construct a new event object from the Faces context, specified source component and action command.
ActionEvents.immediate property of the
ActionSource that queued this event.ActionListener instance and registers it on the UIComponent
associated with our most immediate surrounding instance of a tag whose implementation class is a subclass of
UIComponentClassicTagBase.
Provides a simple implementation of ActionListener that can be subclassed by developers wishing to provide
specialized behavior to an existing ActionListener instance.
UIComponent that wishes
to be a source of ActionEvents, including the ability to invoke application actions via the default
ActionListener mechanism.ActionSource and provides a JavaBeans property analogous to the
"action" property on ActionSource.
A VDL handler that exposes ActionListener to a page author.
A marker interface for VDL tags that represent <composite:actionSource/> for use by the
composite component page author.
ResourceInfo to the internal cache.true if it's accepted (i.e.
Store the specified value in a List that is internal to the StateHelper.
Add another Metadata to this ruleset, returning this.
ActionListener to the set of listeners interested in being notified when ActionEvents
occur.ActionListener to the set of listeners interested in being notified when ActionEvents
occur.
Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from
this AjaxBehavior.
Behavior class.
The default behavior of this method is to call Application.addBehavior(String, String) on the wrapped
Application object.
Add the specified BehaviorListener to the set of listeners registered to receive event notifications from
this Behavior.
UIComponent to the list of component identifiers created or
located by nested UIComponentTags processing this request.
Attaches a ClientBehavior to the component implementing this interface for the specified event.
This is a default implementation of ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior).
ClientBehaviorRenderer instance, associated with the specified component
type, to the set of ClientBehaviorRenderers registered with this RenderKit, replacing
any previously registered ClientBehaviorRenderer for this type.RenderKit.addClientBehaviorRenderer(String, ClientBehaviorRenderer) on the wrapped RenderKit object.Add the child component to the parent.
UIComponent class.
The default behavior of this method is to call Application.addComponent(String, String) on the wrapped
Application object.
Add argument component, which is assumed to represent a resource instance, as a resource to this view.
Add argument component, which is assumed to represent a resource instance, as a resource to this view.
Converter class.
The default behavior of this method is to call Application.addConverter(String, String) on the wrapped
Application object.
The default behavior of this method is to call Application.addConverter(Class, String) on the wrapped
Application object.
DataModelListener to the set interested in notifications from this DataModel.
Register a validator by its id that is applied to all UIInput components in a view.
The default behavior of this method is to call Application.addDefaultValidatorId(String) on the wrapped
Application object.
EditableValueHolder.ELContextListener that will be notified on creation
of ELContext instances.
The default behavior of this method is to call Application.addELContextListener(jakarta.el.ELContextListener)
on the wrapped Application object.
resolver to be added to the
resolver chain as specified in section 5.5.1 of the Jakarta Server Faces Specification.
The default behavior of this method is to call
Application.addELResolver(jakarta.el.ELResolver) on the wrapped Application object.
FacesListener to the set of listeners registered to receive event notifications from this
UIComponent.FacesListener to the set of listeners registered to receive event notifications from this
UIComponent.UIComponentTags processing this request.
Add the argument Flow to the collection of Flows known to the current application.
Lifecycle instance, associated with the specified lifecycleId, to be supported by
this LifecycleFactory.FacesMessage to the set of messages associated with the specified client
identifier, if clientId is not null.FacesContext.addMessage(String, FacesMessage) on the wrapped
FacesContext object.PhaseListener instance that is interested in being notified before and after the processing
for standard phases of the request processing lifecycle.
Add the argument urlPattern to the thread safe Set of protected views for this application.
ViewHandler.addProtectedView(java.lang.String) on the wrapped
ViewHandler object.RenderKit.addRenderer(String, String, Renderer) on the wrapped
RenderKit object.RenderKit instance, associated with the specified renderKitId, to be
supported by this RenderKitFactory, replacing any previously registered RenderKit for this
identifier.Adds the cookie represented by the arguments to the response.
ExternalContext.addResponseCookie(String, String, Map) on the
wrapped ExternalContext object.Add the given name and value to the response header.
ExternalContext.addResponseHeader(String,String) on the
wrapped ExternalContext object.
Add another MetaRule to this ruleset, returning this.
Cause the argument resolver to be added to the head of the resolver chain.
Validator class.
The default behavior of this method is to call Application.addValidator(String, String) on the wrapped
Application object.
Validator instance to the set associated with this component.ValidatorInfo instances present on the stack, configure the argument
EditableValueHolder with Validators created from the available info.ValueChangeListener to the set of listeners interested in being notified when
ValueChangeEvents occur.ValueChangeListener to the set of listeners interested in being notified when
ValueChangeEvents occur.
An instance of this class is added as a
ClientBehavior to a component using the
ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior) contract that components implement.
Ajax).Construct a new event object from the specified source component and Ajax behavior.
Construct a new event object from the Faces context, specified source component and Ajax behavior.
By implementing this class, an object indicates that it is a listener for one or more kinds of
BehaviorEvents.
An instance of the class is used to manage AjaxBehavior instances.
ExceptionHandler for Faces that handles exceptions by writing error
information to the partial response.Enable one or more components in the view to perform Ajax operations.
Customize this MetaRuleset by removing the attribute named by argument attribute and
re-adding it under the name given by the argument property, returning this.
This unmodifiable Collection is returned by getIdsToVisit() and getSubtreeIdsToVisit() in
cases where all ids should be visited.
The value that when used with PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME or PartialViewContext.PARTIAL_RENDER_PARAM_NAME indicates
these phases must be skipped.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.
AnnotationScanner instance.ApplicationFactory class name.ConfigProcessor handles all elements defined under /faces-config/application.
This class defines a java.util.ServiceLoader service which enables programmatic configuration of the Jakarta
Server Faces runtime using the existing Application Configuration Resources schema.
Application instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ApplicationFactory.
The presence of this annotation (along with @Inject) on a field of type Map<String,
Object> causes the map returned from ExternalContext.getApplicationMap() to be
injected as the value of that field.
@ApplicationMap.The ApplicationMapProducer is the CDI producer that allows injection of the application map using @Inject and allows EL resolving of #{applicationScope}
The ApplicationProducer is the CDI producer that allows EL resolving of #{application}
jakarta.enterprise.context.ApplicationScoped, which is a CDI build-in
scope with similar semantics.
Provides a simple implementation of Application that can be
subclassed by developers wishing to provide specialized behavior to an existing Application instance.
If this application has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
this that is applicable given the ELContext and ExpressionFactory state.Calls apply on any child handlers.
The default implementation simply calls through to TagHandlerDelegate.apply(jakarta.faces.view.facelets.FaceletContext, jakarta.faces.component.UIComponent).
Process changes on a particular UIComponent
Called by classes that implement
FaceletHandler in their implementation of apply().
Take the argument parent and apply this attached object to it.
Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this
class to the argument parent.
Behavior instances.ClientBehaviorRenderer instances.UIComponent instances.Collection of annotated classes.Converter instances.Take the action prescribed in the Jakarta Server Faces specification for this particular VDL element attribute.
Invoke the apply() method on this instance's TagHandler.nextHandler.
Renderer instances.processDecodes on each component in the tree so that it may update it's
current value from the information included in the current request (parameters, headers, c cookies and so on.)
Return an abstraction that takes appropriate action given the kind of rule represented by the argument
name, in the context of this particular concrete subclass of MetaRule.
Validator instances.DataModel that wraps an array of Java
objects.ArrayDataModel with no specified wrapped data.ArrayDataModel wrapping the specified array.
The key in the value set of the composite component BeanDescriptor, the value for which is a
List<AttachedObjectTarget>.
This class holds collection of BehaviorHandler instances, attached to the composite component.
The abstract base interface for a handler representing an attached object in a VDL page.
Within the declaration of a composite component, an AttachedObjectTarget allows the
composite component author to expose the semantics of an inner component to the page author without
exposing the rendering or implementation details of the inner component.
Create or restore the ClientWindow to be used to display the UIViewRoot for
this run through the lifecycle.
An interface that allows other code to identify FaceletHandlers that correspond to component attributes.
This constant enables one to quickly discover the names of the declared composite component attributes that have been given default values by the composite component author.
The value of this constant is used as the key in the component attribute map, the value for which is a
java.beans.BeanInfo implementation describing the composite component.
A Validator that delegates validation of the bean property to the Bean Validation API.
The Behavior interface is the root API of the component behavior model.
The request parameter name whose request parameter value identifies the type of behavior event.
The standard id for this behavior.
The request parameter name whose request parameter value identifies the source component of behavior event.
BehaviorBase is a convenience base class that provides a default implementation of the
Behavior contract.
Convey the id of a behavior declared in a view.
ConfigAnnotationHandler for FacesBehavior annotated classes.ConfigProcessor handles all elements defined under /faces-config/behavior.Behavior.
Construct a new event object from the specified source component and behavior.
Construct a new event object from the Faces context, specified source component and behavior.
The FaceletHandler that corresponds to attached objects that represent an instance of
ClientBehavior that must be added to the parent component, which must
implement ClientBehaviorHolder, with a call to
ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior).
Represent an attached object that is a BehaviorHolder in a VDL page.
Represent a BehaviorHolder attached object target in a VDL page.
A generic base interface for event listeners for various types of BehaviorEvents.
Converter implementation for java.math.BigDecimal values.FacesMessage to be created if the conversion to
BigInteger fails.Converter implementation for java.math.BigInteger values.ValueExpression that evaluates to an object that implements
Converter.ValueExpression that evaluates to an object that implements
Converter.bodyContent for this tag handler.Renderer is responsible for rendering the standard HTML body element as well as rendering any
resources that should be output before the body tag is closed.FacesMessage to be created if the conversion to
Boolean fails.Converter implementation for java.lang.Boolean (and boolean primitive) values.
Broadcast the specified BehaviorEvent to all registered event listeners who have expressed an interest in
events of this type.
Default implementation of Behavior.broadcast(jakarta.faces.event.BehaviorEvent).
UIComponent.broadcast(jakarta.faces.event.FacesEvent) processing, pass the ActionEvent being broadcast
to the method referenced by actionListener (if any), and to the default ActionListener
registered on the Application.FacesEvent to all registered event listeners who have expressed an interest in events
of this type.UIComponentBase.broadcast(jakarta.faces.event.FacesEvent) processing to unwrap any wrapped FacesEvent and reset
the current row index, before the event is actually broadcast.
Enable the method invocation specified by this component instance to return a value that performs navigation, similar
in spirit to UICommand.broadcast(jakarta.faces.event.FacesEvent).
Broadcast any events that have been queued.
ELResolver chain for programmatic EL calls.ELResolver chain for JSP.
Take any actions specific to this VDL implementation to cause the argument
UIViewRoot which must have been created via a call to ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String), to be populated with
children.
UICommand as a Button.FacesMessage to be created if the conversion to
Byte fails.Ciphers to
ResponseStateManager implementations wishing to provide encryption support.Ciphers to
ResponseStateManager implementations wishing to provide encryption support.Converter implementation for java.lang.Byte (and byte primitive) values.Factory.ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext) on the wrapped ViewHandler
object.ViewHandlingStrategy instances.Locale to use for this and subsequent requests for the current client.ViewHandler.calculateLocale(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.ViewHandlingStrategy instances.renderKitId for this and subsequent requests from the current client.ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext) on the wrapped ViewHandler
object.
Return the list of resource library contracts that will be made available for use in the view specified by the
argument viewId.
ELResolver for Faces.FacesMessage to be created if the conversion to
Character fails.Converter implementation for java.lang.Character (and char primitive) values.UISelectBoolean as a checkbox.component.ResourceHelper implementation for finding/serving resources found on the classpath within the
META-INF/resources directory.
The default behavior of this method is to call Map.clear() on the wrapped Flash object.
ClassLoader.Clears the initial state flag, causing the behavior to revert from partial to full state saving.
Reset the PartialStateHolder to a non-delta tracking state.
An implementation of PartialStateHolder.clearInitialState(), this method is called by the runtime to tell the
instance to stop tracking state changes.
For each of the attached objects on this instance that implement PartialStateHolder, call
PartialStateHolder.clearInitialState() on the attached object.
ClientWindowFactory class name.
The context-param that controls the operation of the ClientWindow feature.
The name of the hidden field that refers to the encoded ClientWindow.
The name of the URL query parameter for transmitting the client window id.
Accept-Encoding requester header.
ClientBehavior is the base contract for Behaviors that attach script content to client-side
events exposed by ClientBehaviorHolder components.
ClientBehaviorBase is a convenience base class that implements the default concrete behavior of all
methods defined by ClientBehavior.
ClientBehaviorContext provides context information that may be useful
to ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext) implementations.
Parameter instances represent name/value pairs that "submitting" ClientBehavior implementations should include when posting back into the Faces lifecycle.
An enum that specifies hints that describes the behavior of ClientBehavior implementations.
The ClientBehaviorHolder interface may be implemented by any concrete
UIComponent that wishes to support client behaviors as defined by
ClientBehavior.
ClientBehavior's client-side logic.ClientResourceInfo is a simple wrapper class for information pertinent to building a complete resource
path using a Library.ClientResourceInfo using the specified details.StateHelper provides the functionality associated with client-side state saving.ClientSideStateHelper instance.Writer implementation to encapsulate a StringBuilder instance.
This class represents a client window, which may be a browser tab, browser window, browser pop-up, portlet, or
anything else that can display a UIComponent hierarchy rooted at a
UIViewRoot.
Create ClientWindow instances based on the incoming request.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Allow for flow transitions in the case of components rendered by the renderers from component-family
jakarta.faces.OutcomeTarget.
Wrapper for ClientWindow
If this client window has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Cloneable facility.clone method on the provided value.ResponseWriter using a different Writer.ResponseWriter, using the specified Writer as the
output destination.ResponseWriter.cloneWithWriter(java.io.Writer) on the wrapped
ResponseWriter object.java.io.WriterWriter.close() on the wrapped ResponseWriter
object.null object of the argument list, or null if there is no such
element.Class and Annotation to be processed later by
ConfigAnnotationHandler.push(jakarta.faces.context.FacesContext).
CollectionDataModel is a convenience implementation of DataModel that wraps an
Collection of Java objects.
CollectionDataModel with no specified wrapped data.CollectionDataModel wrapping the specified list.UICommand as a HyperLink that
acts like a Button.UICommand as a Script that acts
like an Ajax Button.FacesMessage.Severity instance to the specified one.PhaseId instance to the specified one.true if the new value is different from the previous value.true if the new value is different from the previous value.
This constant is used as the key in the component attribute map of a composite component to associate the component
with its Resource instance.
Passed to the constructor of ComponentHandler.
ConfigAnnotationHandler for FacesComponent annotated classes.ConfigProcessor handles all elements defined under /faces-config/component.
Public base class for markup element instances that map to
UIComponent instances in the view.
Leverage the TagHandlerDelegateFactory provided by the implementation to create an instance of
TagHandlerDelegate designed for use with ComponentHandler.
Typed FacesException for the SearchExpressionHandler, if a component can't be resolved.
Construct a new exception with no detail message or root cause.
Construct a new exception with the specified detail message and no root cause.
Construct a new exception with the specified root cause.
Construct a new exception with the specified detail message and root cause.
The Component producer is the CDI producer that allows EL resolving of #{component}
ComponentTagHandlerDelegateImpl in order to properly find existing
component resources as well as properly handling the case when this concrete implementations of this class are
applied more than once for a particular request.SystemEvents that are specific to a UIComponent instance.
Pass the argument component to the superclass constructor.
Pass the argument component to the superclass constructor.
UIComponent events.
Implementors of this class do not need an isListenerForSource() method because they are only installed
on specific component instances, therefore the isListenerForSource() method is implicit.
EditableValueHolder instances within the view.
The value of this constant is used as the key in the composite component BeanDescriptor for a
ValueExpression that evaluates to the component-type of the composite component
root UIComponent for this composite component, if one was declared by the composite component
author.
The value of this constant is used as the key in the Map returned as described in UIComponent.FACETS_KEY
for the PropertyDescriptor describing the composite component facet.
ELResolver will handle the resolution of attrs when processing a composite component
instance.Map returned by the composite component
ELResolver, described in section 5.6.2.2 of the specification, when evaluating
#{cc.attrs} expressions.
The Composite Component producer is the CDI producer that allows EL resolving of #{cc}
CompositeComponentStackManager is responsible for managing the two different composite component stacks
currently used by Mojarra.A FaceletHandler that is derived of 1 or more, inner FaceletHandlers.
Renderer is responsible for rendering the content of a facet defined within the using page
template in the desired location within the composite component implementation section.null.Renderer is responsible for rendering the children defined within the composite implementation
section of a composite component template.null.ClientResourceInfo.getCompressedPath().Factory.Set the if of the current navigation case.
Set the if of the current navigation case.
Set the if in the previously created switch case.
Set the if in the previously created switch case.
/WEB-INF/faces-config.xml which is loaded automatically if it exists) containing Jakarta Server Faces
configuration information.
ConfigurableNavigationHandler extends the contract of
NavigationHandler to allow runtime inspection of the NavigationCases that make up the rule-base for
navigation.
Provides a simple implementation of ConfigurableNavigationHandler
that can be subclassed by developers wishing to provide specialized behavior to an existing
ConfigurableNavigationHandler instance.
If this configurable navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
URLs which refer to application configuration
resources.ConfigurationResourceProvider instances using the Java services discovery
mechanism.
The default behavior of this method is to call Map.containsKey(Object) on the wrapped Flash object.
The default behavior of this method is to call Map.containsValue(Object) on the wrapped Flash
object.
ELContext has been created.MethodExpression enables the evaluation of composite component expressions.ValueExpression enables the evaluation of composite component expressions.FacesMessage to be created if a conversion error
occurs, and neither the page author nor the ConverterException provides a message.
A Facelet version of the Jakarta Server Pages ConverterTag.
ConfigAnnotationHandler for FacesConverter annotated classes.ConfigProcessor handles all elements defined under /faces-config/converter.Converter instance on the ValueHolder associated with our most immediate surrounding instance
of a tag whose implementation class is a subclass of UIComponentClassicTagBase.getAsObject() or
getAsText() method of a Converter, to indicate that the requested conversion cannot be
performed.
Handles setting a Converter instance on a ValueHolder
parent.
Converter instance to be created.PropertyEditor that delegates to a faces Converter that was registered by-type
in a faces-config descriptor.ConverterPropertyEditorBase and replace
any references to the target class from the template with a supplied target class.ConverterPropertyEditorFactory that uses the default template class
(ConverterPropertyEditorFor_XXXX).ConverterPropertyEditorFactory that uses the specified template class.ConverterELTag.ConverterELTag. The remainder of the functionality, namely,
the binding facility and the implementation of the ConverterTag.createConverter() method, is now an implementation detail.textValue to an object of type targetClass by delegating to a converter.MultiViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot).Behavior instance of the class specified
by a previous call to addBehavior() for the specified behavior id.
The default behavior of this method is to call Application.createBehavior(String) on the wrapped
Application object.
Create and return a TagHandlerDelegate instance designed for use with BehaviorHandler.
Creates a ClientBehaviorContext instance.
UIComponent instance of the class
specified by a previous call to addComponent() for the specified component type.Application.createComponent(jakarta.el.ValueExpression,jakarta.faces.context.FacesContext,java.lang.String).getValue() method on the specified
ValueExpression.
Like Application.createComponent(ValueExpression, FacesContext, String) except the Renderer for the
component to be returned must be inspected for the annotations mentioned in
Application.createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method.
Like Application.createComponent(String) except the Renderer for the component to be returned must be
inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String) as
specified in the documentation for that method.
Instantiate and return a new UIComponent instance from the
argument Resource.
The default behavior of this method is to call Application.createComponent(String) on the wrapped
Application object.
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String) on the
wrapped Application object.
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String)
on the wrapped Application object.
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, String, String) on the wrapped
Application object.
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, Resource) on the wrapped Application
object.
Subclasses that wish to take over the task of instantiating the UIComponent instance corresponding to
this tag handler my override this method to do so.
Create a component given a ViewDeclarationLanguage specific tag library URI and tag name.
getComponentType().getComponentType().createComponent using Faces 1.1 EL API.
Create and return a TagHandlerDelegate instance designed for use with ComponentHandler.
Converter instance of the class
specified by a previous call to addConverter() for the specified converter id.Converter instance of the class that
has registered itself as capable of performing conversions for objects of the specified type.
The default behavior of this method is to call Application.createConverter(String) on the wrapped
Application object.
The default behavior of this method is to call Application.createConverter(Class) on the wrapped
Application object.
Converter to be registered on our surrounding UIComponent.Converter to be registered on our surrounding UIComponent.
Create and return a TagHandlerDelegate instance designed for use with ConverterHandler.
Create the singleton instance of FlowHandler.
com.sun.faces.InjectionProvider system property.com.sun.faces.InjectionProvider system property.UIComponent with which the TableMetaInfo can be looked up.
Creates a new UIViewRoot containing only view parameter metadata.
The default implementation simply calls through to TagHandlerDelegate.createMetaRuleset(java.lang.Class) and returns the
result.
Return a MetaRuleset particular to this kind of tag handler.
Application.getExpressionFactory() then
ExpressionFactory.createMethodExpression(jakarta.el.ELContext, java.lang.String, java.lang.Class<?>, java.lang.Class<?>[]).ObjectInputStream wrapping the specified source.ObjectOutputStream wrapping the specified destination.
Create an instance of ViewResource given the argument
resourceName.
Create an instance of Resource with a resourceName given by
the value of the argument resourceName that is a member of the library named by the argument
libraryName.
Create an instance of Resource with a resourceName
given by the value of the argument resourceName that is a member of the library named by the argument
libraryName that claims to have the content-type given by the argument content-type.
The default behavior of this method is to call ResourceHandler.createResource(String) on the wrapped
ResourceHandler object.
The default behavior of this method is to call ResourceHandler.createResource(String, String) on the wrapped
ResourceHandler object.
The default behavior of this method is to call ResourceHandler.createResource(String, String, String) on the
wrapped ResourceHandler object.
Create an instance of Resource given the argument resourceId.
The default behavior of this method is to call ResourceHandler.createResourceFromId(String) on the wrapped
ResourceHandler object.
OutputStream to create a new ResponseStream instance.RenderKit.createResponseStream(java.io.OutputStream) on the
wrapped RenderKit object.Writer to create a new ResponseWriter instance for the specified (optional)
content type, and character encoding.RenderKit.createResponseWriter(java.io.Writer, String, String)
on the wrapped RenderKit object.
Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
Generate an identifier for a component.
Validator instance of the class
specified by a previous call to addValidator() for the specified validator id.
The default behavior of this method is to call Application.createValidator(String) on the wrapped
Application object.
Validator to be registered on our surrounding UIComponent.Validator to be registered on our surrounding UIComponent.
Create and return a TagHandlerDelegate instance designed for use with ValidatorHandler.
- with $_.Application.getExpressionFactory() then
ExpressionFactory.createValueExpression(jakarta.el.ELContext, java.lang.String, java.lang.Class<?>).
The default behavior of this method is to call Application.createValueBinding(String) on the wrapped
Application object.
ValueExpression with the expected type of Object.classApplication instance to create a new component with the following characteristics.UIViewRoot instance initialized with
information from the argument FacesContext and viewId.ViewHandler.createView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
Create a UIViewRoot from the VDL contained in the artifact
referenced by the argument viewId.
Create an instance of Resource given the argument resourceName, which may contain "/"
characters.
The default behavior of this method is to call ResourceHandler.createViewResource(jakarta.faces.context.FacesContext, java.lang.String) on the wrapped
ResourceHandler object.
UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback).UIComponent.visitTree().FacesMessage to be created if the conversion to
Number fails.jakarta.enterprise.context.spi.Context. See 2.4.2
and 6.2 of the CDI specification for further details.UIData.The DataModelClassesMapProducer is the CDI producer that allows UIData, UIRepeat and possible other components that need a DataModel wrapper for a given type to obtain a Map of types to DataModel implementations capable of wrapping that type.
DataModel.DataModelEvents
occurring on a particular DataModel instance.FacesMessage to be created if the conversion to
Date fails.FacesMessage to be created if the conversion to
DateTime fails.Converter implementation for
java.util.Date values.If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, Application.createConverter() must guarantee that the default for the timezone of all jakarta.faces.convert.DateTimeConverter instances must be equal to TimeZone.getDefault() instead of "GMT".
FacesMessage to be created if the conversion to
BigDecimal fails.#decodeGroup(FacesContext, UISelectOne, String) when 'group' attribute is set.
Decode any new state of this ClientBehavior from the request contained in the specified FacesContext.
Default implementation of of ClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent).
UIComponent from the request contained in the specified FacesContext,
and store this state as needed.
Override behavior from the superclass to queue an ActionEvent that may result in the invocation of the
action or any actionListeners that may be associated with this instance.
Override behavior from superclass to pull a value from the incoming request parameter map under the name given by
UIViewParameter.getName() and store it with a call to UIInput.setSubmittedValue(java.lang.Object).
The implementation is responsible for examining the incoming request and extracting the value that must be returned
from the ClientWindow.getId() method.
Decode any new state of this ClientBehavior from the request contained in the specified FacesContext.
UIComponent from the request contained in the specified
FacesContext, and store that state on the UIComponent.The value to use for the default extension for Facelet based XHTML pages if the webapp is using url extension mapping.
Lifecycle instance for this Jakarta Server Faces implementation.The value to use for the default extension if the webapp is using url extension mapping.
If the method is a void method, or the method returns null, this can be used to specify what value should be
passed to runtime when the method returns.
If the method is a void method, or the method returns null, this can be used to specify what value should be
passed to runtime when the method returns.
Set the default outcome of the current switch.
Set the default outcome of the current switch.
targetClass.Scanner implementation responsible for EJB annotations.Scanner implementation responsible for PersistenceContext annotations.Scanner implementation responsible for PersistenceUnit annotations.Scanner implementation responsible for link Resource annotations.
Enable the Jakarta Server Faces implementation to provide the
appropriate behavior for the kind of MetaTagHandler subclass for each kind of element in the view, while
providing a base-class from which those wanting to make a Java language custom tag handler can inherit.
Write a delete operation.
ELResolver for Faces.Derive and return the viewId from the current request, or the argument input by following the algorithm defined in specification section 7.6.2.
The default behavior of this method is to call
ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String) on the wrapped
ViewHandler object.
Derive and return the viewId from the current request, or the argument input by following the algorithm defined in specification section 7.6.2.
ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler
object.String of server supported content types, determine the
best qualified content type for the client.
If this param is defined, and calling toLowerCase().equals(“true”) on a String
representation of its value returns true, the runtime must not automatically add the validator with
validator-id equal to the value of the symbolic constant BeanValidator.VALIDATOR_ID to the list of default validators.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification.
The ServletContext init parameter consulted by the runtime to tell if the automatic mapping of the
FacesServlet to the extension *.xhtml should be disabled.
Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs.
InjectionProviders that implement this interface can be configured via
META-INF/services/com.sun.faces.spi.injectionprovider.ExternalContext.dispatch(String) on the wrapped
ExternalContext object.faces-config documents found on the classpath or
configured explicitly via the jakarta.faces.CONFIG_FILES context init parameter.DocumentOrderingWrapper for the specified Document.ViewHandler to get the character encoding from the response and set it into the
session.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.
The default behavior of this method is to call Flash.doPostPhaseActions(FacesContext) on the wrapped
Flash object.
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.
The default behavior of this method is to call Flash.doPrePhaseActions(FacesContext) on the wrapped
Flash object.
ActionListener class, and register it with the UIComponent
instance associated with our most immediately surrounding UIComponentClassicTagBase instance, if the
UIComponent instance was created by this execution of the containing JSP page.UIComponent instance associated with our most
immediately surrounding UIComponentClassicTagBase instance, if this UIComponent does not already have
a value for the specified attribute name.ResourceBundle named by our basename property.PhaseListener class, and register it with the UIComponent
instance associated with our most immediately surrounding UIComponentELTag instance, if the
UIComponent instance was created by this execution of the containing JSP page.ActionListener class, and register it with the UIComponent instance
associated with our most immediately surrounding UIComponentClassicTagBase instance.ValueChangeListener class, and register it with the
UIComponent instance associated with our most immediately surrounding UIComponentClassicTagBase
instance, if the UIComponent instance was created by this execution of the containing JSP page.doStartTag() to do the following:UIComponent instance associated with our most
immediately surrounding UIComponentTag instance, if this UIComponent does not already have a value
for the specified attribute name.Converter class, and register it with the UIComponent instance
associated with our most immediately surrounding UIComponentClassicTagBase instance, if the
UIComponent instance was created by this execution of the containing Jakarta Server Pages page.Converter class, and register it with the UIComponent instance
associated with our most immediately surrounding UIComponentTag instance, if the UIComponent instance
was created by this execution of the containing Jakarta Server Pages page.EVAL_BODY_INCLUDE to cause nested body content to be evaluated.UIComponent instance in the view corresponding to
this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper
location as expected by the page author.Validator class, and register it with the UIComponent instance
associated with our most immediately surrounding UIComponentTagBase instance, if the UIComponent
instance was created by this execution of the containing Jakarta Server Pages page.Validator class, and register it with the UIComponent instance
associated with our most immediately surrounding UIComponentTag instance, if the UIComponent instance
was created by this execution of the containing Jakarta Server Pages page.FacesMessage to be created if the conversion to
Double fails.Converter implementation for java.lang.Double (and double primitive) values.Validator
that checks the value of the corresponding component against specified minimum and maximum values.Validator with no preconfigured limits.Validator with the specified preconfigured limit.Validator with the specified preconfigured limits.state to the provided writer/ValueChangeEvents
and Validators.
A VDL handler that exposes Validator or
ValueChangeListener to a page author.
A marker interface for VDL tags that represent <composite:editableValueHolder/> for use by the
composite component page author.
ELContext.ELResolver stack with the Jakarta Server Pages container.The name of a context parameter that indicates how empty strings need to be interpreted.
The regular expression pattern that identifies an empty list of validation groups.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns
true take the additional actions relating to <validateWholeBean /> specified in
BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).
Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs.
ExternalContext.encodeActionURL(String) on the wrapped
ExternalContext object.true from UIComponent.isRendered(), take the following action.
Called specially by UIViewRoot.encodeEnd(jakarta.faces.context.FacesContext), this method simply sets the submitted value to be the return from
UIViewParameter.getStringValue(jakarta.faces.context.FacesContext).
rendered property is true, render the
beginning of the current state of this UIComponent to the response contained in the specified
FacesContext.UIComponentBase.encodeBegin(jakarta.faces.context.FacesContext)
behavior.UIComponent to the output stream or writer associated with the response we are
creating.The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl.
ExternalContext.encodeBookmarkableURL(String, java.util.Map) on the wrapped
ExternalContext object.
If PartialViewContext.isAjaxRequest() returns true, perform partial
rendering by calling PartialViewContext.processPartial(jakarta.faces.event.PhaseId) with
PhaseId.RENDER_RESPONSE.
UIComponent, following the rules described for encodeBegin()
to acquire the appropriate value to be rendered.#encodeEndGroup(FacesContext, UISelectOne, String) when 'group' attribute is set.jsf.push.init() function if necessary.
If UIViewRoot.getAfterPhaseListener() returns non-null, invoke it,
passing a PhaseEvent for the PhaseId.RENDER_RESPONSE phase.
UIComponent, following the rules described for
encodeBegin() to acquire the appropriate value to be rendered.ExternalContext.encodeNamespace(String) on the wrapped
ExternalContext object.Return the input URL, after performing any rewriting needed to ensure that it can be used in a partial page submission (ajax request) to correctly identify an addressable action in the current application.
ExternalContext.encodePartialActionURL(String) on the wrapped
ExternalContext object.rendered property is true.ExternalContext.encodeRedirectURL(String, java.util.Map) on the wrapped
ExternalContext object.ExternalContext.encodeResourceURL(String) on the wrapped
ExternalContext object.ExternalContext.encodeWebsocketURL(String) on the wrapped
ExternalContext object.
Close an XML CDATA block.
The default behavior of this method is to call ResponseWriter.endCDATA() on the wrapped ResponseWriter
object.
Write the end of a partial response.
ResponseWriter.endDocument() on the wrapped
ResponseWriter object.startElement().ResponseWriter.endElement(String) on the wrapped
ResponseWriter object.Write the end of an error.
Write the end of an eval operation.
Write the end of an extension operation.
Write the end of an insert operation.
Write the end of an update operation.
The default behavior of this method is to call Map.entrySet() on the wrapped Flash object.
FacesMessage to be created if the conversion to
Enum fails.FacesMessage to be created if the conversion to
Enum fails and no target class has been provided.Converter implementation for
java.lang.Enum (and enum primitive) values.Overrides the default equals method to take the minimum and maximum into account when comparing DoubleRangeValidator instances.
Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found.
Performs the same logic as StateHelper.eval(java.io.Serializable) } but if no value is found, this will return the
specified defaultValue
ELException.
The property name for the ExceptionHandlerFactory class name.
ExceptionHandler is the central point for handling unexpected
Exceptions that are thrown during the Faces lifecycle.
ExceptionHandlerFactory is a factory object that creates (if needed)
and returns a new ExceptionHandler instance.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ExceptionHandler for Faces.ExceptionHandler that can be
subclassed by developers wishing to provide specialized behavior to an existing ExceptionHandler instance.If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The system event facility will create an instance of this class whenever
Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) is called with ExceptionQueuedEvent.class as
systemEventClass argument.
Instantiate a new ExceptionQueuedEvent that indicates the argument
ExceptionQueuedEventContext occurred.
Instantiate a new ExceptionQueuedEvent that indicates the argument
ExceptionQueuedEventContext occurred.
This helper class provides context to the ExceptionQueuedEvent regarding the state of the system at the point
in time when the ExceptionQueuedEvent occurs and links the ExceptionQueuedEvent to the
ExceptionHandler by virtue of implementing SystemEventListener.
Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just
occurred.
Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just
occurred, relevant to the argument component.
Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just
occurred, relevant to the argument component, during the lifecycle phase phaseId.
Lifecycle for a particular request.Set the method expression of this method call node.
Set the method expression of this method call node.
Set the method expression of this method call node.
The default characters used to separate expressions in a series of expressions.
The property name for the ExternalContextFactory class name.
ExternalContext instances, initialized for the processing of the
specified request and response objects.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ExternalContext is specific to the servlet implementation.The ExternalContextProducer is the CDI producer that allows injection of the ExternalContext using @Inject and allows EL resolving of #{externalContext}
Provides a simple implementation of
ExternalContext that can be subclassed by developers wishing to provide specialized behavior to an existing
ExternalContext instance.
If this external context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The property name for the FaceletCacheFactory class name.
This API defines the facility by which the Facelets
ViewDeclarationLanguage creates and caches instances of Facelets.
Factory interface for creating Facelet or View Metadata Facelet instances.
Allows customization of the implementation of FaceletCache.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FaceletCacheFactory.URLs which refer to application configuration
resources (i.e.Context representative of a single request from a Facelet.
An Exception from the Facelet implementation
Create an empty FaceletException.
Create a FaceletException with argument message as the message.
Wrap argument cause within this FaceletException instance.
Wrap argument cause in a FaceletException instance, with a message given by the argument
message.
This is the root class for markup elements in Facelets VDL.
The buffer size to set on the response when the ResponseWriter is generated.
A semicolon (;) delimitted list of class names of type jakarta.faces.view.facelets.TagDecorator, with a no-argument constructor.
If this param is set, the runtime must interpret it as a semicolon (;) separated list of paths, starting with "/" (without the quotes).
When a page is requested, what interval in seconds should the compiler check for changes.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, the runtime must ensure that any XML comments in the Facelets source page are not delivered to the client.
Allow the web application to define an alternate suffix for Facelet based XHTML pages containing Jakarta Server Faces content.
Identifier for the Facelets view declaration language.
Allow the web application to define a semicolon (;) separated list of strings that is used to forcibly declare that certain pages in the application must be interpreted as using Facelets, regardless of their extension.
Root class for all tag handlers that represent attached objetcts in a Facelets page.
The presence of this annotation on a class automatically registers the class with the runtime as a
ResourceResolver.
ConfigProcessor handles all elements defined under /faces-taglib.ViewHandlingStrategy handles Facelets/PDL-based views.FacesContextFactory class name.ResourceBundle identifier for messages whose message identifiers are defined in the Jakarta Server Faces
specification.
The presence of this annotation on a class automatically registers the class with the runtime as a Behavior.
The presence of this annotation on a class automatically registers the class with the runtime as a
ClientBehaviorRenderer.
UIComponent
must cause the runtime to register this class as a component suitable for inclusion in a view.ELResolver for Faces.
The presence of this annotation on a managed bean deployed within an application causes version specific features to
be enabled as specified in the enum FacesConfig.Version
@FacesConfig.ConfigProcessor handles all elements defined under /faces-config/factory./WEB-INF/faces-config.xml, if present, to expose information relevant to the
intialization of the runtime.WebInfFacesConfig document based on the provided Document.URLs which refer to application configuration
resources (i.e.FacesContext instances, initialized for the
processing of the specified request and response objects.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The FacesContextProducer is the CDI producer that allows injection of the FacesContext using @Inject and allows EL resolving of #{facesContext}
FacesContext that can be subclassed by developers wishing to provide specialized behavior to an existing
FacesContext instance.If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation on a class automatically registers the
class with the runtime as a Converter.
FacesEvent is the base class for user interface and application events that can be fired by
UIComponents.
Construct a new event object from the specified source component.
Construct a new event object from the Faces context and specified source component.
ConfigProcessor handles all elements defined under /faces-config/flow-definition.Set of classes passed to this initializer is not empty, or
/WEB-INF/faces-config.xml exists, or
A CDI enabled bean with qualifier FacesConfig can be obtained
FacesEvents.enum of all application Loggers.FacesMessage with no initial values.FacesMessage with just a summary.FacesMessage with the specified initial values.FacesMessage with the specified initial values.
The presence of this annotation on a class automatically registers the class with the runtime as a Renderer.
The presence of this annotation on a class automatically registers the
class with the runtime as a Validator.
Any wrapper class in Jakarta Server Faces that must provide access to the object it wraps must implement this interface.
An interface that allows other code to identify FaceletHandlers that correspond to component facets.
The value of this constant is used as the key in the composite component BeanDescriptor for the
Map<PropertyDescriptor> that contains meta-information for the declared facets for this composite
component.
UIComponent is to be added as a facet to the component associated with
its parent.ConfigProcessor handles all elements defined under /faces-config/factory.StringWriter but backed by a StringBuilder instead.FastStringWriter instance using the default capacity of 16.FastStringWriter instance using the specified initialCapacity.StateHelper implementations when writing the end of the state or
viewId field.StateHelper implementations when writing the middle of the state or
viewId fields.A MethodExpression that will be invoked when the flow is exited.
A MethodExpression that will be invoked when the flow is exited.
Set of classes that have been annotated with
a standard Faces annotation (possibly limited to the annotations that denote configurable elements)UIComponent with an id that
matches the specified search expression (if any), according to the algorithm described below.UIComponent, from the component tree, that corresponds to this tag handler instance.Callable will be used by
ConfigManager#getXMLDocuments(jakarta.servlet.ServletContext, java.util.List, java.util.concurrent.ExecutorService, boolean).URITask instance.pref and list of supported locales, using the matching
algorithm as described in JSTL 8.3.2.pref and list of supported locales, using the matching
algorithm as described in JSTL 8.3.2.ResourceInfo based on the specified libraryName and resourceNameTake actions to apply the rule.
The Flash concept is taken from Ruby on Rails and provides a way to pass temporary objects between the user views generated by the faces lifecycle.
The property name for the FlashFactory class name.
Flash instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FlashFactory.The Flash producer is the CDI producer that allows EL resolving of #{flash}
If this flash has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesMessage to be created if the conversion to
Float fails.Converter implementation for java.lang.Float (and float primitive) values.Flow is the runtime representation of a Faces Flow.
The property name for the FlowHandlerFactory class name.
Components that are rendered by Renderers of component-family jakarta.faces.OutcomeTarget
must use this constant as the parameter name for a parameter representing the flow id of the flow that this component
will cause to be entered.
A Java language API for building Flows.
The presence of this annotation on a CDI producer method for the FlowDefinition annotation causes the
FlowBuilder to be passed to that method.
Create a flow call node in the current Flow.
Define a flow call node.
The presence of this annotation on a CDI producer method indicates that the method will produce a flow.
FlowHandler is the main entry point that enables the runtime to interact with the faces flows feature.
FlowHandlerFactory is used by the Application to create the
singleton instance of FlowHandler.
FlowHandlerFactoryWrapper provides a simple implementation of FlowHandlerFactory that can be
subclassed by developers wishing to provide specialized behavior to an existing FlowHandlerFactory instance.
If this flow handler factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation (along with @Inject) on a field of type Map<Object,
Object> causes the map returned from FlowHandler.getCurrentFlowScope() to be
injected as the value of that field.
The Flow map producer is the CDI producer that allows injection of the flow map using @Inject.
FlowNode is the base class for all nodes in a faces flow graph.
Define the flow reference of the called flow.
FlowScoped is a CDI scope that causes the runtime to consider classes
with this annotation to be in the scope of the specified Flow.
ResponseWriter.flush() on the wrapped ResponseWriter
object.UIForm as a Form.Set the from-action of the current navigation case.
Set the from-outcome of the current navigation case.
Set the outcome of the current return node.
Set the outcome of the current return node.
Set the outcome in the previously created switch case.
Set the from-view-id of the current navigation case.
The runtime must interpret the value of this parameter as a comma separated list of view IDs, each of which must have their state saved using the state saving mechanism specified in Jakarta Server Faces 1.2.
A VisitContext implementation that is used when performing a full component tree visit.
TagLibrary exposes the public static methods defined on the
functionsClass provided to the constructor as EL functions.Generate a unique ID for the passed String
Callable will be created
wrapping the Factory specified via the constructor and passed to a
FutureTask.
Return the value currently associated with the specified key if any.
The default behavior of this method is to call Map.get(Object) on the wrapped Flash object.
accept property.acceptcharset property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.ActionSource2.getActionExpression().UICommand.getActionExpression().MethodExpression pointing at the application action to be invoked, if this UIComponent is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate property.MethodExpression pointing at the application action to be invoked, if this UIComponent is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate property.ActionListener to be registered for all
ActionSource components in this application.
The default behavior of this method is to call Application.getActionListener() on the wrapped
Application object.
ActionSource.getActionListeners() instead.UICommand.getActionListeners() instead.ActionListeners for this ActionSource instance.ActionListeners for this ActionSource instance.ViewHandlingStrategy instances.
Construct an absolute URL to this NavigationCase instance using
ViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String) on the path portion of the url.
If the value returned from this method is used as the file
argument to the four-argument constructor for java.net.URL (assuming appropriate values are used for the
first three arguments), then a client making a request to the toExternalForm() of that URL
will select the argument viewId for traversing the Jakarta Server Faces lifecycle.
ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler
object.MethodExpression that will be invoked after this view is rendered.alt property.alt property.alt property.alt property.alt property.alt property.Application instance for this web application.Application instance for this web application.Application instance associated with this web
application.FacesContext.getApplication() on the wrapped
FacesContext object.
The source Application that sent this event.
The source Application that sent this event.
Return the name of the container context for this application.
The default behavior of this method is to call ExternalContext.getApplicationContextPath() on the wrapped
ExternalContext object.
Map representing the application scope
attributes for the current application.ExternalContext.getApplicationMap() on the wrapped
ExternalContext object.UIComponent, into a model data object that is appropriate for being stored during the
Process Validations phase of the request processing lifecycle.value argument to one of the enum constants of the class provided in our constructor.UIComponent, into a String
that is suitable for being included in the response generated during the Render Response phase of the
request processing lifeycle.
Convert the enum constant given by the value argument into a String.
ConverterPropertyEditorBase.getTargetClass() to text by delegating to a converter obtained from the Faces
Application.Return the underlying handler for this tag handler instance.
Return an attribute set by a previous call to FaceletContext.setAttribute(java.lang.String, java.lang.Object).
Returns the resolved literal String value of the attribute name after evaluating EL.
Map representing the attributes (and properties, see below) associated wth this
UIComponent, keyed by attribute name (which must be a String).
Return a mutable Map representing the attributes associated wth this FacesContext instance.
FacesContext.getAttributes() on the wrapped
FacesContext object.
A Map of attributes relevant to the context of this ExceptionQueuedEvent.
Return an object encapsulating the TagAttributes specified on this element in the view.
null.ExternalContext.getAuthType() on the wrapped
ExternalContext object.autocomplete property.autocomplete property.autocomplete property.MethodExpression that will be invoked before this view is rendered.
Return the source Behavior that sent this event.
Iterator over the set of currently registered behavior ids for this Application.
The default behavior of this method is to call Application.getBehaviorIds() on the wrapped Application
object.
bgcolor property.bgcolor property.bodyrows property.bodyrows property.
Construct an absolute URL suitable for a bookmarkable link to this NavigationCase instance using
ViewHandler.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.
Return a Jakarta Server Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Server Faces response.
ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the
wrapped ViewHandler object.
If literal,return Boolean.valueOf(java.lang.String) passing our value,
otherwise call getObject(FaceletContext, Class).
If literal,return Boolean.valueOf(java.lang.String) passing our value,
otherwise call getObject(FaceletContext, Class).
border property.border property.border property.border property.StringBuilder itself.
Returns the ContextCallback for the current request.
captionClass property.captionClass property.captionStyle property.captionStyle property.Return the cases in this switch.
null if the cause is nonexistent or unknown.cellpadding property.cellpadding property.cellspacing property.cellspacing property.<f:websocket channel>.ResponseWriter.ResponseWriter.getCharacterEncoding() on the wrapped
ResponseWriter object.charset property.charset property.charset property.UIComponents that are associated with this UIComponent.ClientBehaviorRenderer instance most recently registered for the specified type, if
any; otherwise, return null.RenderKit.getClientBehaviorRenderer(String) on the wrapped
RenderKit object.
Return an Iterator over the ClientBehaviorRenderer types.
RenderKit.getClientBehaviorRendererTypes() on the wrapped RenderKit object.
Returns a non-null, unmodifiable Map that contains the the ClientBehaviors that have been
attached to the component implementing this interface.
This is a default implementation of ClientBehaviorHolder.getClientBehaviors().
Enable Jakarta Expression Language to access the clientId of a component.
rowIndex property,
if it is not set to -1.Iterator over the client identifiers for which at least one
FacesMessage has been queued.FacesContext.getClientIdsWithMessages()
on the wrapped FacesContext object.
Return the ClientWindow set in a preceding call to ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow), or null if no such
call has been made.
The default behavior of this method is to call ExternalContext.getClientWindow() on the wrapped
ExternalContext object.
The implementation is responsible for creating the ClientWindow instance for this request.
Get the ClientWindow's id and append "_" and the return from Flow.getId().
cols property.Return the estimated character column.
columnClasses property.columnClasses property.columns property.base is non-null and is the literal string "flash", return Object.class.attrs is considered a String property.UIComponent that is currently being processed.
Returns the UIComponent that is requesting the ClientBehavior script.
the source UIComponent that sent this event.
Return the UIComponent which was being processed when the exception was thrown.
UIComponent that sent this event.
Return an Iterator over the component-family entries supported by this RenderKit instance.
RenderKit.getComponentFamilies() on the
wrapped RenderKit object.UIComponent instance that is associated with this tag instance.UIComponent instance that is associated with this tag instance.
Return a reference to the component metadata for the composite component represented by the argument
componentResource, or null if the metadata cannot be found.
Return an unmodifiable List of
UIComponents for the provided target agrument.
Return an unmodifiable ordered List of all UIComponent resources of all supported targets.
ResponseStateManager.getState(jakarta.faces.context.FacesContext, java.lang.String). The default implementation returns null.null.StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext) on the wrapped StateManager
object.
ComponentType to pass to the Application.
Iterator over the set of currently defined component types for this Application.
The default behavior of this method is to call Application.getComponentTypes() on the wrapped
Application object.
Evaluates the <if> for this <navigation-case>, if any.
Return true if this case should be taken, false otherwise.
NamingContainer to selectively disable prepending their clientId to their
descendent's clientIds by breaking the prepending logic into a separately callable method.UIComponent.getContainerClientId(jakarta.faces.context.FacesContext) to allow users to disable this form from prepending its
clientId to its descendent's clientIds depending on the value of this form's
UIForm.isPrependId() property.Return the MIME content-type for this resource.
The default behavior of this method is to call Resource.getContentType() on the wrapped
ResourceHandler object.
ResponseWriter.ResponseWriter.getContentType() on the wrapped
ResponseWriter object.response is non-null and has a method called getContentType that
takes no arguments and returns a String, with no side-effects.ExternalContext.getContext() on the wrapped
ExternalContext object.
Return the ExceptionQueuedEventContext for this event instance.
The FacesContext for this request.
Return the ScopeContext for this event.
Return the ScopeContext for this event.
Return the name of the container context for this application.
ExternalContext.getContextName() on the wrapped
ExternalContext object.
Because this class has no Renderer, leverage the one from the standard HTML_BASIC RenderKit with
component-family: jakarta.faces.Input and renderer-type: jakarta.faces.Text and call its
Renderer.getConvertedValue(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object) method.
Converter for this component, if there is one).Converter (if any) that is registered for this UIComponent.Return the converter id to be used in instantiating this converter
Iterator over the set of currently registered converter ids for this Application.
The default behavior of this method is to call Application.getConverterIds() on the wrapped Application
object.
UIInput.setConverterMessage(java.lang.String) on this instance, return the message.Iterator over the set of Class instances for which Converter classes have
been explicitly registered.
The default behavior of this method is to call Application.getConverterTypes() on the wrapped
Application object.
coords property.coords property.coords property.true if we dynamically created a new component instance during execution of this tag.true if we dynamically created a new component instance during execution of this tag.List of UIComponent ids created or located by nested UIComponentTags while
processing the current request.Compliant implementations must return a cryptographically strong token for use to protect views in this application.
getAsString() with a type of
currency.getAsString() with a type of currency.
Return the UIComponent instance that is currently processing.
Return the closest ancestor component, relative to the component returned from UIComponent.getCurrentComponent(jakarta.faces.context.FacesContext), that is
a composite component, or null if no such component exists.
Return the currently active Flow for the argument FacesContext, or null if no flow is active.
Convenience overload that calls FacesContext.getCurrentInstance() and then calls through to
FlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext).
Return the Map that backs the #{flowScope} Jakarta Expression Language implicit object or
null if no flow is currently active.
Return the FacesContext instance for the request that is being processed by the current thread.
Return the value last set on this FacesContext instance when FacesContext.setCurrentPhaseId(jakarta.faces.event.PhaseId) was called.
FacesContext.getCurrentPhaseId() on the wrapped
FacesContext object.RenderKit for the current request.DataModel object representing the data objects that we will iterate over in this
component's rendering.DataModel that fired this event.DataModelListeners interested in notifications from this DataModel.
Returns the default event name for this ClientBehaviorHolder implementation.
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName().
Locale for this application.
The default behavior of this method is to call Application.getDefaultLocale() on the wrapped
Application object.
Return the default outcome in this switch.
renderKitId to be used for rendering this application.
The default behavior of this method is to call Application.getDefaultRenderKitId() on the wrapped
Application object.
Return an immutable Map over the set of currently registered default validator IDs and their class name
for this Application.
The default behavior of this method is to call Application.getDefaultValidatorInfo() on the wrapped
Application object.
Return the immutable application unique identifier for the document in which the argument flow is defined.
Returns the delay value, or null if no value was set.
dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.disabledClass property.disabledClass property.disabledClass property.disabledClass property.disabledClass property.disabledClass property.doAfterBody() method when it is called.doEnd() method when it is called.doStart() method when it is called.ELContext instance for this FacesContext instance.FacesContext.getELContext() on the wrapped
FacesContext object.ELContext for the FacesContext for this request.ELContext for the FacesContext for this request.Application.addELContextListener(jakarta.el.ELContextListener), this method must return an empty array.
The default behavior of this method is to call Application.getELContextListeners() on the wrapped
Application object.
ELResolver instance to be used for all Jakarta Expression Language resolution.
The default behavior of this method is to call Application.getELResolver() on the wrapped Application
object.
enabledClass property.enabledClass property.enabledClass property.enabledClass property.enabledClass property.enabledClass property.ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) to produce
a redirect URL, which will add the page parameters if necessary and properly prioritizing the parameter overrides.enctype property.errorClass property.errorClass property.errorStyle property.errorStyle property.ExpressionEvalMap instance associated with the owning
UIComponent
Returns a mutable List of scripts to be evaluated in client side on complete of ajax request.
The default behavior of this method is to call PartialViewContext.getRenderIds() on the wrapped
PartialViewContext object.
Returns the name of the behavior event for which the ClientBehavior script is being requested.
Return the client event name to which this behavior applies.
Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the
component implementing this interface.
This is a default implementation of ClientBehaviorHolder.getEventNames().
Collection which returns true on any
Collection#contains() invocation, indicating that all client behavior event names are acceptable.
Return the exception property.
Create and return a A new ExceptionHandler instance.
Return the ExceptionHandler for this request.
FacesContext.getExceptionHandler() on the wrapped
FacesContext object.FacesMessage instance using the specified #messageId.
Return a non-empty Collection<String> of component identifiers that will be used to identify
components that should be processed during the execute phase of the request processing lifecycle.
execute property.
Return a Collection of client identifiers from the current request with the request parameter name
PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME.
PartialViewContext.getExecuteIds() on the wrapped
PartialViewContext object.ExpressionFactory instance for this application.
The default behavior of this method is to call Application.getExpressionFactory() on the wrapped
Application object.
The ExpressionFactory to use within the Facelet this context is executing upon.
Returns hints that influence the behavior of resolving the expression.
Return the characters used to separate expressions in a series of expressions.
null) expression String, with leading and trailing delimiters, from which this
MethodBinding was built.null) expression String, including the delimiters, from which this
ValueBinding was built.ExternalContext instance that is
initialized for the processing of the specified request and response objects, for this web application.FacesContext.getExternalContext() on the wrapped
FacesContext object.Returns a cached Facelet instance.
Returns the FacesContext for the current request.
Returns the FacesContext for the current request.
FacesContext instance for the current request.Returns the FacesContext for the current request.
FacesContext
instance that is initialized for the processing of the specified request and response objects, utilizing the
specified Lifecycle instance, for this web application.Get the Faces context.
FacesContext for the request being processed.Get the Faces context.
The current FacesContext bound to this "request".
FacesContext instance for the current request.UIComponentClassicTagBase.release() was called), return the
previously returned value.FacesListeners that are instances of the specified class.FacesServlet that is executing the current request.
Return the FacesMessage passed to the constructor.
Returns the FacesMessage associated with the exception.
If this instance was created with a constructor that takes Collection<FacesMessage>, this method
returns the passed collection, otherwise this method returns null.
null otherwise.UIComponents that are associated with this UIComponent.Returns the resolved literal String value of the facet name after evaluating EL.
Map representing the facet UIComponents associated with this
UIComponent, keyed by facet name (which must be a String).Factory instance aasociated with this cacheReturn the identifier of the component family to which this component belongs.
UIWebsocket.COMPONENT_FAMILY.fatalClass property.fatalClass property.fatalStyle property.fatalStyle property.FeatureDescriptors for the current contents of the flash.ELResolver currently returns no feature descriptors as we have no way to effectively iterate over
the UIComponent attributes Map.
Return the MethodExpression that must be called by the runtime as the last thing that happens before exiting
this flow.
Map for this application.
Return the threadsafe Flash for this application.
ExternalContext.getFlash() on the wrapped
ExternalContext object.
Create (if needed) and return a Flash instance for this web application.
Called as the last step in flow definition, this method must perform any implementation specific initialization and
return the built Flow.
Return the Flow whose id is equivalent to the argument id, within the scope of the argument definingDocument.
Return the FlowCallNode that represents calling the targetFlow from this flow, or null if
targetFlow cannot be reached from this flow.
Return an immutable data structure containing all the flow call nodes declared for this flow.
Return the thread-safe singleton FlowHandler for this application.
footerClass property.footerClass property.footerClass property.for property.Return the client identifier of the component for which this component represents associated message(s) (if any).
Return the value of the "for" attribute specified by the page author on the tag for this
AttachedObjectHandler.
Return the value of the "for" attribute.
forComponentfragment property.frame property.frame property.
Return the <from-action> for this <navigation-case>
Return the <from-outcome> for this <navigation-case>
Return the fromOutcome to be used when control passes to this return node.
Return the outcome to be used if SwitchCase.getCondition(jakarta.faces.context.FacesContext) return true.
Return the <from-view-id> of the <navigation-rule> inside which this
<navigation-case> is nested.
group property.Returns the name of the radio button group.
Return the first ExceptionQueuedEvent handled by this handler.
ExceptionHandler.getHandledExceptionQueuedEvent() on the
wrapped ExceptionHandler object.
The default implementation must return an Iterable over all ExceptionQueuedEvents that have
been handled by the ExceptionHandler.handle() method.
ExceptionHandler.getHandledExceptionQueuedEvents() on the
wrapped ExceptionHandler object.Returns the array of child handlers contained by this handler.
headerClass property.headerClass property.headerClass property.height property.
This method returns an unmodifiable Set containing the ClientBehaviorHint
SUBMITTING.
Returns hints that describe the behavior of the ClientBehavior implementation.
Default implementation of ClientBehavior.getHints().
hreflang property.hreflang property.hreflang property.UIComponent.Return the immutable id for this Flow.
Return a String value that uniquely identifies this ClientWindow within the scope of the current
session.
Returns a non-null String that can be used to identify this view declaration language.
id value assigned by the page author.Returns the ids of the components to visit.
image property.image property.
Utility method to extract view metadata from the provided UIViewRoot.
Return an immutable data structure containing the inbound parameters that have been declared for this flow.
infoClass property.infoClass property.infoStyle property.infoStyle property.
Return the MethodExpression that must be called by the runtime immediately after activating any
FlowScoped beans declared for this flow.
ExternalContext.getInitParameter(String) on the wrapped
ExternalContext object.Map whose keys are the set of application
initialization parameter names configured for this application, and whose values are the corresponding parameter
values.ExternalContext.getInitParameterMap() on the wrapped
ExternalContext object.ResourceHelper.getNonCompressedInputStream(ResourceInfo, jakarta.faces.context.FacesContext) to return the content of the
original resource.
If the current request is a resource request, (that is,
ResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext) returns true), return an InputStream containing
the bytes of the resource.
The default behavior of this method is to call Resource.getInputStream() on the wrapped ResourceHandler
object.
WebConfiguration.getInstance(jakarta.faces.context.ExternalContext).Integer.parseInt(String), otherwise call
getObject(FaceletContext, Class).Integer.parseInt(String), otherwise call
getObject(FaceletContext, Class).Integer based configuration values used to change the behavior of the
ServerSideStateHelper.label property from the specified component.label property from the specified component.label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.
Return the last displayed viewId for the current flow, as returned by
FlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext), or null if there is no current flow.
ResourceHelper.getURL(ResourceInfo, jakarta.faces.context.FacesContext) and leverage the URL to obtain the
date information of the resource and return the value of URLConnection.getLastModified()layout property.layout property.layout property.layout property.Return the libraryName for this resource.
The default behavior of this method is to call Resource.getLibraryName() on the wrapped
ResourceHandler object.
Lifecycle instance for the specified lifecycle identifier.Iterator over the set of lifecycle identifiers supported by this factory.Return the line number in the page for this location.
type or
binding.
This implementation throws UnsupportedOperationException and is provided for the sole purpose of not
breaking existing applications that extend this class.
Return the SystemEventListener instances registered on this UIComponent instance that are
interested in events of type eventClass.
Return a List that contains a single entry, the ExceptionHandler for the
current request.
Locale to be used in localizing the response being created for this view.Locale to be used when parsing or formatting dates and times.Locale to be used when parsing numbers.Return the XML local name of the tag.
UIComponent (if any), without evaluating any associated
ValueExpression.
Return the Location of this Tag instance in the Facelet view.
longdesc property.getAsString() should render in the fraction portion of the result.Validator or Double.MAX_VALUE if it has not been
set.Validator, or 0 if the maximum has not been
set.Validator.FacesMessages that has been
queued, whether or not they are associated with any specific UIComponent.FacesContext.getMaximumSeverity() on the wrapped
FacesContext object.getAsString() should render in the integer portion of the result.maxlength property.maxlength property.maxlength property.
Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating Facelet instance.
null, otherwise, return the message.ResourceBundle to be used for Jakarta Server Faces messages
for this application.
The default behavior of this method is to call Application.getMessageBundle() on the wrapped
Application object.
Like FacesContext.getMessages(), but returns a List<FacesMessage>, enabling use from Jakarta Expression
Language expressions.
Like FacesContext.getMessages(java.lang.String), but returns a List<FacesMessage> of messages for the
component with client id matching argument clientId.
FacesContext.getMessageList() on the wrapped
FacesContext object.FacesContext.getMessageList(String) on the wrapped
FacesContext object.Iterator over the FacesMessages that have been queued,
whether or not they are associated with any specific client identifier.Iterator over the FacesMessages that have been queued that
are associated with the specified client identifier (if clientId is not null), or over the
FacesMessages that have been queued that are not associated with any specific
client identifier (if clientId is null).FacesContext.getMessages() on the wrapped FacesContext
object.FacesContext.getMessages(String) on the wrapped
FacesContext object.
Returns the FaceletCache.MemberFactory passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>) for the purpose of creating View Metadata
Facelet instance.
TableMetaInfo object containing details such as row and column classes, columns, and a
mechanism for scrolling through the row/column classes.Return an immutable data structure containing all the method call nodes declared for this flow.
Return the MethodExpression to be invoked to when control passes to this node.
Returns the MIME type of the specified file or null if the MIME type is not known.
ExternalContext.getMimeType(String) on the wrapped
ExternalContext object.getAsString() should render in the fraction portion of the result.Validator, or Double.MIN_VALUE if it has not
been set.Validator, or 0 if the minimum has not been
set.Validator.getAsString() should render in the integer portion of the result.Returns the Parameter's name.
name property.Return the request parameter name from which the value is retrieved.
Return the name of this phase.
Return the name of the parameter
Returns the name by which this attached object target is exposed to the page author.
Return the resolved XML Namespace for this tag in the Facelets view.
Starting with "this", return the closest component in the ancestry that is a NamingContainer or
null if none can be found.
Return the result of calling UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext), passing this as the argument.
The default behavior of this method is to call FacesContext.getNamingContainerSeparatorChar() on the wrapped
FacesContext object.
NavigationHandler preemptively to resolve a NavigationCase for the outcome declared on the
UIOutcomeTarget component.
Return the NavigationCase representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no
such case.
Return the NavigationCase representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no
such case.
Map of navigation mappings loaded from the configuration system.
Return a Map<String,
Set<NavigationCase>> where the keys are <from-view-id> values and the values are
Set<NavigationCase> where each element in the Set is a NavigationCase that applies to
that <from-view-id>.
Return an unmodifiable view of the navigation cases within this flow.
NavigationHandler instance that will be passed the outcome returned by any invoked application
action for this web application.
The default behavior of this method is to call Application.getNavigationHandler() on the wrapped
Application object.
UIComponent.
The next FaceletHandler (child or children) to be applied.
Return the generic FlowNode by id, or null if not found.
Node, if any.ResourceInfo is not compressable,
ResourceHelper.getInputStream(ResourceInfo, jakarta.faces.context.FacesContext) will call this method to return a stream to
the actual resource.stage.UIComponent.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.
Return the String of JavaScript function name that will be used to identify the client callback function
that should be run in the event of an error.
onerror property.
Return the String of JavaScript function name that will be used to identify the client callback function
that should be run on the occurance of a client-side event.
onevent property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onload property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onreset property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onsubmit property.onunload property.FacesMessage.Severity instance.PhaseId instance.
Returns the outcome property of the UIOutcomeTarget.
Return the outcome to be used in the event of a null return from the method.
Return the parameters to be included for navigation cases requiring a redirect.
Returns parameters that "submitting" ClientBehavior implementations should include when posting back data
into the Faces lifecycle.
Return the parameters to be passed to the method.
UIComponent of this UIComponent, if any.Tag that is the parent of this instance.UIComponentClassicTagBase if any; otherwise, return
null.UIComponentTag if any; otherwise, return null.
Return the ResponseWriter to which components should direct their output for partial view rendering.
PartialViewContext.getPartialResponseWriter() on the wrapped
PartialViewContext object.
Return the PartialViewContext for this request.
FacesContext.getPartialViewContext() ()} on the wrapped
FacesContext object.PartialViewContext instance that is
initialized using the current FacesContext instance.
This is a convenience method that simply calls UIComponent.getPassThroughAttributes(boolean), passing true as
the argument.
This method has the same specification as UIComponent.getPassThroughAttributes() except that it is allowed to return
null if and only if the argument create is false and no pass through attribute data structure
exists for this instance.
Return the file path to the page represented by this location.
ValueExpression that yields the regular expression pattern when evaluated.Returns the name of the lifecycle phase in which the action is to be queued.
PhaseEvent events.
Return the PhaseId which was being processed when the exception was thrown.
PhaseId representing the current request processing lifecycle phase.PhaseEvent events.
Return an unmodifiable list of the PhaseListener instances attached to this UIViewRoot
instance.
PhaseListeners for this Lifecycle instance.JspWriter from our BodyContent.Return the project stage for the currently running application instance.
The default behavior of this method is to call Application.getProjectStage() on the wrapped Application
object.
Return a beans PropertyDescriptor for the property with name given by argument name.
Application.getELResolver().
Return a Class for the property with name given by argument name.
Return an unmodifiable Set of the protected views currently known to this ViewHandler
instance.
ViewHandler.getProtectedViewsUnmodifiable() on the wrapped
ViewHandler object.public property.Return the XML qualified name for this tag.
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.
Return a Method for the getter of the property with name given by argument name.
Returns a String containing the real path for a given virtual path.
ExternalContext.getRealPath(String) on the wrapped
ExternalContext object.
Construct an absolute URL suitable for a "redirect" to this NavigationCase instance using
ViewHandler.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.
Return a Jakarta Server Faces action URL derived from the viewId argument that is suitable to be used by
the NavigationHandler to issue a redirect request to the URL using a NonFaces request.
ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped
ViewHandler object.rel property.rel property.rel property.Returns the remaining expression for the current request.
null.ExternalContext.getRemoteUser() on the wrapped
ExternalContext object.
Return a non-empty Collection<String> of component identifiers that will be used to identify
components that should be processed during the render phase of the request processing lifecycle.
render property.
Convenience method to return the ClientBehaviorRenderer instance associated with this ClientBehavior,
if any; otherwise, return null.
Renderer instance associated with this component, if any; otherwise, return
null.Renderer instance most recently registered for the specified component family and
rendererType, if any; otherwise, return null.RenderKit.getRenderer(String, String) on the wrapped
RenderKit object.
Returns the renderer type of the ClientBehaviorRenderer to use for the behavior.
Renderer type for this UIComponent (if any).
RendererType to set on created UIComponent instances.
rendererType property that selects the Renderer to be used for encoding this
component, or null to ask the component to render itself directly.
Return the renderer-type for a Renderer that is capable of rendering this
resource.
The default behavior of this method is to call ResourceHandler.getRendererTypeForResourceName(String) on the
wrapped ResourceHandler object.
Return an Iterator over the renderer-type entries for the given component-family.
RenderKit.getRendererTypes(String) on the wrapped
RenderKit object.
Return a Collection of client identifiers from the current request with the request parameter name
PartialViewContext.PARTIAL_RENDER_PARAM_NAME.
PartialViewContext.getRenderIds() on the wrapped
PartialViewContext object.RenderKit instance for the render kit identifier specified on our UIViewRoot, if there is
one.FacesContext.getRenderKit() on the wrapped
FacesContext object.RenderKit instance for the specified render kit identifier, possibly customized based on dynamic
characteristics of the specified FacesContext, if non-null.RenderKit associated with this view.Iterator over the set of render kit identifiers registered with this factory.true if the renderResponse() method has been called for the current request.FacesContext.getRenderResponse() on the wrapped
FacesContext object.
Call UIComponentBase.getRendersChildren() If PartialViewContext.isAjaxRequest()
returns true this method must return true.
Renderer is responsible for rendering the children the component it is
asked to render.ExternalContext.getRequest() on the wrapped
ExternalContext object.ExternalContext.getRequestCharacterEncoding() on the wrapped
ExternalContext object.
Return the result of calling getContentLenth() on the ServletRequest instance for this
request.
ExternalContext.getRequestContentLength() on the wrapped
ExternalContext object.ExternalContext.getRequestContentType() on the wrapped
ExternalContext object.ExternalContext.getRequestContextPath() on the wrapped
ExternalContext object.Map whose keys are the set of cookie names included in the current request, and
whose values (of type jakarta.servlet.http.Cookie) are the first (or only) cookie for each cookie name
returned by the underlying request.ExternalContext.getRequestCookieMap() on the wrapped
ExternalContext object.Map whose keys are the set of request header names included in the current request,
and whose values (of type String) are the first (or only) value for each header name returned by the underlying
request.ExternalContext.getRequestHeaderMap() on the wrapped
ExternalContext object.Map whose keys are the set of request header names included in the current request,
and whose values (of type String[]) are all of the value for each header name returned by the underlying request.ExternalContext.getRequestHeaderValuesMap() on the wrapped
ExternalContext object.Locale in which the client will accept content.ExternalContext.getRequestLocale() on the wrapped
ExternalContext object.Iterator over the preferred Locales specified in the request, in decreasing order
of preference.ExternalContext.getRequestLocales() on the wrapped
ExternalContext object.Map representing the request scope attributes for the current application.ExternalContext.getRequestMap() on the wrapped
ExternalContext object.Map whose keys are the set of request parameters names included in the current
request, and whose values (of type String) are the first (or only) value for each parameter name returned by the
underlying request.ExternalContext.getRequestParameterMap() on the wrapped
ExternalContext object.Iterator over the names of all request parameters included in the current request.ExternalContext.getRequestParameterNames() on the wrapped
ExternalContext object.Map whose keys are the set of request parameters names included in the current
request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying
request.ExternalContext.getRequestParameterValuesMap() on the wrapped
ExternalContext object.Return a path to this resource such that, when the browser resolves it against the base URI for the view that includes the resource, and issues a GET request to the resultant fully qualified URL, the bytes of the resource are returned in response.
The default behavior of this method is to call Resource.getRequestPath() on the wrapped ResourceHandler
object.
null.ExternalContext.getRequestPathInfo() on the wrapped
ExternalContext object.Returns the name of the scheme used to make this request, for example, http, https, or ftp.
ExternalContext.getRequestScheme() on the wrapped
ExternalContext object.Returns the host name of the server to which the request was sent.
ExternalContext.getRequestServerName() on the wrapped
ExternalContext object.Returns the port number to which the request was sent.
ExternalContext.getRequestServerPort() on the wrapped
ExternalContext object.null.ExternalContext.getRequestServletPath() on the wrapped
ExternalContext object.UIInput.setRequiredMessage(java.lang.String) on this instance, return the message.resetValues property.URL for the application resource mapped to the
specified path, if it exists; otherwise, return null.ExternalContext.getResource(String) on the wrapped
ExternalContext object.InputStream for an application resource mapped to
the specified path, if it exists; otherwise, return null.ExternalContext.getResourceAsStream(String) on the wrapped
ExternalContext object.ResourceBundle as defined in the application configuration resources under the specified name.
The default behavior of this method is to call
Application.getResourceBundle(jakarta.faces.context.FacesContext, String) on the wrapped Application
object.
Return a Map<String,String> of the ResourceBundle for this component.
Return the singleton, stateless, thread-safe ResourceHandler for this application.
The default behavior of this method is to call Application.getResourceHandler() on the wrapped
Application object.
Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts.
FacesContext.getResourceLibraryContracts() on the wrapped
FacesContext object.Return the resourceName for this resource.
The default behavior of this method is to call Resource.getResourceName() on the wrapped
ResourceHandler object.
Set of resource paths for all application resources
whose resource path starts with the specified argument.ExternalContext.getResourcePaths(String) on the wrapped
ExternalContext object.ViewHandlingStrategy instances.
Construct an absolute URL to this NavigationCase instance using
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String) on the path portion of the url.
If the value returned from this method is used as the file argument to the four-argument constructor for
java.net.URL (assuming appropriate values are used for the first three arguments), then a client making
a request to the toExternalForm() of that URL will select the argument path
for direct rendering.
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler
object.ExternalContext.getResponse() on the wrapped
ExternalContext object.Return the buffer size for the current response.
ExternalContext.getResponseBufferSize() on the wrapped
ExternalContext object.ExternalContext.getResponseCharacterEncoding() on the wrapped
ExternalContext object.true if the responseComplete() method has been called for the current request.FacesContext.getResponseComplete() on the wrapped
FacesContext object.ExternalContext.getResponseContentType() on the wrapped
ExternalContext object.
Returns a mutable Map<String, String> whose entries will be sent as response headers during
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext).
The default behavior of this method is to call Resource.getResponseHeaders() on the wrapped
ResourceHandler object.
Returns an OutputStream suitable for writing binary data to the user-agent.
ExternalContext.getResponseOutputStream() on the wrapped
ExternalContext object.
Returns a Writer suitable for writing character data to the user-agent.
ExternalContext.getResponseOutputWriter() on the wrapped
ExternalContext object.ResponseStateManager for the specified #renderKitId.ResponseStateManager to handle rendering technology specific state management
decisions.RenderKit.getResponseStateManager() on
the wrapped RenderKit object.ResponseStream to which components should direct their binary output.FacesContext.getResponseStream() on the wrapped
FacesContext object.ResponseWriter to which components should direct their character-based output.FacesContext.getResponseWriter() on the wrapped
FacesContext object.Return an immutable data structure containing all of the return nodes declared for this flow.
rev property.rev property.rev property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.
Unwrap the argument t until the unwrapping encounters an Object whose getClass() is not
equal to FacesException.class or jakarta.el.ELException.class.
ExceptionHandler.getRootCause(Throwable)
on the wrapped ExceptionHandler object.rootElement property.rowClass property.rowClass property.rowClasses property.rowClasses property.wrappedData available, return the length of the array.wrappedData available, return the length of the list.DataModel.DataModel.wrappedData available, return the length of the list.wrappedData available, return the length of the array returned by calling
getRows() on the underlying Result.ResultSet does not provide a standard way to determine the number of available rows
without scrolling through the entire ResultSet, and this can be very expensive if the number of rows is
large.wrappedData available, return 1.rowIndex.rowIndex.null for no associated row data.rowIndex.SortedMap array element at the index specified by
rowIndex of the array returned by calling getRows() on the underlying Result.Map representing the values of the columns for the row specified by
rowIndex, keyed by the corresponding column names.rows property.rules property.rules property.
Return the scope itself, exposed as a Map.
Return the name of this custom scope.
Return the script that implements this ClientBehavior's client-side logic.
Default implementation of of ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext).
Return the script that implements this ClientBehavior's client-side logic.
Take implementation specific action to discover a Resource given the argument
componentResource.
Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
Returns the SearchExpressionContext for the current request.
Return the thread-safe singleton SearchExpressionHandler for this application.
Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution.
selectedClass property.null if there are no currently selected values.SelectItem instances representing the available options for this
component, assembled from the set of UISelectItem and/or
UISelectItems components that are direct children of this component.SelectItems for this group.Return the character used to separate segments of a clientId.
ServletConfig instance for this servlet.create parameter is true, create (if necessary) and return a session instance
associated with the current request.ExternalContext.getSession(boolean) on the wrapped
ExternalContext object.
Return the id of the current session or the empty string if no session has been created and the create
parameter is false.
The default behavior of this method is to call ExternalContext.getSessionId(boolean) on the wrapped
ExternalContext object.
Map representing the session scope attributes for the current application.ExternalContext.getSessionMap() on the wrapped
ExternalContext object.Returns the maximum time interval, in seconds, that the Jakarta Servlet container will keep this session open between client accesses.
The default behavior of this method is to call ExternalContext.getSessionMaxInactiveInterval() on the wrapped
ExternalContext object.
shape property.shape property.shape property.size property.size property.size property.size property.size property.Returns the source / base component from which we will start to perform our search.
Returns an id for use as the ClientBehavior source.
Return the immutable id for the default node that should be activated when this flow is entered.
ResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object).
Return the StateHelper instance used to help this component implement PartialStateHolder.
Like UIComponent.getStateHelper(), but only create a state helper instance if the argument creat is
true.
For implementations that want to control the implementation of state saving and restoring, the
StateManagementStrategy allows them to do so.
StateManager instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getStateManager() on the wrapped Application
object.
ViewHandlingStrategy implementations.
If the value of this parameter comes from a ValueExpression return the value of the expression,
otherwise, return the local value.
Manually perform standard conversion steps to get a string value from the value expression.
style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.UIInput component.
Assume that the submitted value is always a string,
but the return type from this method is Object..
Given a NamingContainer component, returns the client ids of any components
underneath the NamingContainer that should be visited.
summary property.summary property.Iterator over the supported Locales for this appication.
The default behavior of this method is to call Application.getSupportedLocales() on the wrapped
Application object.
Return an immutable data structure containing all of the switch nodes declared for this flow.
system property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.A reference to the Tag for which this class represents the attributes.
A reference to the Tag for which this class represents the attributes.
Return the Tag representing this handler.
Get the tag handler delegate.
Return the implementation specific delegate instance that provides the bulk of the work for this handler instance.
A document-unique id, follows the convention "_tagId##"
target property.target property.target property.target property.
Return the Class of the metadata target.
Returns the List<UIComponent> that this AttachedObjectTarget exposes.
Returns the literal String value of the contained text.
Returns the resolved literal String value of the contained text after evaluating EL.
TimeZone used to interpret a time value.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.
If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is
given by the return from NavigationCase.getFromOutcome() is defined.
Evaluates the <to-view-id> for this <navigation-case>
Return the value currently associated with the specified key if any.
Performs the same logic as TransientStateHelper.getTransient(java.lang.Object) } but if no value is found, this will return the specified
defaultValue
Return the TransientStateHelper instance for this UIComponent instance.
Return the TransientStateHelper instance for this UIComponent instance.
ResponseStateManager.getState(jakarta.faces.context.FacesContext, java.lang.String). The default implementation returns null.null.StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext) on the wrapped StateManager
object.Class for a future set operation, which will always be null because sets
happen via the MapELResolver operating on the ELFlash instance as a Map.null.type property.type property.type property.type property.java.lang.Class representing the type of the specified property.java.lang.Class representing the type of the specified index.ValueBinding, relative to the specified
FacesContext.
Return the UIViewParameter to which this instance refers.
Return an Iterable over all ExceptionQueuedEvents that have not yet been handled by the
ExceptionHandler.handle() method.
ExceptionHandler.getUnhandledExceptionQueuedEvents() on the
wrapped ExceptionHandler object.unselectedClass property.
Return an actual URL instance that refers to this resource instance.
The default behavior of this method is to call Resource.getURL() on the wrapped ResourceHandler object.
Return an actual URL instance that refers to this resource instance.
UIGraphic.usemap property.<f:websocket user>, if any.Principal object containing the name of the current authenticated user, if any; otherwise,
return null.ExternalContext.getUserPrincipal() on the wrapped
ExternalContext object.Return the validation groups passed to the Validation API when checking constraints.
EditableValueHolder.getValidators() should be used instead.UIInput.getValidators() should be used instead.
Return the TagConfig subclass used to configure this handler instance.
Return the validator-id associated with a particular validator in your faces-config
EditableValueHolder.Iterator over the set of currently registered validator ids for this Application.
The default behavior of this method is to call Application.getValidatorIds() on the wrapped Application
object.
UIInput.setValidatorMessage(java.lang.String) on this instance, return the message.Validators for this component instance.flash implicit object.base is a composite component and property is attrs, return a new
ExpressionEvalMap which wraps the composite component's attributes map.null and base is an instance of ResourceHandler, perform the
following:
If property doesn't contain : treat property as the resource name and pass
property to ResourceHandler.createResource(String)
If property contains a single : treat the content before the : as the
library name, and the content after the : to be the resource name and pass both to
ResourceHandler.createResource(String, String)
If property contains more than one : then throw a ELException
If one of the above steps resulted in the creation of a Resource instance, call
ELContext.setPropertyResolved(true) and return the result of
Resource.getRequestPath()
Returns the Parameter's value.
value property of the UICommand.value property of the UIGraphic.
If there is a local value, return it, otherwise return the result of calling super.getVaue().
Return the value property.
value property of the UIParameter.value property of the UISelectItem.value property of the UISelectItems.UIComponent.ValueBinding, relative to the specified
FacesContext.
Return a ValueExpression for the value of the parameter.
UIComponent.getValueExpression(java.lang.String).UIComponent.getValueExpression(java.lang.String).UIGraphic.getValueExpression(java.lang.String).UISelectBoolean.getValueExpression(java.lang.String).UISelectMany.getValueExpression(java.lang.String).EditableValueHolder.getValueChangeListeners() instead.ValueChangeListeners for this component instance.ValueChangeListeners for this UIInput instance.
Returns the ValueExpression used to calculate the value for the specified property name, if any.
ValueExpression used to calculate the value for the specified attribute or property name, if any.ValueExpression set for value if a ValueExpression for url is
requested; otherwise, perform the default superclass processing for this method.ValueExpression set for value if a ValueExpression for selected
is requested; otherwise, perform the default superclass processing for this method.ValueExpression set for value if a ValueExpression for
selectedValues is requested; otherwise, perform the default superclass processing for this method.Application.getELResolver().Return the immutable VDL document id for this view node.
Utility method to extract view metadata from the provided UIViewRoot.
Return the ViewDeclarationLanguage instance used for this
ViewHandler instance.
ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String) on the wrapped
ViewHandler object.
Return the ViewDeclarationLanguage instance suitable for
handling the VDL contained in the page referenced by the argument viewId.
ViewHandler instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getViewHandler() on the wrapped Application
object.
null if the view identifier is nonexistent or unknown.Get the view id
Return the SystemEventListener instances registered on this UIComponent instance that are
interested in events of type eventClass.
This implementation simply calls through to UIViewRoot.getViewMap(boolean), passing true as the argument,
and returns the result.
Returns a Map that acts as the interface
to the data store that is the "view scope", or, if this instance does not have such a Map and the
create argument is true, creates one and returns it.
Return a reference to the view metadata for the view represented by the argument viewId, or
null if the metadata cannot be found.
Returns a cached View Metadata Facelet instance.
Utility method to extract view metadata from the provided UIViewRoot.
Return a Stream possibly lazily populated by walking the resource tree rooted at a given initial path.
Return a Stream possibly lazily populated by walking the resource tree rooted at a given initial path.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, int, ResourceVisitOption...) on the wrapped
ResourceHandler object.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...) on the wrapped
ResourceHandler object.
FacesContext.getViewRoot() on the wrapped FacesContext
object.
Return a Stream possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage rooted at a given initial path.
Return a Stream possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage rooted at a given initial path.
ViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrapped ViewHandler object.ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...) on the wrapped ViewHandler
object.Return an immutable data structure containing all of the view nodes declared for this flow.
Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path.
Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path.
Convenience method to return the view state as a String with no RenderKit specific markup.
The default behavior of this method is to call StateManager.getViewState(jakarta.faces.context.FacesContext)
on the wrapped StateManager object.
String without any markup related to the rendering technology supported
by this ResponseStateManager.
Return a new VisitContext instance.
Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver
implementation.
warnClass property.warnClass property.warnStyle property.warnStyle property.
If the value returned from this method is used as the file argument to the four-argument constructor for
java.net.URL (assuming appropriate values are used for the first three arguments), then a client making
a push handshake request to the toExternalForm() of that URL will select the argument
channel for connecting the websocket push channel in the current view.
ViewHandler.getWebsocketURL(FacesContext, String) on the
wrapped ViewHandler object.width property.width property.width property.If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
A class that implements this interface uses this method to return an instance of the class being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
DataModel, if any.DataModel, if any.
Return a Method for the setter of the property with name given by argument name.
Documents to be processedxmlns property.xmlns property.UIPanel component as a "Grid".encodeEnd() method.
Take action to handle the Exception instances residing inside the ExceptionQueuedEvent instances
that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class,
eventContext).
ExceptionHandler.handle() on the wrapped
ExceptionHandler object.afterPhase PhaseListener events.beforePhase PhaseListener events.FacesContext, plus the outcome string returned by an executed application action.
Overloaded variant of
NavigationHandler.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.
This method specifies the contract for satisfying resource requests.
The default behavior of this method is to call
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext) on the wrapped
ResourceHandler object.
ViewHandlingStrategy should be the last one queried and as such we return true.true if this component has a non-null binding attribute.
Test if this navigation case has an associated <if> element.
Overrides the default hash code method to take the minimum and maximum into account when generating the hash code.
Utility method to determine if the the provided UIViewRoot has metadata.
true if the iteration has more elements.WebConfiguration.WebContextInitParameter.ClientStateTimeout init parameter is
set, calculate the elapsed time between the time the client state was written and the time this method was invoked
during restore.
The presence of this annotation (along with @Inject) on a field of type Map<String,
String> causes the map returned from ExternalContext.getRequestHeaderMap() to
be injected as the value of that field.
The Header map producer is the CDI producer that allows injection of the header map using @Inject.
The presence of this annotation (along with @Inject) on a field of type Map<String,
String[]> causes the map returned from
ExternalContext.getRequestHeaderValuesMap() to be injected as the value of that field.
The Header values map producer is the CDI producer that allows injection of the header values map using @Inject.
UIInput component as a HTML hidden
variable.
The ServletContext init parameter consulted by the UIComponent to tell whether or not the
UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT attribute keys should be honored as specified.
RenderKit instance for this Jakarta Server Faces implementation.UIParameter.table element.input element for a button of type submit or reset.a element for a hyperlink that acts like a submit button.script element for a function that acts like an ajax form submit.table element.form element.img element, used to retrieve and render a graphical image.input element of type hidden.input element of type password.input element of type text.textarea element.rendererType property must be set to "jakarta.faces.Message".rendererType property must be set to "jakarta.faces.Messages".input element of type "button" or image that may be used to link to a URL handled by
the Faces Servlet resolved preemptively using the logical outcome defined by the outcome property.a (hyperlink) element that may be used to link to a URL handled by the Faces Servlet
resolved preemptively using the logical outcome defined by the outcome property.MessageFormat pattern string and substitutes in parameter values from nested UIParameter
components, and renders the result.label element, used to define an accessible label for a corresponding input element.a (hyperlink) element that may be used to link to an arbitrary URL defined by the
value property.span element if I18N attributes, CSS
styles or style classes are specified.ResponseWriter abstract
class.ResponseWriter and encoding, and enables script hiding by default.ResponseWriter and encoding.input element of type
checkbox.input elements of type checkbox.select element, showing either all
available options or the specified number of options.select element, showing a single
available option at a time.select element, showing either all
available options or the specified number of options.select element, showing a single
available option at a time.input elements of type radio.Set the defining document id and flow id of this flow.
Customize this MetaRuleset instance to advise it to ignore the attribute named by the
attribute argument, returning this.
Customize this MetaRuleset instance to advise it to ignore all attributes, returning this.
The presence of an entry under this key in the Map returned from ExceptionQueuedEventContext.getAttributes() indicates the
event occurred during the “after phase” part of the current lifecycle phase.
The presence of an entry under this key in the Map returned from ExceptionQueuedEventContext.getAttributes() indicates the
event occurred during the “before phase” part of the current lifecycle phase.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages)
Include another Facelet defined at some path, absolute to this ClassLoader/OS
Indicates the current redirect should include view parameters.
A MethodExpression that will be invoked when the flow is entered.
A MethodExpression that will be invoked when the flow is entered.
Implementation of PartialStateHolder.initialStateMarked().
Return true if delta state changes are being tracked, otherwise false
An implementation of PartialStateHolder.initialStateMarked(), this method is called by the runtime to test if
the PartialStateHolder.markInitialState() method was called.
The presence of this annotation (along with @Inject) on a field of type Map<String,
String> causes the map returned from ExternalContext.getInitParameterMap() to
be injected as the value of that field.
The init parameter map producer is the CDI producer that allows injection of the init parameter map using @Inject.
ViewHandler.initView(jakarta.faces.context.FacesContext)ViewHandler.initView(jakarta.faces.context.FacesContext) if the
ExternalContext.getRequestCharacterEncoding() returns a non-null result.ViewHandler.initView(jakarta.faces.context.FacesContext) on the wrapped ViewHandler
object.ApplicationFactory is responsible for injecting the default
Application instance into the top-level Application as configured by the runtime.FacesContextFactory is responsible for injecting the default FacesContext instance into the
top-level FacesContext as configured by the runtime.
This is a work around in order to be able to get InjectionPoint in CdiProducer.
InjectionProvider.InjectionProviderException with the root cause of the error.InjectionProviderException with a descriptive message and the root cause of the error.InjectionProvider instances.TagHandler is responsible for relocating children defined within a composite component to a
component within the composite component's composite:implementation section.TagHandler is responsible for relocating Facets defined within a composite component to a component
within the composite component's composite:implementation section.Called by the flow system to cause the flow to be inspected for navigation rules.
FacesMessage to be created if the conversion to
Integer fails.Converter implementation for java.lang.Integer (and int primitive) values.FacesMessage to be created if a value not matching
the available options is specified.FacesMessage to be created if a value not matching
the available options is specified.Invalidates this session then unbinds any objects bound to it.
ExternalContext.invalidateSession() on the wrapped
ExternalContext object.FacesServlet path of the original request.FacesContext.UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback) and must be passed the
component with the clientId given as an argument to invokeOnComponent.
This method will be called by an implementation of SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String) with the resolved component
for the keyword.
Resolves multiple UIComponents for the given expression.
Resolves multiple UIComponents for the given expression.
clientId equal to the argument clientId and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) method on the argument callback, passing the current
FacesContext and the found component as arguments.clientId equal to the argument clientId and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent) method on the argument callback, passing the current
FacesContext and the found component as arguments.UIComponentBase.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.@PostConstruct annotation (per
the Common Annotations Specification).@PreDestroy annotation (per the
Common Annotations Specification).UIComponent.visitTree() to visit a single component.
Marker within the FacesContext attributes map to indicate we are marking initial state, so the
markInitialState() method of iterating components such as UIData could
recognize this fact and save the initial state of descendents.
Marker within the FacesContext attributes map to indicate we are saving state.
Return true if and only if the flow referenced by the argument definingDocument and id is
currently active.
Return true if the request header Faces-Request is present with the value
partial/ajax.
PartialViewContext.isAjaxRequest() on the wrapped
PartialViewContext object.true if at least one value is empty.
Return true if this FacesListener is an instance of a the appropriate listener class that this
event supports.
Return true if the argument FacesListener is an instance of the appropriate listener class that
this event supports.
true if this FacesListener is an instance of a listener class that this event supports.
Returns true if and only if the argument listener is an instance of
SystemEventListener.
Returns true if and only if the argument listener is an instance of
SystemEventListener.
true if this FacesListener is an instance of a
the appropriate listener class that this event supports.autorun property.Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.
Return true if component is a composite component, otherwise false.
Return the value of the disable directive for this component.
Return whether or not the client window should be encoded into the target url.
Return the disabled status of this behavior.
disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.true.true if the given array is null or is empty.true if the given collection is null or is empty.true if the given value is null or is empty.Is the value denoting an empty value.
The default behavior of this method is to call Map.isEmpty() on the wrapped Flash object.
escape property.escape property.escape property.
If and only if this returns true, the code that renders this select item must escape the label using
escaping syntax appropriate to the content type being rendered.
url-mapping is an exact mapping (starts with Util.EXACT_MARKER).
Return true if PartialViewContext.isAjaxRequest() returns true and PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS.
PartialViewContext.isExecuteAll() on the wrapped
PartialViewContext object.Determines whether a cached Facelet instance exists for this URL.
true if getAsString should include grouping separators if necessary.ActionListener provided by the Jakarta Server Faces implementation
should be executed immediately (that is, during Apply Request Values phase of the request processing
lifecycle), rather than waiting until the Invoke Application phase.Return the immediate status of this behavior.
If the value of the component's immediate attribute is true, the action will be invoked
during the Apply Request Values Jakarta Server Faces lifecycle phase.
Return false.
Tests whether the immediate attribute is specified.
Return the <redirect> value for this <navigation-case>.
Return whether or not the view parameters should be encoded into the target url.
true if only the integer portion of the given value should be returned from
getAsObject().
Return true if this component is within the view hierarchy otherwise false
Override superclass method to always return true because a UIViewRoot is defined to always be in a
view.
ismap property.Return the value of this JavaBeans property for the flash for this session.
The default behavior of this method is to call Flash.isKeepMessages() on the wrapped Flash object.
Returns if the keyword was resolved.
A leaf keyword is a keyword that does not allow to be combined with keywords or id chains to the right.
UIViewRoot.true if and only if this listener instance is interested in receiving events
from the instance referenced by the source parameter.ExceptionHandler.isListenerForSource(Object) on the wrapped ExceptionHandler
object.true if and only if this listener instance is interested in receiving events
from the instance referenced by the source parameter.false since we can't possibly know if this is a literal text binding or not.Determine if the passed component is not null and if it's new to the tree.
Return the value of the noSelectionOption property.
Return the value of the noSelectionOption property.
true if the given object equals one of the given objects.
If true this component will operate on postback.
Return true PartialViewContext.isAjaxRequest() returns true or if the request header
Faces-Request is present with the value partial/process.
PartialViewContext.isPartialRequest() on the wrapped
PartialViewContext object.A passthrough keyword is a keyword, that according to the context, does not require to be resolved on the server, and can be passed "unresolved" to the client.
Checks if the given expression is a "passtrough expression".
FacesContext is a
PortletRequest submitted by the JSR-301 bridge.
This utility method simply returns the result of
ResponseStateManager.isPostback(FacesContext).
FacesContext.isPostback() on the wrapped FacesContext
object.url-mapping is a prefix path mapping (starts with /).
Returns true if the current request processing lifecycle is in the midst of processing the broadcast of
an event queued during a call to UIViewAction.decode(jakarta.faces.context.FacesContext).
Returns a flag indicating whether or not the runtime should publish events when asked to do so.
FacesContext.isProcessingEvents() on the
wrapped FacesContext object.
Return true if the current ProjectStage as returned by the Application instance is equal
to stage, otherwise return false
FacesContext.isProjectStage(jakarta.faces.application.ProjectStage) on the wrapped
FacesContext object.true because write operations take place via the MapELResolver on the actual
ELFlash instance.truereadonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.true if the specified property of the specified property is known to be immutable; otherwise,
return false.
Return the <redirect> value for this <navigation-case>.
Return the value of this property for the flash for this session.
The default behavior of this method is to call Flash.isRedirect() on the wrapped Flash object.
redisplay property.
Return a flag indicating if the resources associated with this FacesContext instance have been released.
The default behavior of this method is to call FacesContext.isReleased() on the wrapped FacesContext
object.
Return true if PartialViewContext.isAjaxRequest() returns true and PartialViewContext.PARTIAL_RENDER_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS.
PartialViewContext.isRenderAll() on the wrapped
PartialViewContext object.true if this component (and its children) should be rendered during the Render Response
phase of the request processing lifecycle.
Return true if this component should take the actions specified in the UIViewAction.decode(jakarta.faces.context.FacesContext) method.
Return the resetValues status of this behavior.
Return true if the incoming request has a parameter named by the value of
PartialViewContext.RESET_VALUES_PARAM_NAME and that value is true.
PartialViewContext.isResetValues() on the wrapped
PartialViewContext object.Tests whether the resetValues attribute is specified.
Checks if the current instance of the SearchKeywordResolver is responsible for resolving the keyword.
Returns whether the resource as identified by given resource and library name has been rendered.
The default behavior of this method is to call
ResourceHandler.isResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler
object.
Return true if the current request is a resource request.
The default behavior of this method is to call
ResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext) on the wrapped ResourceHandler
object.
Return true if the argument url contains the string given by the value of the constant
ResourceHandler.RESOURCE_IDENTIFIER, false otherwise.
The default behavior of this method is to call ResourceHandler.isResourceURL(java.lang.String) on the wrapped
ResourceHandler object.
Check if the current response has been committed.
ExternalContext.isResponseCommitted() on the wrapped
ExternalContext object.rowData available at the current rowIndex.true if there is wrappedData available, and the current value of
rowIndex is greater than or equal to zero, and less than the length of the array.true if there is wrappedData available, and the current value of
rowIndex is greater than or equal to zero, and less than the size of the list.rowData available at the current rowIndex.rowData available at the current rowIndex.true if there is wrappedData available, and the current value of
rowIndex is greater than or equal to zero, and less than the size of the list.true if there is wrappedData available, and the current value of
rowIndex is greater than or equal to zero, and less than the length of the array returned by calling
getRows() on the underlying Result.true if there is wrappedData available, and the result of calling
absolute() on the underlying ResultSet, passing the current value of rowIndex
plus one (to account for the fact that ResultSet uses one-relative indexing), returns true.true if there is wrappedData available, and the current value of
rowIndex is zero.rowHeader property.
Return the value of the rowStatePreserved JavaBeans property.
StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext) on the wrapped StateManager
object.Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
The default behavior of this method is to call ExternalContext.isSecure() on the wrapped
ExternalContext object.
detail property of the associated message(s) should be displayed.detail property of the associated message(s) should be displayed.summary property of the associated message(s) should be
displayed.summary property of the associated message(s) should be
displayed.
If the preceding call to ResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object) was stateless,
return true.
submitted property.
Return true if the target for this metadata element is an instance of the argument type.
tooltip property.tooltip property.
Implementation of StateHolder.isTransient().
true if the currently authenticated user is included in the specified role.ExternalContext.isUserInRole(String) on the wrapped
ExternalContext object.
Return true if the validationFailed() method has been called for the current request.
FacesContext.isValidationFailed() on the
wrapped FacesContext object.Checks if the given expression is a valid expression.
true if the specified value conforms to the syntax requirements of a value binding expression.Determines whether a cached View Metadata Facelet instance exists for this URL.
Return true if this component should be visited, false otherwise.
IterableDataModel is an implementation of DataModel that wraps an Iterable.
IterableDataModel with no specified wrapped data.IterableDataModel wrapping the specified iterable.
Return a read-only Iterator over the row data for this model.
Library name of Jakarta Server Faces script resource.
Resource name of Jakarta Server Faces script resource.
Identifier for the Jakarta Server Pages view declaration language.
ViewHandlingStrategy handles JSP-based views.
Causes a value stored with a previous call to Flash.putNow(java.lang.String, java.lang.Object), its Jakarta Expression Language equivalent, or to the
request Map, to be promoted to the flash so that is available on the next traversal through the
lifecycle on this session.
The default behavior of this method is to call Flash.keep(String) on the wrapped Flash object.
The default behavior of this method is to call Map.keySet() on the wrapped Flash object.
The prefix to identify a keyword.
Validator that checks the number of
characters in the String representation of the value of the associated component.Validator with no preconfigured limits.Validator with the specified preconfigured limit.Validator with the specified preconfigured limits.
Return true if the resource library named by the argument
libraryName can be found.
The default behavior of this method is to call ResourceHandler.libraryExists(String) on the wrapped
ResourceHandler object.
LibraryInfo is a simple wrapper class for information pertinent to building a complete resource path
using a Library and/or Contract.LifecycleFactory class name.Lifecycle instance to be utilized.ConfigProcessor handles all elements defined under /faces-config/lifecycle.Lifecycle instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
UISelectOne or UISelectMany
component as a list of options.DataModel that wraps an List
of Java objects.ListDataModel with no specified wrapped data.ListDataModel wrapping the specified list.
Classes tagged with this annotation are installed as listeners using the method
Application.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Class<?>, jakarta.faces.event.SystemEventListener) or
UIComponent.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, jakarta.faces.event.ComponentSystemEventListener) (depending on the circumstances, described below).
Container annotation to specify multiple ListenerFor annotations on a single class.
FacesContext.
The name of a key within the application message bundle named by the return from Application.getMessageBundle()
whose value is the locale prefix used to find a packaged resource to return from ResourceHandler.createResource(java.lang.String) (or one of
its variants).
An object that represents the Location of a tag or attribute of a tag in a View Declaration Language file.
ExternalContext.log(String) on the wrapped
ExternalContext object.ExternalContext.log(String, Throwable) on the wrapped
ExternalContext object.FacesMessage to be created if the conversion to
Long fails.Converter implementation for java.lang.Long (and long primitive) values.Validator that checks the value
of the corresponding component against specified minimum and maximum values.Validator with no preconfigured limits.Validator with the specified preconfigured limit.Validator with the specified preconfigured limits.Class instance based on the provided String name.Constructor appropriate to the specified Class and parameters.Method appropriate to the specified object instance, method name, and parameters.Method appropriate to the specified Class, method name, and parameters.LinkedHashMap to provide LRU functionality.jakarta.enterprise.context.Initialized event for
jakarta.enterprise.context.ApplicationScoped. See 6.7.3 of the CDI spec for further details.ConfigAnnotationHandler for ManagedBean annotated classes.ConfigProcessor handles all elements defined under /faces-config/managed-bean.managed-bean entry within a faces-config.xml.List instances.Map instances.
The presence of this annotation (along with @Inject) on a field of any type causes the value returned from
evaluating an expression language expression to be injected as the value of that field.
jakarta.faces.annotation.ManagedProperty, which is a CDI build-in bean
with similar semanticsThe ManagedPropertyProducer is the CDI producer that allows evaluation of arbitrary EL expressions.
Mark this node as the start node in the flow.
Implementation of PartialStateHolder.markInitialState().
The runtime must ensure that the PartialStateHolder.markInitialState() method is called on each instance of this interface in the
view at the appropriate time to indicate the component is in its initial state.
An implementation of PartialStateHolder.markInitialState(), this method is called by the runtime to indicate
that the instance should start tracking changes to its state.
For each of the attached objects on this instance that implement PartialStateHolder, call
PartialStateHolder.markInitialState() on the attached object.
Override the base class method to take special action if the method is being invoked when
StateManager.IS_BUILDING_INITIAL_STATE is true and the rowStatePreserved
JavaBeans property for this instance is true.
UIOutput when PartialStateHolder.markInitialState() is called,
check if any of the installed Validators are PartialStateHolders and if so, call
PartialStateHolder.markInitialState() as appropriate.UIComponentBase when PartialStateHolder.markInitialState() is
called, check if the installed Converter is a PartialStateHolder and if it is, call
PartialStateHolder.markInitialState() on it.Mark the resource as identified by given resource and library name as rendered.
The default behavior of this method is to call
ResourceHandler.markResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler
object.
FacesMessage to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern() fails because of a PatternSyntaxException.FacesMessage to be created if the maximum value check
fails.FacesMessage to be created if the maximum length
check fails.FacesMessage to be created if the maximum value check
fails.UISelectOne or UISelectMany
component as a list of menu options.FacesMessage to be created if a constraint failure is
found.package and protection.package and protection.FacesMessage instances or
localized Strings for said constants.There are concrete subclasses within the implementation that map concepts in the Facelet VDL page to Jakarta Server Faces Java API calls the appropriate instances.
FacetHandler to enable f:metadata support.The root class of the abstraction that dictates how attributes on a markup element in a Facelets VDL page are wired to the Jakarta Server Faces API object instance associated with that element.
A mutable set of rules to be used in auto-wiring state to a particular object instance.
Every kind of markup element in Facelets VDL that has attributes that need to take action on a Jakarta Server Faces Java API artifact is associated with an instance of this class.
MethodExpression.
Create a method call node in the current Flow.
Define a method call node.
Represents a method call node in the flow graph.
ValueChangeListener that
contains a MethodExpression.Validator that wraps a
MethodExpression, and it performs validation by executing a method on an object identified by the
MethodExpression.Validator that contains a MethodExpression.ValueChangeListener that contains a
MethodExpression.To accommodate method expression targets that take no
arguments instead of taking a ValueChangeEvent argument, the implementation of this class must take
the argument methodExpressionOneArg, extract its expression string, and create another
MethodExpression whose expected param types match those of a zero argument method.ValueChangeListener that contains a MethodExpression.MethodNotFoundException.FacesMessage to be created if the minimum value check
fails.FacesMessage to be created if the minimum length
check fails.FacesMessage to be created if the minimum value check
fails.ViewHandler implementation handles both JSP-based and Facelets/PDL-based views.
NavigationCase represents a <navigation-case> in
the navigation rule base, as well as the <from-view-id> with
which this <navigation-case> is a sibling.
The presence of this annotation on a class automatically registers the class with the runtime as a
ComponentSystemEvent for use with the <f:event /> tag in a page.
Components that declare a createTag = true attribute will be placed into this tag namespace if the
namespace attribute is omitted.
UIComponent that wants to be a naming container.
NavigationCase represents a <navigation-case> in
the navigation rule base, as well as the <from-view-id> with
which this <navigation-case> is a sibling.
Construct a new NavigationCase based on the provided arguments.
Construct a new NavigationCase based on the provided arguments.
Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next.
Create a navigation case in the current Flow.
Allows populating the redirect with parameters and setting the includeViewParams option.
Provides a simple implementation of NavigationCase that can be
subclassed by developers wishing to provide specialized behavior to an existing NavigationCase instance.
If this navigation case has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ConfigProcessor handles all elements defined under /faces-config/managed-bean.ApplicationAssociate instance to obtain the navigation mappings used
to make navigational decisions.
NavigationHandlerWrapper provides a simple implementation of
NavigationHandler that can be subclassed by developers wishing to provide specialized behavior to an existing
NavigationHandler instance.
If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Create a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL.
A reference to the FaceletHandler that represents the first nested child of this TagHandler
instance.
Base interface for building all kinds of flow nodes.
The value of this constant is taken to be the name of a request parameter whose value is inspected to verify the
safety of an incoming non-postback request with respect to the currently configured Set of protected
views for this application.
jakarta.enterprise.context.Dependent, which is a CDI build-in scope
with approximately similar semantics.ExternalContext.getRequestServletPath()) starts with mapping + '/', prune the mapping from
the URI and return it, otherwise, return the original URI.FacesMessage to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern() fails because the value does not match the pattern.
Components that are rendered by Renderers of component-family jakarta.faces.OutcomeTarget
must use this constant as the value of the parameter named by FlowHandler.TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME when
returning from a flow (without entering another flow) using such a component.
Because null values are not allowed as the source for subclasses of EventObject, such as
PostKeepFlashValueEvent and PostPutFlashValueEvent, this value is substituted for null
as the source in the case when a null value is put to or kept in the flash.
FacesMessage to be created if the conversion to
Number fails.Converter implementation for java.lang.Number
values.WebsocketSessionManager.This method is guaranteed to be called after the component has been created but before it has been populated with children.
This method is guaranteed to be called after the component has been populated with children.
WebocketSessionManager.Define an outbound parameter for the flow call.
Define an outbound parameter for the flow call.
PageContext for the page we are embedded in.Creates a Parameter instance.
Add a parameter to the redirect.
Represents a parameter in any of several places where parameters are needed when processing flows.
ParameterizedTypeImpl is a basic implementation of the ParameterizedType interface.
Set the parameters of the method call node.
Callable will be used by
ConfigManager#getXMLDocuments(jakarta.servlet.ServletContext, java.util.List, java.util.concurrent.ExecutorService, boolean).The request parameter name whose request parameter value identifies the type of partial event.
The request parameter name whose request parameter value is a Collection of client identifiers
identifying the components that must be processed during the Apply Request Values, Process
Validations, and Update Model Values phases of the request processing lifecycle.
The request parameter name whose request parameter value is a Collection of client identifiers
identifying the components that must be processed during the Render Response phase of the request processing
lifecycle.
The ServletContext init parameter consulted by the runtime to determine if the partial state saving
mechanism should be used.
The property name for the PartialViewContextFactory class name.
PartialResponseWriter decorates an existing ResponseWriter to support the generation of
a partial response suitable for Ajax operations.
Create a PartialResponseWriter.
Components that want to leverage the partial state saving feature must implement this interface instead of
implementing StateHolder, from which this interface inherits.
PartialViewContextFactory is a factory object that creates (if needed) and
returns new PartialViewContext instances.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
PartialViewContext instance.
Provides a simple implementation of
PartialViewContext that can be subclassed by developers wishing to provide specialized behavior to an
existing PartialViewContext instance.
If this partial view context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
A VisitContext implementation that is used when performing a partial component tree visit.
The key in the component passthrough attributes Map for the localName of the element corresponding to the
component.
FacesMessage to be created if the conversion to
Number fails.FacesMessage to be created if the value returned from
RegexValidator.getPattern() is null or the empty String.FacesMessage to be created if the conversion to
Number fails.A convenience method to signal the Jakarta Server Faces implementation to perform navigation with the provided outcome.
Lifecycle.FacesContext.getPhaseId() method of the FacesEvent interface.
Return a PhaseId representation of the arcument phase.
PhaseListener instance and registers it on the UIViewRoot
associated with our most immediate surrounding instance of a tag whose component is an instance of
UIViewRoot.Evaluation stack.AjaxBehavior instance from the List.
Pop the current UIComponent from the FacesContext attributes map so that the previous
UIComponent, if any, becomes the current component.
Enable the correct handling of navigation when processing a return node.
Service providers that implement this service must be called by the Jakarta Server Faces runtime exactly once for each implementation, at startup, before any requests have been serviced.
ValidatorInfo instance from the stack.
When an instance of this event is passed to
SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener
implementation may assume that the source of this event instance is a UIComponent instance and
that either that instance or an ancestor of that instance was just added to the view.
Instantiate a new PostAddToViewEvent that indicates the argument component was just added
to the view.
Instantiate a new PostAddToViewEvent that indicates the argument component was just added
to the view.
This event must be published by the runtime after all configuration resources have been parsed and processed.
Constructs a new PostConstructApplicationEvent for this application.
Constructs a new PostConstructApplicationEvent for this application.
This class is provided to allow custom scopes to publish a "post construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext was
just created.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext was
just created.
This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.
Instantiate a new PostConstructViewMapEvent that indicates the argument root was just
associated with its view map.
Instantiate a new PostConstructViewMapEvent that indicates the argument root was just
associated with its view map.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) when a value is
kept in the flash.
Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept in
the flash.
Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept in
the flash.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) when a value is
stored in the flash.
Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put to
the flash.
Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put to
the flash.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is the UIViewRoot instance that has just been rendered.
Instantiate a new PostRenderViewEvent that indicates the argument root has just been
rendered.
Instantiate a new PostRenderViewEvent that indicates the argument root has just been
rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is in a tree that has just had its state restored.
Instantiate a new PostRestoreStateEvent that indicates the argument component just had its
state restored.
Instantiate a new PostRestoreStateEvent that indicates the argument component just had its
state restored.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is the UIComponent instance that is that has just been validated.
Constructor
Constructor
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) before the flash
is cleared.
Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the
flash.
Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the
flash.
This event must be published by the runtime before the factories associated with this Application
are released.
Constructs a new PreDestroyApplicationEvent for this application.
Constructs a new PreDestroyApplicationEvent for this application.
This class is provided to allow custom scopes to publish a "pre construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext is
about to end.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext is
about to end.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) when the
clear method is called on the map returned from UIViewRoot.getViewMap().
Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its
associated view map destroyed.
Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its
associated view map destroyed.
This ExceptionHandlerFactory instance produces Jakarta Server Faces 1.2 compatible ExceptionHandler
instances.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object) when a value is
removed from the flash.
Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed
from the flash.
Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed
from the flash.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is a UIComponent instance that is about to be removed from the
view.
Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be
removed from the view.
Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be
removed from the view.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is the UIComponent instance that is about to be rendered and that
it is safe to call UIComponent.getParent(), UIComponent.getClientId(), and other methods that depend upon
the component instance being in the view.
Instantiate a new PreRenderComponentEvent that indicates the argument component is about to
be rendered.
Instantiate a new PreRenderComponentEvent that indicates the argument component is about to
be rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is the UIViewRoot instance that is about to be rendered.
Instantiate a new PreRenderViewEvent that indicates the argument root is about to be
rendered.
Instantiate a new PreRenderViewEvent that indicates the argument root is about to be
rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent) or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent), the listener implementation may assume that the
source of this event instance is the UIComponent instance that is about to be validated.
Constructor
Constructor
Documents.ActionEvent occurs.MethodExpression passed in
our constructor.FacesContext.renderResponse() or FacesContext.responseComplete() to be called.UIComponentBase.processDecodes(jakarta.faces.context.FacesContext) processing to perform the following steps.UIComponent.processDecodes(jakarta.faces.context.FacesContext) to ensure that the form is decoded before its children.rendered or connected attribute, then render either
the open() script or the close() script.WebsocketFacesListener if necessary.The default implementation performs the following action.
If the argument event is an instance of PostRestoreStateEvent and
PartialViewContext.isPartialRequest() returns true, then loop over all component resources and
call ResourceHandler.markResourceRendered(FacesContext, String, String) for each of them.
SystemEvent
subclass are true.ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent) on the wrapped
ExceptionHandler object.SystemEvent
subclass are true.SystemEvent
subclass are true.
Broadcast this event instance to the specified FacesListener, by whatever mechanism is appropriate.
Broadcast this event instance to the specified FacesListener by calling the superclass's
processListener() implementation.
FacesEvent to the specified FacesListener, by whatever mechanism is appropriate.FacesListener, by whatever mechanism is appropriate.
Perform lifecycle processing on components during the indicated phaseId.
PartialViewContext.processPartial(PhaseId) on the wrapped
PartialViewContext object.
The default implementation must call
UIComponentBase.processRestoreState(jakarta.faces.context.FacesContext, java.lang.Object) from within a try block.
UIComponentBase.processUpdates(jakarta.faces.context.FacesContext) processing to perform the following steps.UIComponent.processUpdates(jakarta.faces.context.FacesContext) to ensure that the children of this UIForm instance are only
processed if UIForm.isSubmitted() returns true.processUpdates behavior inherited from UIComponentBase, calls
updateModel().processValidators on each component in the tree.
Override the default UIComponentBase.processValidators(jakarta.faces.context.FacesContext) processing to perform the following steps.
Override UIComponent.processValidators(jakarta.faces.context.FacesContext) to ensure that the children of this UIForm instance are
only processed if UIForm.isSubmitted() returns true.
processValidators behavior
inherited from UIComponentBase, calls validate() if the immediate property is false
(which is the default); if the component is invalid afterwards, calls FacesContext.renderResponse().
If UISelectOne.getGroup() is set, and UIInput.getSubmittedValue() is empty, and at least one other component having the
same group within a UIForm parent has a non-empty UIInput.getSubmittedValue() or returns
true on UIInput.isLocalValueSet() or returns false on UIInput.isValid(), then skip
validation for current component, else perform standard superclass processing by
super.processValidators(context).
Specialize superclass behavior to treat null differently.
MethodExpression passed in
our constructor.ValueChangeEvent occurs.
The value of this constant is the name used for JNDI lookups for setting the current value to be returned by
Application.getProjectStage().
The value of this constant is the value of the param-name for setting the current value to be returned
by Application.getProjectStage().
This class enables a feature similar to the RAILS_ENV feature of the Ruby on Rails web framework.
PropertyNotFoundException.ELResolver.PropertyResolver.This exception is thrown by the runtime when a violation of the view protection mechanism is encountered.
ConfigProcessor handles all elements defined under /protected-views.
If FacesContext.isProcessingEvents() is true and there are one or more
listeners for events of the type represented by systemEventClass, call those listeners, passing
source as the source of the event.
This method functions exactly like Application.publishEvent(FacesContext,Class,Object), except the run-time must use the
argument sourceBaseType to find the matching listener instead of using the Class of the
source argument.
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Object) on the wrapped
Application object.
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object) on the wrapped
Application object.
Push the configuration based on the collected metadata to the current application.Evaluation stack.StackType stack.Evaluation stack.
The CDI annotation @Push allows you to inject a PushContext associated with a given
<f:websocket> channel in any container managed artifact in WAR.
AjaxBehavior instance onto the List.
Push the current UIComponent this to the FacesContext attribute map using the key
UIComponent.CURRENT_COMPONENT saving the previous UIComponent associated with UIComponent.CURRENT_COMPONENT
for a subsequent call to UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext).
CDI interface to send a message object to the push socket channel as identified by @Push.
Enable the correct handling of navigation when processing a return node.
ValidatorInfo onto the stack.Return the previously stored value and store the specified key/value pair.
Store the specified mapKey/value in a Map that is internal to the helper, and
return the previously stored value.
The default behavior of this method is to call Map.put(K, V) on the wrapped Flash object.
The default behavior of this method is to call Map.putAll(Map) on the wrapped Flash object.
Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal.
The default behavior of this method is to call Flash.putNow(String, Object) on the wrapped Flash
object.
Return the previously stored value and store the specified key/value pair.
queueEvent and take the following action.UIComponentBase.queueEvent(jakarta.faces.event.FacesEvent) processing to wrap any queued events in a wrapper so that we
can reset the current row index in broadcast().UIComponentBase.queueEvent(jakarta.faces.event.FacesEvent) behavior to accumulate the queued events for later
broadcasting.UISelectOne or UISelectMany
component as a list of radio buttonsresponseComplete() method to be called on the FacesContext instance for the current request.ExternalContext.redirect(String) on the wrapped
ExternalContext object.Write a redirect operation.
Create a redirect within this navigation case.
Construct a reference to a UIViewParameter.
ELException.A Validator that checks against a Regular Expression (which is the pattern property).
FacesContext
instance.FacesContext.release() on the wrapped FacesContext
object.PartialViewContext
instance.PartialViewContext.release() on the wrapped
PartialViewContext object.Remove the key/value pair from the helper, returning the value previously stored under this key.
Remove a value from the inner data structure.
The default behavior of this method is to call Map.remove(Object) on the wrapped Flash object.
ActionListener (if any) from the set of listeners interested in being notified when
ActionEvents occur.ActionListener (if any) from the set of listeners interested in being notified when
ActionEvents occur.
Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications
from this AjaxBehavior.
Remove the specified BehaviorListener from the set of listeners registered to receive event notifications
from this Behavior.
Remove argument component, which is assumed to represent a resource instance, as a resource to this
view.
Remove argument component, which is assumed to represent a resource instance, as a resource to this
view.
DataModelListener from the set interested in notifications from this DataModel.listener from the list of ELContextListeners.
The default behavior of this method is to call
Application.removeELContextListener(jakarta.el.ELContextListener) on the wrapped Application object.
FacesListener from the set of listeners registered to receive event notifications from
this UIComponent.FacesListener from the set of listeners registered to receive event notifications from
this UIComponent.toRemove is in the list of PhaseListeners for this instance, it must be removed.PhaseListener instance that is no longer interested in being notified before and after
the processing for standard phases of the request processing lifecycle.
Remove the argument urlPattern from the thread safe Set of protected views for this
application, if present in the Set.
ViewHandler.removeProtectedView(java.lang.String) on the wrapped
ViewHandler object.Validator instance from the set associated with this component, if it was previously associated.ValueChangeListener (if any) from the set of listeners interested in being notified when
ValueChangeEvents occur.ValueChangeListener (if any) from the set of listeners interested in being notified when
ValueChangeEvents occur.responseComplete() method has been called on the FacesContext instance associated with the
current request.Reserved ID value to indicate entire ViewRoot.
RenderKitFactory class name.ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext) to derive a RenderKit ID.RenderKit being used for this request.captionClass as the class and
captionStyle as the style if either are present.UIComponents into the output stream (or writer) associated with the response we are creating for a particular
request.If this renderer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
tfoot elements and any content nested between.thead elements and any content nested between.Renderer
instances that, together, know how to render Jakarta Server Faces UIComponent instances for a specific
client.ConfigAnnotationHandler FacesRenderer annotated classes.ConfigProcessor handles all elements defined under /faces-config/render-kit.RenderKit instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
RenderKits.If this render kit has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesContext.renderResponse() on the wrapped
FacesContext object.tr elements.rt element.tr element applying any values from the rowClasses attribute.tbody element.tbody element.table element.styleClass if available and renders any pass
through attributes that may be specified.ViewDeclarationLanguage.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) if
the view can be rendered.FacesContext.ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) on the wrapped
ViewHandler object.
Render a view rooted at argumentview.
RenderKitUtils.BOOLEAN_ATTRIBUTES using XHMTL semantics (i.e.,
disabled="disabled").RenderKitUtils.BOOLEAN_ATTRIBUTES using XHMTL semantics (i.e.,
disabled="disabled").replaceObject() as a hook to maintain our stack.
The presence of this annotation (along with @Inject) on a field of type Map<String,
Object> causes the map returned from ExternalContext.getRequestCookieMap() to
be injected as the value of that field.
The CookieMapProducer is the CDI producer that allows injection of the request cookie map using @Inject and allows the EL resolving of #{cookie}
The presence of this annotation (along with @Inject) on a field of type Map<String,
Object> causes the map returned from ExternalContext.getRequestMap() to be
injected as the value of that field.
The RequestMapProducer is the CDI producer that allows injection of the request map using @Inject.
The presence of this annotation (along with @Inject) on a field of type Map<String,
String> causes the map returned from ExternalContext.getRequestParameterMap()
to be injected as the value of that field.
The request parameter map producer is the CDI producer that allows injection of the request parameter map using @Inject.
The presence of this annotation (along with @Inject) on a field of type Map<String,
String []> causes the map returned from
ExternalContext.getRequestParameterValuesMap() to be injected as the value of that field.
The request parameter values map producer is the CDI producer that allows injection of the request parameter values map using @Inject.
The RequestProducer is the CDI producer that allows EL resolving of #{request}
jakarta.enterprise.context.RequestScoped, which is a CDI build-in scope
with similar semantics.FacesMessage to be created if a required check fails.A Validator that checks for an empty value in the same way that UIInput checks for a value.
If the request parameter named by the value of this constant has a parameter value of true, the
implementation must return true from PartialViewContext.isResetValues().
Convenience method to reset this component's value to the un-initialized state.
Convenience method to reset this component's value to the un-initialized state.
Visit the clientIds and, if the component is an instance of EditableValueHolder, call its
EditableValueHolder.resetValue() method.
Try to resolve one or multiple UIComponents based on the keyword and calls
SearchKeywordContext.invokeContextCallback(jakarta.faces.component.UIComponent) for each resolved component.
Resolves to a single clientId or passthrough expression for the given expression.
Resolves to a List with clientIds or passthrough expressions for the given expressions.
Resolves a single UIComponents for the given expression.
Resolves multiple UIComponents for the given expression(s).
Returns the URL of a Facelet template file.
null.
An instance of
Resource is a Java object representation of the artifact that is served up in response to a resource
request from the client.
This file must be located in META-INF/contracts/<contractName>/ in a jar file that contains a
resource library contract, where <contractName> is the name of the contract.
The default value for the ResourceHandler.RESOURCE_EXCLUDES_PARAM_NAME init param.
The ServletContext init parameter consulted by the ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext) to tell which kinds of
resources must never be served up in response to a resource request.
Resource.getRequestPath() returns the value of this constant as the prefix of the URI.
Container annotation to specify multiple ResourceDependency annotations on a single class.
Instances of UIComponent or Renderer that have this
annotation (or ResourceDependencies attached at the class level will automatically have a resource dependency
added so that the named resource will be present in user agent's view of the UIViewRoot in which this
component or renderer is used.
ResourceHandler is the
run-time API by which UIComponent and Renderer
instances, and the ViewDeclarationLanguage can reference
Resource instances. An implementation of this class must be thread-safe.
ResourceHandler.The ResourceHandlerProducer is the CDI producer that allows you to inject the ResourceHandler and to do EL resolving of #{resource}
Provides a simple
implementation of ResourceHandler that can be subclassed by developers wishing to provide specialized
behavior to an existing ResourceHandler instance.
If this resource handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Resource.ResourceInfo instances and cache any that are successfully looked up to reduce
the computational overhead with the scanning/version checking.ResourceManager.Defines the resource traversal options.
If this resource has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesContext.responseComplete() on the wrapped
FacesContext object.Flushes the buffered response content to the client.
ExternalContext.responseFlushBuffer() on
the wrapped ExternalContext object.Resets the current response.
ExternalContext.responseReset() on the wrapped
ExternalContext object.Sends an HTTP status code with message.
ExternalContext.responseSendError(int,String) on the wrapped
ExternalContext object.StateManager that knows the specific rendering technology being used to generate
the response.ResonseStateManager implementation for the default HTML render kit.ResponseWriter that can be subclassed by developers wishing to provide specialized behavior to an existing
ResponseWriter instance.If this response writer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
UIComponent subclasses that need to restore the objects they saved using
UIComponentBase.saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object).StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
on the wrapped StateManager object.
Both MethodExpression instances described in the constructor must be restored.
Both MethodExpression instances described in the constructor must be restored.
Restore the "transient state" using the object passed as state.
For components that need to support the concept of transient state, this method will restore any state saved on a
prior call to UIComponent.saveTransientState(jakarta.faces.context.FacesContext).
null.StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String) on the wrapped
StateManager object.UIDebug.debugRequest(jakarta.faces.context.FacesContext)} is true, simply return a new
UIViewRoot(), otherwise, call the default logic.StateManager.restoreView(jakarta.faces.context.FacesContext, String, String) on the wrapped
StateManager object.FacesContext and viewId.ViewHandler.restoreView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler
object.Restore the state of the view with information in the request.
Restore a UIViewRoot from a previously created view.
Restore ViewScope state.
DataModel that wraps a JSTL
Result object, typically representing the results of executing an SQL query via JSTL tags.ResultDataModel with no specified wrapped data.ResultDataModel wrapping the specified Result.DataModel that wraps a
ResultSet of Java objects.ResultSetDataModel with no specified wrapped data.ResultSetDataModel wrapping the specified ResultSet.
Assuming the component metadata for argument
topLevelComponent has been made available by an earlier call to
ViewDeclarationLanguage.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 individual AttachedObjectTarget instances
inside the composite component.
Assuming the component metadata for argument topLevelComponent has been made available by an earlier
call to ViewDeclarationLanguage.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.
Create a return node in the current Flow.
Define a return node.
Represents a return node in the flow graph.
This method is called by UIComponent subclasses that want to save one or more attached objects.
StateManager.saveView(jakarta.faces.context.FacesContext). The default implementation calls saveView and
inspects the return. If the return is an Object [], it casts the result to an Object []
wrapping the first and second elements in an instance of StateManager.SerializedView, which it then returns. Otherwise, it
returns nullStateManager.saveSerializedView(jakarta.faces.context.FacesContext) on the wrapped StateManager
object.
Implementation of StateHolder.saveState(jakarta.faces.context.FacesContext).
Serializable Object.
Both MethodExpression instances described in the constructor must be saved.
Both MethodExpression instances described in the constructor must be saved.
Return the object containing related "transient states".
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.
StateManager.saveView(jakarta.faces.context.FacesContext) on
the wrapped StateManager object.
Return the state of the current view in an Object that
implements Serializable and can be passed to
java.io.ObjectOutputStream.writeObject() without causing a java.io.NotSerializableException
to be thrown. The default implementation must perform the following algorithm or its semantic equivalent,
explicitly performing all the steps listed here.
DataModel that wraps an individual Java
object.ScalarDataModel with no specified wrapped data.ScalarDataModel wrapping the specified scalar object.
A structure that contains the name of the scope and the scope itself exposed as a Map<String,
Object>.
Construct this structure with the supplied arguments.
Renderer handles the rendering of script references.ComponentResourceDelegate for script references.ComponentHandler for h:outputScript references.
The property name for the SearchExpressionContext class name.
A context object that is used to hold state relating to resolve a search expression.
Provide for separation of interface and implementation for the SearchExpressionContext contract.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of SearchExpressionHandler that can be subclassed by developers wishing to
provide specialized behavior to an existing SearchExpressionHandler instance.
If this search expression handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
An enum that specifies hints that impact the behavior of a component tree search.
SearchKeywordContext provides context information that may be useful to
SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String) implementations.
Construct a new context with the given arguments.
A SearchKeywordResolver is responsible for resolving a single keyword.
UIInput component as a password field.UISelectMany or UISelectOne component.SelectItem with no initialized property values.SelectItem with the specified value.SelectItem with the specified value and label.SelectItem instance with the specified value, label and description.SelectItem instance with the specified property values.SelectItem instance with the specified property values.SelectItem instance with the specified property values.SelectItem that identifies a set of options that will be
made available as a subordinate "submenu" or "options list", depending upon the requirements of the
UISelectMany or UISelectOne renderer that is actually used.SelectItemGroup with no initialized property values.SelectItemGroup with the specified label and no associated selectItems.SelectItemGroup with the specified properties.SelectItems for a parent UISelectMany or
UISelectOne.selectitems custom tag.selectitem custom tag.UISelectMany component
as a list of checkboxes.@Push.@Push, targeted to the
given user as identified by <f:websocket user>.@Push, targeted to the
given users as identified by <f:websocket user>.HttpServletResponse.SC_NOT_FOUND (404) to the client.The context-param that allows the separator char for clientId strings to be set on a per-web application basis.
SerializationProvider instances.If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the jakarta.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
StateHelper provides the functionality associated with server-side state saving, though in
actuallity, it is a hybrid between client and server.ServerSideStateHelper instance.Process an incoming request, and create the corresponding response according to the following specification.
The presence of this annotation (along with @Inject) on a field of type Map<String,
Object> causes the map returned from ExternalContext.getSessionMap() to be
injected as the value of that field.
The SessionProducer is the CDI producer that allows injection of the session map using @Inject.
The SessionProducer is the CDI producer that allows EL resolving of #{session}
jakarta.enterprise.context.SessionScoped, which is a CDI build-in scope
with similar semantics.accept property.acceptcharset property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.accesskey property.ActionSource2.setActionExpression(jakarta.el.MethodExpression).UICommand.setActionExpression(jakarta.el.MethodExpression).MethodExpression pointing at the appication action to be invoked, if this UIComponent is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate property.MethodExpression pointing at the appication action to be invoked, if this UIComponent is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate property.ActionListener to be registered for all ActionSource
components.
The default behavior of this method is to call
Application.setActionListener(jakarta.faces.event.ActionListener) on the wrapped Application object.
ActionSource.addActionListener(jakarta.faces.event.ActionListener).UICommand.addActionListener(jakarta.faces.event.ActionListener).alt property.alt property.alt property.alt property.alt property.alt property.Application instance that will be returned for this web application.Application instance that will be returned for this web application.textValue to an object of type ConverterPropertyEditorBase.getTargetClass() by delegating to a converter in the
faces Application.Support method which is backed by the current VariableMapper.
autocomplete property.autocomplete property.autocomplete property.autorun property.ResourceBundle to be loaded.bgcolor property.bgcolor property.ValueExpression that references a backing bean
property of the Converter instance to be created.ValueExpression that references a backing bean
property of the Validator instance to be created.ValueExpression that references a backing bean property of
the Converter instance to be created.ValueExpression that references a backing bean property of
the Validator instance to be created.bodyContent for this tag handler.bodyrows property.bodyrows property.border property.border property.border property.border property.
This must be called by the runtime at startup time, before any requests are serviced, and allows for the
FaceletCache implementation to provide the FaceletCache.MemberFactory instances that will be used to create
instances of Facelets and View Metadata Facelets.
captionClass property.captionClass property.captionStyle property.captionStyle property.cellpadding property.cellpadding property.cellspacing property.cellspacing property.charset property.charset property.charset property.
Associate this instance with a ClientWindow.
The default behavior of this method is to call ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow) on the wrapped
ExternalContext object.
cols property.columnClasses property.columnClasses property.columns property.Set the MIME content-type for this resource.
The default behavior of this method is to call Resource.setContentType(String) on the wrapped
ResourceHandler object.
Converter (if any) that is registered for this UIComponent.Converter instance to be created.Converter instance to be created.ValueExpression set for the "converterMessage" with the literal argument provided to this
method.coords property.coords property.coords property.getAsString() with a type of currency.getAsString() with a type of currency.Verifier for this thread (typically the same thread that is used to bootstrap the application).FacesContext instance for the request that is being processed by the current thread.The implementation must call this method at the earliest possble point in time after entering into a new phase in the request processing lifecycle.
FacesContext.setCurrentPhaseId(PhaseId) on the wrapped
FacesContext object.Locale for this application.
The default behavior of this method is to call Application.setDefaultLocale(java.util.Locale) on the wrapped
Application object.
renderKitId to be used to render this application.
The default behavior of this method is to call Application.setDefaultRenderKitId(String) on the wrapped
Application object.
If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded.
dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.dir property.disable property of the UIParameter.Set whether or not the client window should be encoded into the target url.
Sets the disabled status of this behavior.
disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.disabled property.true.disabledClass property.disabledClass property.disabledClass property.disabledClass property.disabledClass property.disabledClass property.enabledClass property.enabledClass property.enabledClass property.enabledClass property.enabledClass property.enabledClass property.enctype property.errorClass property.errorClass property.errorStyle property.errorStyle property.escape property.escape property.escape property.Set the value of the escape property.
Set the ExceptionHandler for this request.
FacesContext.setExceptionHandler(ExceptionHandler) on the
wrapped FacesContext object.
Sets the component identifiers that will be used to identify components that should be processed during the
execute phase of the request processing lifecycle.
execute property.factoryName/implName mapping in such a way that FactoryFinder.getFactory(java.lang.String)
will find this mapping when searching for a match.fatalClass property.fatalClass property.fatalStyle property.fatalStyle property.
Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces
flows feature.
footerClass property.footerClass property.footerClass property.for property.fragment property.frame property.frame property.Set the FunctionMapper to use in EL evaluation/creation.
group property.Sets the name of the radio button group.
getAsString() should include grouping separators if necessary.headerClass property.headerClass property.headerClass property.height property.hreflang property.hreflang property.hreflang property.UIComponent (if any).image property.image property.UIComponent.Sets the immediate status of this behavior.
UIComponent.Set whether or not the page parameters should be encoded into the target url.
infoClass property.infoClass property.infoStyle property.infoStyle property.true if only the integer portion of the given value should be returned from
getAsObject().Updates the status as to whether or not this component is currently within the view hierarchy.
Overridden to take no action.
ismap property.JspIdConsumer.
Setter for keepMessages JavaBeans property.
The default behavior of this method is to call Flash.setKeepMessages(boolean) on the wrapped Flash
object.
Sets if the keyword was resolved.
label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.label property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.lang property.layout property.layout property.layout property.layout property.ConfigureListener and will contain any PropertyResolvers defined
within faces-config configuration files.ConfigureListener and will contain any VariableResolvers defined
within faces-config configuration files.Set the libraryName for this resource.
The default behavior of this method is to call Resource.setLibraryName(String) on the wrapped
ResourceHandler object.
Locale to be used in localizing the response being created for this view.Locale to be used when parsing or formatting dates and times.Locale to be used when parsing numbers.longdesc property.getAsString() should render in the fraction portion of the result.Validator.Validator.Validator.getAsString() should render in the integer portion of the result.maxlength property.maxlength property.maxlength property.ResourceBundle to be used for Jakarta Server Faces messages
for this application.
The default behavior of this method is to call Application.setMessageBundle(String) on the wrapped
Application object.
getAsString() should render in the fraction portion of the result.Validator.Validator.Validator.getAsString() should render in the integer portion of the result.name property.Set the request parameter name from which the value is retrieved.
NavigationHandler instance that will be passed the outcome returned by any invoked application action
for this web application.
The default behavior of this method is to call Application.setNavigationHandler(NavigationHandler) on the
wrapped Application object.
Set the value of the noSelectionOption property.
Set the value of the noSelectionOption property.
onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onblur property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onchange property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.onclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.ondblclick property.Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.
onerror property.Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.
onevent property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onfocus property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeydown property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeypress property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onkeyup property.onload property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousedown property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmousemove property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseout property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseover property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.onmouseup property.Controls whether or not this component operates on postback.
onreset property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onselect property.onsubmit property.onunload property.
Sets the outcome property of the UIOutcomeTarget.
PageContext of the page containing this tag instance.
Set the parent UIComponent of this
UIComponent.
Tag that is the parent of this instance.Dynamically indicate that this is a partial request.
The default behavior of this method is to call PartialViewContext.setPartialRequest(boolean) on the wrapped
PartialViewContext object.
Attempt to set the lifecycle phase in which this instance will queue its ActionEvent.
PhaseId during which this event will be delivered.
Allows control of wheter or not the runtime will publish events when
Application.publishEvent(FacesContext, Class, Object) or
Application.publishEvent(FacesContext, Class, Class, Object) is called.
FacesContext.setProcessingEvents(boolean) on the wrapped
FacesContext object.ActionListener instance and registers it on the
ActionSource associated with our most immediate surrounding instance of a tag whose implementation class is a
subclass of UIComponentClassicTagBase.<el-resolver> element at the right place in the application configuration resources which will be
considered in the normal course of expression evaluation. This method now will cause the argument
resolver to be wrapped inside an implementation of ELResolver and exposed to the Jakarta
Expression Language resolution system as if the user had called Application.addELResolver(jakarta.el.ELResolver).public property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.readonly property.
Setting this property to true indicates that the next request on this session will be a redirect.
The default behavior of this method is to call Flash.setRedirect(boolean) on the wrapped Flash
object.
redisplay property.detail property of the associated message(s) should be displayed.detail property of the associated message(s) should be displayed.rel property.rel property.rel property.
Sets the component identifiers that will be used to identify components that should be processed during the
render phase of the request processing lifecycle.
render property.
Indicate the entire view must be rendered if renderAll is true.
PartialViewContext.setRenderAll(boolean) on the wrapped
PartialViewContext object.rendered property of this UIComponent.
Sets the if property of this component.
RenderKit associated with this view.ExternalContext.getRequest().ExternalContext.setRequest(Object) on the wrapped
ExternalContext object.ExternalContext.setRequestCharacterEncoding(String) on the
wrapped ExternalContext object.ValueExpression set for the "requiredMessage" with the literal argument provided to this method.Set the resetValues status of this behavior.
resetValues property.
Set the ResourceHandler instance that will be utilized for rendering the markup for resources, and for
satisfying client requests to serve up resources.
The default behavior of this method is to call
Application.setResourceHandler(ResourceHandler) on the wrapped Application object.
Set the resource library contracts calculated as valid to use with this view.
FacesContext.setResourceLibraryContracts(java.util.List<java.lang.String>) on the wrapped
FacesContext object.Set the resourceName for this resource.
The default behavior of this method is to call Resource.setResourceName(String) on the wrapped
ResourceHandler object.
ExternalContext.getResponse().ExternalContext.setResponse(Object) on the wrapped
ExternalContext object.Set the buffer size for the current response.
ExternalContext.setResponseBufferSize(int) on the wrapped
ExternalContext object.ExternalContext.getResponseCharacterEncoding() on the wrapped
ExternalContext object.Set the content length of the response.
ExternalContext.setResponseContentLength(int) on the wrapped ExternalContext
object.Sets the content type of the response being sent to the client, if the response has not been committed yet.
ExternalContext.setResponseContentType(String) on the wrapped
ExternalContext object.Set the response header with the given name and value.
ExternalContext.setResponseHeader(String,String) on the
wrapped ExternalContext object.Sets the HTTP status code for the response.
ExternalContext.setResponseStatus(int) on the wrapped
ExternalContext object.ResponseStream to which components should direct their binary output.FacesContext.setResponseStream(ResponseStream) on the wrapped
FacesContext object.ResponseWriter to which components should direct their character-based output.FacesContext.setResponseWriter(ResponseWriter) on the wrapped
FacesContext object.rev property.rev property.rev property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.role property.rootElement property.rowClass property.rowClass property.rowClasses property.rowClasses property.rowHeader property.rows property.
If this property is set to true, the UIData must take steps to ensure that modifications to
its iterated children will be preserved on a per-row basis.
rules property.rules property.
Set the SearchExpressionHandler instance used by the application.
selectedClass property.null to indicate that there are no currently selected values.SelectItems for this group.Specifies the time, in seconds, between client requests before the Jakarta Servlet container will invalidate this session.
The default behavior of this method is to call ExternalContext.setSessionMaxInactiveInterval(int) on the
wrapped ExternalContext object.
shape property.shape property.shape property.detail property of the associated message(s) should be displayed.detail property of the associated message(s) should be displayed.summary property of the associated message(s) should be displayed.summary property of the associated message(s) should be displayed.size property.size property.size property.size property.size property.StateManager instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call
Application.setStateManager(StateManager) on the wrapped Application object.
style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.style property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.styleClass property.UIForm instance (as opposed to other
forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called,
with true as the argument, during the UIComponent.decode(jakarta.faces.context.FacesContext) for this UIForm instance.UIInput component.summary property.summary property.Locale instances representing the supported Locales for this application.
The default behavior of this method is to call Application.setSupportedLocales(java.util.Collection) on the
wrapped Application object.
system property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.tabindex property.Set a reference to the Tag for which this class represents the attributes.
Set a reference to the Tag for which this class represents the attributes.
target property.target property.target property.target property.TimeZone used to interpret a time value.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.title property.tooltip property.tooltip property.
Implementation of StateHolder.setTransient(boolean).
ActionListener instance to be created.PhaseListener instance to be created.ValueChangeListener instance to be created.type property.type property.type property.type property.unselectedClass property.ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) is now responsible for setting up the response
writer. This method is now a no-op.UIGraphic.usemap property.A comma-separated list of validation groups which are used to filter which validations get checked by this validator.
EditableValueHolder.addValidator(jakarta.faces.validator.Validator) instead, obtaining the argument Validator by creating an instance of
MethodExpressionValidator.UIInput.addValidator(jakarta.faces.validator.Validator) instead, obtaining the argument Validator by creating an instance of
MethodExpressionValidator.Validator instance to be created.Validator instance to be created.ValueExpression set for the "validatorMessage" with the literal argument provided to this
method.PropertyNotWritableException if called with a null base
and a property value equal to the literal string "flash".value property of the UICommand.UIData.value property of the UIGraphic.value property of the\ UIParameter.value property of the UISelectItem.value property of the UISelectItems.UIComponent (if any).ValueBinding, relative to the specified
FacesContext.UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression).UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression).UIData.setValueExpression(java.lang.String, jakarta.el.ValueExpression).UIGraphic.setValueExpression(java.lang.String, jakarta.el.ValueExpression).UISelectBoolean.setValueExpression(java.lang.String, jakarta.el.ValueExpression).UISelectMany.setValueExpression(java.lang.String, jakarta.el.ValueExpression).EditableValueHolder.addValueChangeListener(jakarta.faces.event.ValueChangeListener) instead, obtaining the argument ValueChangeListener by
creating an instance of MethodExpressionValueChangeListener.UIInput.addValueChangeListener(jakarta.faces.event.ValueChangeListener) instead, obtaining the argument ValueChangeListener by
creating an instance of MethodExpressionValueChangeListener.
Sets the ValueExpression used to calculate the value for the specified property name.
ValueExpression used to calculate the value for the specified attribute or property name, if any.ValueExpression used to calculate the value for the specified attribute or property name, if any.ValueExpression specified for url under value instead; otherwise, perform
the default superclass processing for this method.ValueExpression used to calculate the value for the specified attribute or property name, if any.ValueExpression specified for selected under value instead; otherwise,
perform the default superclass processing for this method.ValueExpression specified for selectedValues under value instead;
otherwise, perform the default superclass processing for this method.ValueExpression used to calculate the value for the specified attribute or property name, if any.ResourceBundle
Map.Set the VariableMapper to use in EL evaluation/creation.
<el-resolver> element at the
right place in the application configuration resources which will be considered in the normal course of expression
evaluation. This method now will cause the argument resolver to be wrapped inside an implementation of
ELResolver and exposed to the Jakarta Expression Language resolution system as if the user had called
Application.addELResolver(jakarta.el.ELResolver).ViewHandler instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call
Application.setViewHandler(ViewHandler) on the wrapped Application object.
ViewHandlingStrategy implementations to be applied when processing
JSF requests.UIViewRoot as populated.FacesContext.setViewRoot(UIViewRoot) on the wrapped
FacesContext object.warnClass property.warnClass property.warnStyle property.warnStyle property.width property.width property.width property.DataModel.DataModel.xmlns property.xmlns property.FacesMessage to be created if the conversion to
Short fails.Converter implementation for java.lang.Short (and short primitive) values.
The default behavior of this method is to call Map.size() on the wrapped Flash object.
Documents per the order specified in the List represented by absoluteOrder.Documents per the requirements of the 2.0 specification.faces-config documents found on the classpath and those specified by the
jakarta.faces.CONFIG_FILES context init parameter.String.split() which caches the Patterns in an LRUMap
instead of creating a new Pattern on each invocation.
Splits an string, based on SearchExpressionHandler.getExpressionSeperatorChars(jakarta.faces.context.FacesContext) with possible
multiple expressions into an array.
Open an XML CDATA block.
The default behavior of this method is to call ResponseWriter.startCDATA() on the wrapped
ResponseWriter object.
Write the start of a partial response.
ResponseWriter.startDocument() on the wrapped
ResponseWriter object.ResponseWriter.startElement(String, jakarta.faces.component.UIComponent) on the wrapped
ResponseWriter object.Write the start of an error.
Write the start of an eval operation.
Write the start of an extension operation.
Write the start of an insert operation where the contents will be inserted after the specified target node.
Write the start of an insert operation where the contents will be inserted before the specified target node.
true if the given string starts with one of the given prefixes.SystemEventListener on the UIViewRoot to track components added to or removed
from the view.Write the start of an update operation.
STATE_SAVING_METHOD_PARAM_NAME that
indicates state saving should take place on the client.ServletContext init parameter consulted by the StateManager to tell where the state
should be saved.STATE_SAVING_METHOD_PARAM_NAME that
indicates state saving should take place on the server.StateHelper implementations when writing the start of the state
field.StateHelper implementations.StateHelper instance.
Define a Map-like contract that makes it easier for components to implement PartialStateHolder.
AtomicInteger used to generate unique state map keys.Encapsulate the saving and restoring of the view to enable the VDL to take over the responsibility for handling this feature.
Serializable in the 1.0 version of the spec. It was also not a
static inner class, so it can't be made to be Serializable. Therefore, it is being deprecated in version
1.2 of the spec. The replacement is to use an implementation dependent Object.StateManager implementation to meet the requirements of the specification.StateManager that can be
subclassed by developers wishing to provide specialized behavior to an existing StateManager instance.If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesMessage to be created if the conversion of the
BigDecimal value to String fails.FacesMessage to be created if the conversion of the
BigInteger value to String fails.FacesMessage to be created if the conversion of the
Boolean value to String fails.FacesMessage to be created if the conversion of the
Byte value to String fails.FacesMessage to be created if the conversion of the
Character value to String fails.FacesMessage to be created if the conversion of the
DateTime value to String fails.FacesMessage to be created if the conversion of the
Double value to String fails.FacesMessage to be created if the conversion of the
Float value to String fails.FacesMessage to be created if the conversion of the
Integer value to String fails.FacesMessage to be created if the conversion of the
Long value to String fails.FacesMessage to be created if the conversion of the
Number value to String fails.FacesMessage to be created if the conversion of the
Short value to String fails.Renderer handles the rendering of stylesheet references.ComponentResourceDelegate for stylesheet references.ComponentHandler for h:outputStylesheet references.
Install the listener instance referenced by argument listener
into the application as a listener for events of type systemEventClass that originate from objects of
type sourceClass.
Install the listener instance referenced by argument listener
into application as a listener for events of type systemEventClass.
The default behavior of this method is to call
Application.subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) on the wrapped
Application object.
The default behavior of this method is to call
Application.subscribeToEvent(Class, jakarta.faces.event.SystemEventListener) on the wrapped
Application object.
This implementation throws UnsupportedOperationException and is provided for the sole purpose of not
breaking existing applications that extend this class.
Install the listener instance referenced by argument componentListener as a listener for events of type
eventClass originating from this specific instance of UIComponent.
Install the listener instance referenced by argument listener into the UIViewRoot as a
listener for events of type systemEventClass.
Create a switch node in the current Flow.
Create a switch case in the current switch.
Create a new case in the current switch.
Represents a case within a switch node in the flow graph.
Create a case in the current switch.
Define a particular list of cases that will be inspected in the order they are defined to determine where to go next in the flow graph.
Represents a switch node in the flow graph.
Pass the argument source to the superclass constructor.
Pass the argument source to the superclass constructor.
By implementing this class, an object indicates that it is a listener for one or more kinds of SystemEvents.
Classes that implement this interface agree to maintain a list of SystemEventListener instances for each kind
of SystemEvent they can generate.
UIData component as a two-dimensional table.The runtime must create an instance of this class for each element in the Facelets XHTML view.
A reference to the Tag instance corresponding to this TagHandler instance.
The property name for the TagHandlerDelegate class name.
Representation of an XML attribute name=value pair on an XML element in a Facelet file.
An Exception caused by a TagAttribute
A set of TagAttributes, usually representing all attributes on a Tag.
Passed to the constructor of TagHandler subclass, it defines the document definition of the handler we are
instantiating.
TagHandler.
An Exception caused by a Tag
Wrap the argument tag so the exception can reference its information.
Wrap the argument tag so the exception can reference its information.
Wrap the argument tag so the exception can reference its information.
Wrap the argument tag so the exception can reference its information.
Foundation class for FaceletHandlers associated with a
markup element in a Facelet document.
Every TagHandler instance is associated with a Tag.
Abstract class that defines methods relating to helping tag handler instances.
Abstract factory for creating instances of
TagHandlerDelegate.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
TagHandlerDelegateFactory.
See TagConfig.getTagId().
UIInput component as a Textarea.An interface that allows other code to identify FaceletHandlers that may provide text (String) content.
UIInput or UIOutput
component as a input field or static text.FacesMessage to be created if the conversion to
Time fails.
The presence of this component attribute on an ActionSource component will cause the
default ActionListener to interpret the value of the attribute as the toFlowDocumentId value to pass
to
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String).
Components that are rendered by Renderers of component-family jakarta.faces.OutcomeTarget
must use this constant as the parameter name for a parameter representing the defining document id of the flow that
this component will cause to be entered.
Set the to-flow-document-id of the current navigation case.
FacesMessage.Severity instance.
Call through to Resource.getRequestPath() and return the result.
PhaseId instance.Set the to-view-id of the current navigation case.
Define a Map-like contract that makes it easier for components to implement
TransientStateHolder.
This interface is implemented by classes that need to save state that is expected to be available only within the scope of the current request.
Perform a transition in the flow graph for the current user's ClientWindow.
FacesMessage to be created if the current value of
this component is not of the correct type.FacesMessage to be created if the current value of
this component is not of the correct type.UIComponent that represents a single column of data within a parent
UIData component.UIColumn instance with default property values.UIComponent that represents a user interface component which, when activated
by the user, triggers an application specific "command" or "action".UICommand instance with default property values.UIComponent.BodyTag. This class has been replaced by
UIComponentELTag.UIComponentTagBase is the base class for all Jakarta Server Pages tags that use the
"classic" Jakarta Server Pages tag interface that correspond to a UIComponent
instance in the view.UIComponentELTag specializes its superclass to allow for properties that take their values from Jakarta
Expression Language expressions.UIComponentELTag, which extends
UIComponentClassicTagBase to add properties that use the Jakarta Expression Language API introduced as
part of Jakarta Server Pages 2.1.UIComponentTagBase is the base class for all Jakarta Server Pages tags that correspond
to a UIComponent instance in the view.UIComponent that supports data binding to a collection of data objects represented by a DataModel
instance, which is the current value of this component itself (typically established via a ValueExpression).UIData instance with default property values.UIComponent that represents an input form to be
presented to the user, and whose child components represent (among other things) the input fields to be included when
the form is submitted.UIForm instance with default property values.UIComponent that displays a graphical image to the user.UIGraphic instance with default property values.UIImportConstants instance with renderer type set to null.UIComponent that represents a component that both
displays output to the user (like UIOutput components do) and processes request parameters on the subsequent
request that need to be decoded.UIInput instance with default property values.UIComponent, identified by a clientId or component id
relative to the closest ancestor NamingContainer.UIMessage instance with default property values.FacesContext and
displaying them to the user.UIMessages instance with default property values.NamingContainer functionality.UINamingContainer instance with default property values.
This component is paired with the jakarta.faces.Button or
jakarta.faces.Link renderers and encapsulates properties relating to the rendering of outcomes directly
to the response.
UIOutcomeTarget instance with default property values.UIComponent that has a
value, optionally retrieved from a model tier bean via a value expression, that is displayed to the user.UIOutput instance with default property values.UIComponent that manages the layout of its child components.UIPanel instance with default property values.UIComponent that represents an optionally named configuration parameter for
a parent component.UIParameter instance with default property values.UISelectBoolean instance with default property values.UISelectMany or UISelectOne component, and causes the addition of a
SelectItem instance to the list of available options for the parent component.UISelectItem instance with default property values.UISelectMany or UISelectOne
component, and causes the addition of one or more SelectItem instances to the list of available options in
the parent component.UISelectItems instance with default property values.UIComponent that
represents the user's choice of a zero or more items from among a discrete set of available options.UISelectMany instance with default property values.UIComponent that represents the user's choice
of zero or one items from among a discrete set of available options.UISelectOne instance with default property values.UIViewAction represents a method invocation that occurs during the request processing lifecycle, usually in response to an initial request, as opposed to a postback.
UIViewAction instance with default property values.
UIViewParameter represents a binding between a
request parameter and a model property or UIViewRoot property.
UIViewParameter instance with default property values.
Inner class to encapsulate a UIViewParameter instance so that it may be safely referenced regardless of
whether or not the current view is the same as the view in which this UIViewParameter resides.
UIViewRoot instance with default property values.
The <f:websocket> tag opens an one-way (server to client) websocket based push connection in
client side which can be reached from server side via PushContext interface injected in any CDI/container
managed artifact via @Push annotation.
UIWebsocket instance with default property values.createUniqueId() method.
UniqueIdVendor is an interface implemented by UIComponents that also implement
NamingContainer so that they can provide unique ids based on their own clientId.
Remove the listener instance referenced by argument listener
from the application as a listener for events of type systemEventClass that originate from objects of
type sourceClass.
Remove the listener instance referenced by argument listener
from the application as a listener for events of type systemEventClass.
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, Class, jakarta.faces.event.SystemEventListener) on the wrapped
Application object.
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener) on the wrapped
Application object.
This implementation throws UnsupportedOperationException and is provided for the sole purpose of not
breaking existing applications that extend this class.
Remove the listener instance referenced by argument componentListener as a listener for events of type
eventClass originating from this specific instance of UIComponent.
Remove the listener instance referenced by argument listener from the UIViewRoot as a
listener for events of type systemEventClass.
@child(n), @next and @previous.FacesMessage to be created if a model update error
occurs, and the thrown exception has no message.Write an attribute update operation.
UIInput, if any, as appropriate.
Call through to superclass UIInput.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.
This exception indicates a failure to update the model and is created to wrap any exception that occurs during
UIInput.updateModel(jakarta.faces.context.FacesContext).
Store the argument facesMessage so it may be returned from UpdateModelException.getFacesMessage() and pass the
argument cause to the super constructor.
processUpdates on each component in the tree so that it may have a
chance to update its model value.
Return true if the user-agent requesting this resource needs
an update.
The default behavior of this method is to call Resource.userAgentNeedsUpdate(jakarta.faces.context.FacesContext) on the wrapped
ResourceHandler object.
Validator against the specified
UIComponent.UIInput.Verify that the value is valid according to the Bean Validation constraints.
The name of a context parameter that indicates how empty values should be handled with respect to validation.
ActionSource ,
ActionSource2 and EditableValueHolder components are placed inside a form.validate_doublerange tag.validate_length tagvalidate_longrange tag.assignableTo
If any of these tests fail, queue a message to be displayed at a later point in time.UIInput, ensure that any specified values are equal to one of the available options.UIInput, ensure that any specified value is equal to one of the available options.The delimiter that is used to separate the list of fully-qualified group names as strings.
Sets a flag which indicates that a conversion or validation error occurred while processing the inputs.
FacesContext.validationFailed() on the
wrapped FacesContext object.EditableValueHolder.The name of the Jakarta Servlet context attribute which holds the object used by Jakarta Server Faces to obtain Validator instances.
The standard validator id for this validator, as defined by the Jakarta Server Face specification.
Used in creating ValidatorHandler and all implementations.
ConfigAnnotationHandler for FacesValidator annotated classes.ConfigProcessor handles all elements defined under /faces-config/valiator.Validator instance on the EditableValueHolder associated with our most immediate surrounding
instance of a tag whose implementation class is a subclass of UIComponentTag.validate() method of a Validator to indicate that validation failed.Allow this one exception to contain multiple messages.
Allow this one exception to contain multiple messages, while passing on the root cause to the superclass
Handles setting a Validator instance on an
EditableValueHolder parent.
Construct this instance around the configuration information in argument config
Validator instance to be created.ValidatorELTag.ValidatorELTag. The remainder of the functionality, namely,
the binding facility and the implementation of the ValidatorTag.createValidator() method, is now an implementation detail.ValueExpression.
A ValueChangeEvent is a notification that the local value of the source component has been change as a result
of user interface activity.
Construct a new event object from the specified source component, old value, and new value.
Construct a new event object from the Faces context, specified source component, old value and new value.
ValueChangeEvents.ValueChangeListener instance and registers it on the UIComponent
associated with our most immediate surrounding instance of a tag whose implementation class is a subclass of
UIComponentClassicTagBase.UIComponent that wishes to support a local value, as well as access data in the model tier via a value
expression, and support conversion between String and the model tier data's native data type.
A VDL handler that exposes Converter to a page author.
A marker interface for VDL tags that represent <composite:valueHolder/> for use by the
composite component page author.
List of valid FacesMessage.Severity instances, in ascending
order of their ordinal value.
The default behavior of this method is to call Map.values() on the wrapped Flash object.
PhaseId instances, in ascending order of their ordinal value.Map of valid FacesMessage.Severity instances, keyed by name.Map.ELResolver when operating with a null
base argument.VariableResolver.UIOutput instance and allows the user to write raw markup.com.sun.faces.verifyObjects feature which provides basic validation of Components,
Converters, and Validators.
The property name for the ViewDeclarationLanguage class name.
The value of this constant is used as the key in the component attributes Map for the
Location in the view at which this component instance resides.
The key in the value set of the view metadata BeanDescriptor, the value of which is a
List<.UIViewParameter.Reference>
Reserved ID value to indicate serialized ViewState.
Create a view node in the current Flow.
The contract that a view declaration language must implement to interact with the Jakarta Server Faces runtime.
ViewDeclarationLanguageFactory is a factory object
that creates (if needed) and returns a new ViewDeclarationLanguage instance based on the VDL found in a
specific view.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ViewDeclarationLanguageFactory.
Provides a simple implementation of ViewDeclarationLanguage that
can be subclassed by developers wishing to provide specialized behavior to an existing
ViewDeclarationLanguage instance.
If this view declaration language has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Tests whether a physical resource corresponding to the specified viewId exists.
FacesException when attempting to restore the view
StateManager.restoreView(jakarta.faces.context.FacesContext, String, String) results in failure on postback.MultiViewHandlerViewHandler.createView(jakarta.faces.context.FacesContext, java.lang.String) to obtain the text that exists after
the <f:view> tag.
Provides a simple implementation of ViewHandler that can be
subclassed by developers wishing to provide specialized behavior to an existing ViewHandler instance.
If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ViewHandlingStrategy implementations.WebConfiguration.BooleanWebContextInitParameter.DisableFaceletJSFViewHandler isn't
enabled, the strategies available (in order) will be FaceletViewHandlingStrategy and
JspViewHandlingStrategy.ViewHandlingStrategy instances were found appropriate to a
particulare view ID.
The presence of this annotation (along with @Inject) on a field of type Map<String,
Object> causes the map returned from UIViewRoot.getViewMap() to be injected
as the value of that field.
Marker interface for SystemEvents that indicate the view map has been created
(PostConstructViewMapEvent, or destroyed (PreDestroyViewMapEvent).
The ViewMapProducer is the CDI producer that allows injection of the view map using @Inject and allows EL resolving of #{viewScope}
ViewMetadata is reponsible for extracting and providing view parameter metadata from VDL views.
Define a view node in a flow graph.
ViewNode is the class that represents a VDL view in a faces flow graph.
The ViewProducer is the CDI producer that allows you to inject the UIViewRoot and to do EL resolving of #{view}
Superclass of Resource that is only for use with views.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true,
exceptions thrown by PhaseListeners installed on the UIViewRoot are queued to the
ExceptionHandler instead of being logged and swallowed.
jakarta.faces.view.ViewScoped. The functionality of this corresponding
annotation is identical to this one, but it is implemented as a CDI custom scope.
When this annotation, along with jakarta.inject.Named is found on a class, the runtime must place the bean in a CDI scope such that it remains active
as long as NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) does not cause a navigation to a view
with a viewId that is different than the viewId of the current view.
Defines the view traversal options.
VisitContext.invokeVisitCallback() to visit the specified component.
The property name for the VisitContextFactory class name.
A simple callback interface that enables taking action on a specific UIComponent (either facet or child) during a component tree visit.
A context object that is used to hold state relating to performing a component tree visit.
Provide for separation of interface and implementation for the
VisitContext contract.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
VisitContextFactory.
Provides a simple implementation of VisitContext that can be
subclassed by developers wishing to provide specialized behavior to an existing VisitContext instance.
If this visit context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
An enum that specifies hints that impact the behavior of a component tree visit.
An enum that specifies the possible results of a call to VisitCallback.visit(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.UIComponent).
Perform a tree visit starting at this node in the tree.
Override the behavior in UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback) to handle
iteration correctly.
Document instance as a representation of
/WEB-INF/faces-config.xml.
If a <context-param> with the param name equal to the value of
ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to
the web app root, where resource library contracts are to be located.
If a <context-param> with the param name equal to the value of
ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to
the web app root, where resources are to be located.
ResourceHelper implementation for finding/serving resources found within
<contextroot>/resources directory of a web application.enum of all boolean context initalization parameters recognized by the implementation.enum of all possible values for the disableUnicodeEscaping configuration parameter.enum of all non-boolean context initalization parameters recognized by the implementation.enum of all environment entries (specified in the web.xml) recognized by the implemenetation.InjectionProvider will be used if the PostConstruct and PreDestroy
annotations are present, but no specific InjectionProvider has been configured.
This web socket channel manager holds all application and session scoped web socket channel identifiers registered by
<f:websocket>.
<f:websocket>.
This web socket server endpoint handles web socket requests coming from <f:websocket>.
This web socket event will be fired when a new <f:websocket> has been
@WebsocketEvent.Opened or @WebsocketEvent.Closed.
Indicates that a <f:websocket> has closed.
Indicates that a <f:websocket> has opened.
This Faces listener for UIViewRoot ensures that the necessary JavaScript code to open or close the
WebSocket is properly rendered depending on rendered and connected attributes.
This is a concrete implementation of PushContext interface which is to be injected by
@Push.
WebsocketPushContext.send(Object) during which the session and view scope is not
necessarily active anymore.
This producer prepares the WebsocketPushContext instance for injection by @Push.
jsf.push.init() script and decodes any client
behaviors triggered by UIWebsocket.This web socket session manager holds all web socket sessions by their channel identifier.
This web socket user manager holds all web socket users registered by <f:websocket>.
Writer.write(char[], int, int) on the wrapped
ResponseWriter object.ResponseWriter.writeAttribute(String, Object, String) on the
wrapped ResponseWriter object.ResponseWriter.writeComment(Object) on the wrapped
ResponseWriter object.Write a string containing the markup specific doctype.
ResponseWriter.writeDoctype(java.lang.String) on the wrapped
ResponseWriter object.Write a string containing the markup specific preamble.
ResponseWriter.writePreamble(java.lang.String) on the wrapped
ResponseWriter object.RenderKit is used, write out the ID of the RenderKit out as a hidden field.ViewHandlingStrategy instances.stateFacesContextStringBuilder without sending any markup to the client.Object instance, in an implementation dependent
manner.StateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object). The default implementation calls the
non-deprecated variant of the method passing an Object [] as the second argument, where the first
element of the array is the return from getStructure() and the second is the return from
getState() on the argument state.StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object) on the wrapped
StateManager object.StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
on the wrapped StateManager object.StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object), or noting where state information should later be written.ViewHandler.writeState(jakarta.faces.context.FacesContext) on
the wrapped ViewHandler object.state and write it into the output using the
current ResponseWriter, which must be correctly positioned already.ResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object). The default implementation creates a two
element Object array with the first element being the return from calling
StateManager.SerializedView.getStructure(), and the second being the return from StateManager.SerializedView.getState(). It then
passes this Object array to ResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object).startElement(), that element will be closed first.ResponseWriter.writeText(Object, String) on the wrapped
ResponseWriter object.ResponseWriter.writeText(Object, UIComponent, String) on the
wrapped ResponseWriter object.ResponseWriter.writeText(char[], int, int) on the wrapped
ResponseWriter object.ResponseWriter.writeURIAttribute(String, Object, String) on
the wrapped ResponseWriter object.Copyright © 1997–2020 Eclipse Foundation. All rights reserved.