All Classes and Interfaces
Class
Description
An exception that may be thrown by event listeners to terminate the processing of the current event.
An
ActionEvent represents the activation of a user interface component (such as a UICommand).
A listener interface for receiving
ActionEvents.
Provides a simple implementation of
ActionListener that can be subclassed by developers wishing to provide
specialized behavior to an existing ActionListener instance.
ActionSource is an interface that may be implemented by any concrete
UIComponent that wishes
to be a source of ActionEvents, including the ability to invoke application actions via the default
ActionListener mechanism.Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
ActionSourceAttachedObjectHandler instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
ActionSourceAttachedObjectTarget instead.
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.
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.
AjaxBehaviorEvent represents the component behavior
specific to
Ajax).
By implementing this class, an object indicates that it is a listener for one or more kinds of
BehaviorEvents.
Application represents a per-web-application singleton object where applications based
on Jakarta Faces (or implementations wishing to provide extended functionality) can register application-wide
singletons that provide functionality required by Jakarta Faces.
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.
ApplicationFactory is a factory object that
creates (if needed) and returns
Application instances.
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.
Supports inline instantiation of the
ApplicationMap qualifier.
Provides a simple implementation of
Application that can be
subclassed by developers wishing to provide specialized behavior to an existing Application instance.
ArrayDataModel is a convenience implementation of
DataModel that wraps an array of Java
objects.
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.
An interface that allows other code to identify FaceletHandlers that correspond to component attributes.
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.
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.
BehaviorEvent is the event that can be generated from
component
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.Converter implementation for java.math.BigInteger values.Converter implementation for java.lang.Boolean (and boolean primitive) values.Converter implementation for java.lang.Byte (and byte primitive) values.Converter implementation for java.lang.Character (and char primitive) values.
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.
A ClientBehaviorRenderer produces the client-side script that implements a
ClientBehavior's client-side logic.
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.ClientWindowScoped is a CDI scope that causes the runtime to consider classes
with this annotation to be in the scope of the current
ClientWindow.
Wrapper for
ClientWindow
CollectionDataModel is a convenience implementation of
DataModel that wraps an
Collection of Java objects.
Passed to the constructor of
ComponentHandler.
Public base class for markup element instances that map to
UIComponent instances in the view.
Typed
FacesException for the SearchExpressionHandler, if a component can't be resolved.
ComponentSystemEvent is the base class for
SystemEvents that are specific to a UIComponent instance.
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.This interface must be implemented by the
Map returned by the composite component
ELResolver, described in
section 5.4.3.1 "faces.CompositeComponentAttributesELResolver" of the Jakarta Faces Specification Document,
when evaluating #{cc.attrs} expressions.
A FaceletHandler that is derived of 1 or more, inner FaceletHandlers.
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.
A simple callback interace that enables taking action on a specific UIComponent (either facet or child) in the view
while preserving any contextual state for that component instance in the view.
Converter is an interface
describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects
and a String representation of those objects that is suitable for rendering.
A Facelet version of the Jakarta Server Pages
ConverterTag.
ConverterException is an exception thrown by the
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.
DataModel is an abstraction around arbitrary data binding
technologies that can be used to adapt a variety of data sources for use by Jakarta Faces components that
support per-row processing for their child components (such as
UIData.
DataModelEvent represents an event of interest to registered listeners that occurred on the
specified
DataModel.
DataModelListener represents an event listener that wishes to be notified of
DataModelEvents
occurring on a particular DataModel instance.Converter implementation for
java.util.Date values.
Enable the Jakarta 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.
Doctype is an interface that must be implemented by any
UIComponent that represents a document type declaration.Converter implementation for java.lang.Double (and double primitive) values.
DoubleRangeValidator is a
Validator
that checks the value of the corresponding component against specified minimum and maximum values.
EditableValueHolder is an extension of
ValueHolder that describes additional features supported by editable components, including
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.Converter implementation for
java.lang.Enum (and enum primitive) values.
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.
Provides a simple implementation of
ExceptionHandler that can be
subclassed by developers wishing to provide specialized behavior to an existing ExceptionHandler instance.
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.
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.
This class
allows the Faces API to be unaware of the nature of its containing application environment.
ExternalContextFactory is a factory object that
creates (if needed) and returns new
ExternalContext instances, initialized for the processing of the
specified request and response objects.
Provides a simple implementation of
ExternalContext that can be subclassed by developers wishing to provide specialized behavior to an existing
ExternalContext instance.
The parent or root object in a FaceletHandler composition.
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.
Context representative of a single request from a Facelet.
An Exception from the Facelet implementation
This is the root class for markup elements in Facelets VDL.
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
Behavior.
Supports inline instantiation of the
FacesBehavior qualifier.
The presence of this annotation on a class automatically registers the class with the runtime as a
ClientBehaviorRenderer.
The presence of this annotation on a class that extends
UIComponent
must cause the runtime to register this class as a component suitable for inclusion in a view.
The presence of this annotation on a class deployed within an application
guarantees activation of Jakarta Faces and its CDI specific features, even when
/WEB-INF/faces-config.xml is absent and FacesServlet is not explicitly registered.
Supports inline instantiation of the
FacesConfig qualifier.Deprecated, for removal: This API element is subject to removal in a future version.
It has no effect anymore as per Jakarta Faces version 4.0; the actual impl version should be leading.
FacesContext contains all of
the per-request state information related to the processing of a single Jakarta Faces request, and the
rendering of the corresponding response.
FacesContextFactory is a
factory object that creates (if needed) and returns new
FacesContext instances, initialized for the
processing of the specified request and response objects.
Provides a simple implementation
of
FacesContext that can be subclassed by developers wishing to provide specialized behavior to an existing
FacesContext instance.
The presence of this annotation on a class automatically registers the
class with the runtime as a
Converter.
Supports inline instantiation of the
FacesConverter qualifier.
Supports inline instantiation of the
FacesDataModel qualifier.
FacesEvent is the base class for user interface and application events that can be fired by
UIComponents.
This class encapsulates general Jakarta Faces exceptions.
A generic base interface for event listeners for various types of
FacesEvents.
FacesMessage represents a single validation (or other) message, which is typically associated with a
particular component in the view.
Class used to represent message severity levels in a typesafe enumeration.
The presence of this annotation on a class automatically registers the class with the runtime as a
Renderer.
FacesServlet is a Jakarta Servlet servlet that manages the request processing
lifecycle for web applications that are utilizing Jakarta Faces to construct the user interface.
The presence of this annotation on a class automatically registers the
class with the runtime as a
Validator.
Supports inline instantiation of the
FacesValidator qualifier.
Any wrapper class in Jakarta 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.
FactoryFinder implements the standard discovery algorithm for all factory objects
specified in the Jakarta Faces APIs.
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.
FlashFactory is a factory object that creates (if
needed) and returns
Flash instances.Converter implementation for java.lang.Float (and float primitive) values.
Flow is the runtime representation of a Faces Flow.
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.
Supports inline instantiation of the
FlowBuilderParameter qualifier.
Create a flow call node in the current
Flow.A flow call node.
The presence of this annotation on a CDI producer method indicates that the method will produce a flow.
Supports inline instantiation of the
FlowDefinition qualifier.
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.
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.
Supports inline instantiation of the
ApplicationMap qualifier.
FlowNode is the base class for all nodes in a faces flow graph.
FlowScoped is a CDI scope that causes the runtime to consider classes
with this annotation to be in the scope of the specified
Flow.
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.
Supports inline instantiation of the
HeaderMap qualifier.
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.
Supports inline instantiation of the
HeaderValuesMap qualifier.NONE
The property keys.
Represents a column that will be rendered in an HTML
table element.The property keys.
Represents an HTML
input element for a button of type submit or reset.Properties used by this component
Represents an HTML
a element for a hyperlink that acts like a submit button.Properties used by this component
Represents an HTML
script element for a function that acts like an ajax form submit.The property keys.
Represents a set of repeating data (segregated into columns by child UIColumn components) that will be rendered in an
HTML
table element.The property keys.
NONE
The property keys.
Represents an HTML
form element.Properties used by this component
Represents an HTML
img element, used to retrieve and render a graphical image.Properties used by this component
NONE
The property keys.
Represents an HTML
input element of type file.Properties used by this component
Represents an HTML
input element of type hidden.Properties used by this component
Represents an HTML
input element of type password.Properties used by this component
Represents an HTML
input element of type text.The property keys.
Represents an HTML
textarea element.Properties used by this component
By default, the
rendererType property must be set to "jakarta.faces.Message".Properties used by this component
By default, the
rendererType property must be set to "jakarta.faces.Messages".The property keys.
Represents an HTML
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.The property keys.
Represents an HTML
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.The property keys.
Represents a component that looks up a localized message in a resource bundle, optionally uses it as a
MessageFormat pattern string and substitutes in parameter values from nested UIParameter
components, and renders the result.The property keys.
Represents an HTML
label element, used to define an accessible label for a corresponding input element.The property keys.
Represents an HTML
a (hyperlink) element that may be used to link to an arbitrary URL defined by the
value property.The property keys.
Renders the component value as text, optionally wrapping in a
span element if I18N attributes, CSS
styles or style classes are specified.The property keys.
Renders child components in a table, starting a new row after the specified number of columns.
Properties used by this component
Causes all child components of this component to be rendered.
Properties used by this component
Represents an HTML
input element of type
checkbox.The property keys.
Represents a multiple-selection component that is rendered as a set
of HTML
input elements of type checkbox.Properties used by this component
Represents a multiple-selection component that is rendered as an HTML
select element, showing either all
available options or the specified number of options.Properties used by this component
Represents a multiple-selection component that is rendered as an HTML
select element, showing a single
available option at a time.The property keys.
Represents a single-selection component that is rendered as an HTML
select element, showing either all
available options or the specified number of options.Properties used by this component
Represents a single-selection component that is rendered as an HTML
select element, showing a single
available option at a time.Properties used by this component
Represents a single-selection component that is rendered as a set of
HTML
input elements of type radio.The property keys.
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.
Supports inline instantiation of the
InitParameterMap qualifier.Converter implementation for java.lang.Integer (and int primitive) values.
IterableDataModel is an implementation of
DataModel that wraps an Iterable.
LengthValidator is a
Validator that checks the number of
characters in the String representation of the value of the associated component.
Lifecycle manages the processing of the entire lifecycle of a
particular Jakarta Faces request.
LifecycleFactory is a factory object that creates
(if needed) and returns
Lifecycle instances.
ListDataModel is a convenience implementation of
DataModel that wraps an List
of Java objects.
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.
An object that represents the Location of a tag or attribute of a tag in a View Declaration Language file.
Converter implementation for java.lang.Long (and long primitive) values.
LongRangeValidator is a
Validator that checks the value
of the corresponding component against specified minimum and maximum values.
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.
Supports inline instantiation of the
ManagedProperty qualifier.
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.
The root class of the abstraction that dictates how attributes on a markup element in a Facelets VDL page are wired
to the Jakarta 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 Faces
Java API artifact is associated with an instance of this class.
Create a method call node in the current
Flow.
Represents a method call node in the flow graph.
MethodExpressionValidator is a
Validator that wraps a
MethodExpression, and it performs validation by executing a method on an object identified by the
MethodExpression.
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.
NamingContainer is an interface that must be implemented by any
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.
Create a navigation case in the current
Flow.
Provides a simple implementation of
NavigationCase that can be
subclassed by developers wishing to provide specialized behavior to an existing NavigationCase instance.
A NavigationHandler is passed the
outcome string returned by an application action invoked for this application, and will use this (along with related
state information) to choose the view to be displayed next.
NavigationHandlerWrapper provides a simple implementation of
NavigationHandler that can be subclassed by developers wishing to provide specialized behavior to an existing
NavigationHandler instance.
Base interface for building all kinds of flow nodes.
Converter implementation for java.lang.Number
values.
Represents a parameter in any of several places where parameters are needed when processing flows.
PartialResponseWriter decorates an existing
ResponseWriter to support the generation of
a partial response suitable for Ajax operations.
Components that want to leverage the partial state saving feature must implement this interface instead of
implementing
StateHolder, from which this interface inherits.
PartialViewContext contains
methods and properties that pertain to partial request processing and partial response rendering on a view.
PartialViewContextFactory is a factory object that creates (if needed) and
returns new
PartialViewContext instances.
Provides a simple implementation of
PartialViewContext that can be subclassed by developers wishing to provide specialized behavior to an
existing PartialViewContext instance.
PhaseEvent represents the beginning or ending of processing for a particular phase of the request
processing lifecycle, for the request encapsulated by the specified
FacesContext.
Typesafe enumeration of the legal values that may be returned by the
getPhaseId() method of the FacesEvent interface.
An interface implemented by objects that wish to be notified at the beginning and ending of processing for each
standard phase of the request processing lifecycle.
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.
This event must be published by the runtime after all configuration resources have been parsed and processed.
Deprecated, for removal: This API element is subject to removal in a future version.
because
CustomScope has been removed from Faces in favor of CDI.
This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is
first created.
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.
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.
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.
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.
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.
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.
This event must be published by the runtime before the factories associated with this
Application
are released.Deprecated, for removal: This API element is subject to removal in a future version.
because
CustomScope has been removed from Faces in favor of CDI.
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().
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.
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.
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.
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.
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.
This class enables a feature similar to the
RAILS_ENV feature of the Ruby on Rails web framework.
This exception is thrown by the runtime when a violation of the view protection mechanism is encountered.
The CDI annotation
@Push allows you to inject a PushContext associated with a given
<f:websocket> channel in any container managed artifact in WAR.
Supports inline instantiation of the
Push qualifier.
CDI interface to send a message object to the push socket channel as identified by
@Push.
A Validator that checks against a Regular Expression (which is the
pattern property).
A Renderer converts the internal representation of
UIComponents into the output stream (or writer) associated with the response we are creating for a particular
request.
RenderKit represents a collection of
Renderer
instances that, together, know how to render Jakarta Faces UIComponent instances for a specific
client.
RenderKitFactory is a factory object that
registers and returns
RenderKit instances.
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.
Supports inline instantiation of the
RequestCookieMap qualifier.
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.
Supports inline instantiation of the
RequestMap qualifier.
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.
Supports inline instantiation of the
RequestParameterMap qualifier.
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.
Supports inline instantiation of the
RequestParameterValuesMap qualifier.
A Validator that checks for an empty value in the same way that UIInput checks for a value.
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.
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.
Provides a simple
implementation of
ResourceHandler that can be subclassed by developers wishing to provide specialized
behavior to an existing ResourceHandler instance.
Defines the resource traversal options.
ResponseStateManager is the helper class to
StateManager that knows the specific rendering technology being used to generate
the response.
ResponseStream is an interface describing an adapter to an underlying output mechanism for binary
output.
ResponseWriter is an abstract class describing an adapter
to an underlying output mechanism for character-based output.
Provides a simple implementation of
ResponseWriter that can be subclassed by developers wishing to provide specialized behavior to an existing
ResponseWriter instance.
ResultSetDataModel is a convenience implementation of
DataModel that wraps a
ResultSet of Java objects.
Create a return node in the current
Flow.
Represents a return node in the flow graph.
ScalarDataModel is a convenience implementation of
DataModel that wraps an individual Java
object.
A structure that contains the name of the scope and the scope itself exposed as a
Map<String,
Object>.
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.The SearchExpressionHandler is responsible for resolving search
expression(s)
Provides a simple implementation of
SearchExpressionHandler that can be subclassed by developers wishing to
provide specialized behavior to an existing SearchExpressionHandler instance.
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.
A SearchKeywordResolver is responsible for resolving a single keyword.
SelectItem represents a single item
in the list of supported items associated with a
UISelectMany or UISelectOne component.
SelectItemGroup is a subclass of
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.
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.
Supports inline instantiation of the
SessionMap qualifier.Converter implementation for java.lang.Short (and short primitive) values.
Define a
Map-like contract that makes it easier for components to implement PartialStateHolder.
This interface is implemented by classes that need to save their
state between requests.
Encapsulate the saving and restoring of the view to enable the VDL to take
over the responsibility for handling this feature.
StateManager directs the process of saving and restoring the view between requests.
Provides a simple implementation of
StateManager that can be
subclassed by developers wishing to provide specialized behavior to an existing StateManager instance.
Create a switch node in the current
Flow.
Represents a case within a switch node in the flow graph.
Create a case in the current switch.
Represents a switch node in the flow graph.
SystemEvent is the base class for non-application
specific events that can be fired by arbitrary objects.
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.
The runtime must create an instance of this class for each element in the Facelets XHTML view.
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.
Provides the ability to completely change the Tag
before it's processed for compiling with the associated
TagHandler.
An Exception caused by a
Tag
Foundation class for
FaceletHandlers associated with a
markup element in a Facelet document.
Abstract class that defines methods relating to helping tag handler
instances.
Abstract factory for creating instances of
TagHandlerDelegate.
An interface that allows other code to identify FaceletHandlers that may provide text (String) content.
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.
UIColumn is a
UIComponent that represents a single column of data within a parent
UIData component.
UICommand is a
UIComponent that represents a user interface component which, when activated
by the user, triggers an application specific "command" or "action".
UIComponent is the base class for all user interface components in Jakarta Server
Faces.
UIComponentBase is a
convenience base class that implements the default concrete behavior of all methods defined by
UIComponent.
UIData is a
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).
UIForm is a
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.
UIGraphic is a
UIComponent that displays a graphical image to the user.
UIInput is a
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.
This component is responsible for displaying messages for a specific
UIComponent, identified by a clientId or component id
relative to the closest ancestor NamingContainer.
The renderer for this component is responsible for obtaining the messages from the
FacesContext and
displaying them to the user.
UINamingContainer is a convenience base class for components that wish
to implement
NamingContainer functionality.
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.
UIOutput is a
UIComponent that has a
value, optionally retrieved from a model tier bean via a value expression, that is displayed to the user.
UIPanel is a
UIComponent that manages the layout of its child components.
UIParameter is a
UIComponent that represents an optionally named configuration parameter for
a parent component.
UISelectItem is a component that may be
nested inside a
UISelectMany or UISelectOne component, and causes the addition of a
SelectItem instance to the list of available options for the parent component.
UISelectItemGroup is a component that may be nested inside a
UISelectMany or UISelectOne component, and causes the addition
of one SelectItemGroup of one or more SelectItem instances to the list of available options in the parent component.
UISelectItemGroups is a component that may be nested inside a
UISelectMany or UISelectOne component, and causes the addition
of one or more SelectItemGroup of one or more SelectItem instances to the list of available options in the parent component.
UISelectItems is a component that may be nested inside a
UISelectMany or UISelectOne
component, and causes the addition of one or more SelectItem instances to the list of available options in
the parent component.
UISelectMany is a
UIComponent that
represents the user's choice of a zero or more items from among a discrete set of available options.
UISelectOne is a
UIComponent that represents the user's choice
of zero or one items from among a discrete set of available options.
UIViewAction represents a method invocation that occurs during the
request processing lifecycle, usually in response to an initial request, as opposed to a postback.
UIViewParameter represents a binding between a
request parameter and a model property or
UIViewRoot property.
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 is the UIComponent that represents the root of
the UIComponent tree.
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.
UniqueIdVendor is an interface implemented by
UIComponents that also implement
NamingContainer so that they can provide unique ids based on their own clientId.Components implementing this interface are ignored by the algorithm - especially in
the implementation of
@child(n), @next and @previous.
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).Converter implementation for java.util.UUID values.
A Validator implementation is a class that can perform validation
(correctness checks) on a
EditableValueHolder.
Used in creating
ValidatorHandler and all implementations.
A ValidatorException is an exception thrown by the
validate() method of a Validator to indicate that validation failed.
Handles setting a
Validator instance on an
EditableValueHolder parent.
A
ValueChangeEvent is a notification that the local value of the source component has been change as a result
of user interface activity.
A listener interface for receiving
ValueChangeEvents.
ValueHolder is an interface that may be implemented by any concrete
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.
The presence of this annotation on a target (type, method, parameter or field) within an application is used to indicate that
this target is somehow handling a Faces View Id or Ids.
Supports inline instantiation of the
View annotation.
Create a view node in the current
Flow.
The contract that a view
declaration language must implement to interact with the Jakarta 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.
Provides a simple implementation of
ViewDeclarationLanguage that
can be subclassed by developers wishing to provide specialized behavior to an existing
ViewDeclarationLanguage instance.
Implementations must throw this
FacesException when attempting to restore the view
StateManagementStrategy.restoreView(FacesContext, String, String) results in failure on postback.
ViewHandler is the pluggablity mechanism for allowing implementations of or applications using the
Jakarta Faces Specification to provide their own handling of the activities in the Render Response
and Restore View phases of the request processing lifecycle.
Provides a simple implementation of
ViewHandler that can be
subclassed by developers wishing to provide specialized behavior to an existing ViewHandler instance.
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.
Supports inline instantiation of the
ViewMap qualifier.
Marker interface for
SystemEvents that indicate the view map has been created
(PostConstructViewMapEvent, or destroyed (PreDestroyViewMapEvent).ViewMetadata is reponsible for extracting and providing view parameter metadata from VDL views.
ViewNode is the class that represents a VDL view in a faces flow graph.
Superclass of
Resource that is only for use with views.
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.
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.
Provides a simple implementation of
VisitContext that can be
subclassed by developers wishing to provide specialized behavior to an existing VisitContext instance.
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).
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.
Supports inline instantiation of the
WebsocketEvent.Closed qualifier.
Indicates that a
<f:websocket> has opened.
Supports inline instantiation of the
WebsocketEvent.Opened qualifier.
ActionSourceinstead.