| ID |
Return |
Method/Field |
Description |
Required |
Deprecated |
Testable |
| JSF:JAVADOC:1 |
FacesException |
jakarta.faces.FacesException.FacesException
|
Construct a new exception with no detail message or root cause. |
true |
|
true |
| JSF:JAVADOC:2 |
FacesException |
jakarta.faces.FacesException.FacesException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
|
true |
| JSF:JAVADOC:3 |
FacesException |
jakarta.faces.FacesException.FacesException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
|
true |
| JSF:JAVADOC:4 |
FacesException |
jakarta.faces.FacesException.FacesException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:5 |
Throwable |
jakarta.faces.FacesException.getCause
|
Return
the cause of this exception, or null if the cause is nonexistent or
unknown. |
true |
|
true |
| JSF:JAVADOC:6 |
Object |
jakarta.faces.FacesWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:7 |
Object |
jakarta.faces.FactoryFinder.getFactory
( String ) |
Create
(if necessary) and return a per-web-application instance of the
appropriate implementation class for the specified Jakarta Server Faces
factory class, based on the discovery algorithm described in the class
description. The standard factories and wrappers in JSF all implement
the interface FacesWrapper. If the returned Object is an
implementation of one of the standard factories, it must be legal to
cast it to an instance of FacesWrapper and call
FacesWrapper#getWrapped on the instance. |
true |
|
true |
| JSF:JAVADOC:8 |
Object |
jakarta.faces.FactoryFinder.getFactory
( String )
throws FacesException
|
if the
web application class loader cannot be identified |
true |
|
true |
| JSF:JAVADOC:9 |
Object |
jakarta.faces.FactoryFinder.getFactory
( String )
throws IllegalArgumentException
|
if
factoryName does not identify a standard Jakarta Server Faces factory name |
true |
|
true |
| JSF:JAVADOC:10 |
Object |
jakarta.faces.FactoryFinder.getFactory
( String )
throws IllegalStateException
|
if there
is no configured factory implementation class for the specified
factory name |
true |
|
true |
| JSF:JAVADOC:11 |
Object |
jakarta.faces.FactoryFinder.getFactory
( String )
throws NullPointerException
|
if
factoryname is null |
true |
|
true |
| JSF:JAVADOC:12 |
void |
jakarta.faces.FactoryFinder.releaseFactories
|
Release
any references to factory instances associated with the class loader
for the calling web application. This method must be called during of
web application shutdown. |
true |
|
true |
| JSF:JAVADOC:13 |
void |
jakarta.faces.FactoryFinder.releaseFactories
throws FacesException
|
if the
web application class loader cannot be identified |
true |
|
true |
| JSF:JAVADOC:14 |
void |
jakarta.faces.FactoryFinder.setFactory
( String ,
String ) |
This
method will store the argument factoryName/implName mapping in such a
way that #getFactory will find this mapping when searching for a
match. This method has no effect if getFactory() has already been
called looking for a factory for this factoryName. This method can be
used by implementations to store a factory mapping while parsing the
Faces configuration file |
true |
|
true |
| JSF:JAVADOC:15 |
void |
jakarta.faces.FactoryFinder.setFactory
( String ,
String )
throws IllegalArgumentException
|
if
factoryName does not identify a standard Jakarta Server Faces factory name |
true |
|
true |
| JSF:JAVADOC:16 |
void |
jakarta.faces.FactoryFinder.setFactory
( String ,
String )
throws NullPointerException
|
if
factoryname is null |
true |
|
true |
| JSF:JAVADOC:17 |
void |
jakarta.faces.application.Application.addBehavior
( String ,
String ) |
Register a new mapping of behavior id to the name of the corresponding
Behavior class. This allows subsequent calls to createBehavior() to
serve as a factory for Behavior instances. |
true |
|
true |
| JSF:JAVADOC:18 |
void |
jakarta.faces.application.Application.addBehavior
( String ,
String )
throws NullPointerException
|
if
behaviorId or behaviorClass is null |
true |
|
true |
| JSF:JAVADOC:19 |
void |
jakarta.faces.application.Application.addComponent
( String ,
String ) |
Register a new mapping of component type to the name of the
corresponding UIComponent class. This allows subsequent calls to
createComponent() to serve as a factory for UIComponent instances. |
true |
|
true |
| JSF:JAVADOC:20 |
void |
jakarta.faces.application.Application.addComponent
( String ,
String )
throws NullPointerException
|
if
componentType or componentClass is null |
true |
|
true |
| JSF:JAVADOC:21 |
void |
jakarta.faces.application.Application.addConverter
( String ,
String ) |
Register a new mapping of converter id to the name of the
corresponding Converter class. This allows subsequent calls to
createConverter() to serve as a factory for Converter instances. |
true |
|
true |
| JSF:JAVADOC:22 |
void |
jakarta.faces.application.Application.addConverter
( String ,
String )
throws NullPointerException
|
if
converterId or converterClass is null |
true |
|
true |
| JSF:JAVADOC:23 |
void |
jakarta.faces.application.Application.addConverter
( Class ,
String ) |
Register a new converter class that is capable of performing
conversions for the specified target class. |
true |
|
true |
| JSF:JAVADOC:24 |
void |
jakarta.faces.application.Application.addConverter
( Class ,
String )
throws NullPointerException
|
if
targetClass or converterClass is null |
true |
|
true |
| JSF:JAVADOC:25 |
void |
jakarta.faces.application.Application.addDefaultValidatorId
( String ) |
Register a validator by its id that is applied to all UIInput
components in a view. The validator to most often serve this role is
the BeanValidator. The usage contract for this method assumes that the
validator has been registered using the normal “by-id”
registration mechanism. An implementation is provided that takes no
action so that users that decorate the Application continue to work. |
true |
|
true |
| JSF:JAVADOC:26 |
void |
jakarta.faces.application.Application.addELContextListener
( ELContextListener ) |
Provide
a way for Faces applications to register an ELContextListener that
will be notified on creation of ELContext instances. This listener
will be called once per request. An implementation is provided that
throws UnsupportedOperationException so that users that decorate the
Application continue to work. |
true |
|
true |
| JSF:JAVADOC:27 |
void |
jakarta.faces.application.Application.addELResolver
( ELResolver ) |
Cause
an the argument resolver to be added to the resolver chain as
specified in section JSF.5.5.1 of the Jakarta Server Faces Specification.
It is not possible to remove an ELResolver registered with this
method, once it has been registered. It is illegal to register an
ELResolver after the application has received any requests from the
client. If an attempt is made to register a listener after that time,
an IllegalStateException must be thrown. This restriction is in place
to allow the JSP container to optimize for the common case where no
additional ELResolvers are in the chain, aside from the standard ones.
It is permissible to add ELResolvers before or after initialization to
a CompositeELResolver that is already in the chain. The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
Application. |
true |
|
true |
| JSF:JAVADOC:28 |
void |
jakarta.faces.application.Application.addValidator
( String ,
String ) |
Register a new mapping of validator id to the name of the
corresponding Validator class. This allows subsequent calls to
createValidator() to serve as a factory for Validator instances. |
true |
|
true |
| JSF:JAVADOC:29 |
void |
jakarta.faces.application.Application.addValidator
( String ,
String )
throws NullPointerException
|
if
validatorId or validatorClass is null |
true |
|
true |
| JSF:JAVADOC:30 |
Application |
jakarta.faces.application.Application.Application
|
|
true |
|
true |
| JSF:JAVADOC:31 |
Behavior |
jakarta.faces.application.Application.createBehavior
( String ) |
Instantiate and return a new Behavior instance of the class specified
by a previous call to addBehavior() for the specified behavior id. |
true |
|
true |
| JSF:JAVADOC:32 |
Behavior |
jakarta.faces.application.Application.createBehavior
( String )
throws FacesException
|
if the
Behavior cannot be created |
true |
|
true |
| JSF:JAVADOC:33 |
Behavior |
jakarta.faces.application.Application.createBehavior
( String )
throws NullPointerException
|
if
behaviorId is null |
true |
|
true |
| JSF:JAVADOC:34 |
UIComponent |
jakarta.faces.application.Application.createComponent
( String ) |
Instantiate and return a new UIComponent instance of the class
specified by a previous call to addComponent() for the specified
component type. Before the component instance is returned, it must be
inspected for the presence of a jakarta.faces.event.ListenerFor (or
jakarta.faces.event.ListenersFor) or ResourceDependency (or
ResourceDependencies) annotation. If any of these annotations are
present, the action listed in jakarta.faces.event.ListenerFor or
ResourceDependency must be taken on the component, before it is
returned from this method. This variant of createComponent must not
inspect the jakarta.faces.render.Renderer for the component to be
returned for any of the afore mentioned annotations. Such inspection
is the province of #createComponent(ValueExpression, FacesContext,
String, String) or #createComponent(FacesContext, String, String). |
true |
|
true |
| JSF:JAVADOC:35 |
UIComponent |
jakarta.faces.application.Application.createComponent
( String )
throws FacesException
|
if a
UIComponent of the specified type cannot be created |
true |
|
true |
| JSF:JAVADOC:36 |
UIComponent |
jakarta.faces.application.Application.createComponent
( String )
throws NullPointerException
|
if
componentType is null |
true |
|
true |
| JSF:JAVADOC:37 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueBinding ,
FacesContext ,
String ) |
Wrap
the argument componentBinding in an implementation of ValueExpression
and call through to
#createComponent(jakarta.el.ValueExpression,jakarta.faces.context.FacesContext,java.lang.String).
|
true |
true |
true |
| JSF:JAVADOC:38 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueBinding ,
FacesContext ,
String )
throws FacesException
|
if a
UIComponent cannot be created |
true |
true |
true |
| JSF:JAVADOC:39 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueBinding ,
FacesContext ,
String )
throws NullPointerException
|
if any
parameter is null |
true |
true |
true |
| JSF:JAVADOC:40 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String ) |
Call
the getValue() method on the specified ValueExpression. If it returns
a UIComponent instance, return it as the value of this method. If it
does not, instantiate a new UIComponent instance of the specified
component type, pass the new component to the setValue() method of the
specified ValueExpression, and return it. Before the component
instance is returned, it must be inspected for the presence of a
jakarta.faces.event.ListenerFor (or jakarta.faces.event.ListenersFor) or
ResourceDependency (or ResourceDependencies) annotation. If any of
these annotations are present, the action listed in
jakarta.faces.event.ListenerFor or ResourceDependency must be taken on
the component, before it is returned from this method. This variant of
createComponent must not inspect the jakarta.faces.render.Renderer for
the component to be returned for any of the afore mentioned
annotations. Such inspection is the province of
#createComponent(ValueExpression, FacesContext, String, String) or
#createComponent(FacesContext, String, String). |
true |
|
true |
| JSF:JAVADOC:41 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String )
throws FacesException
|
if a
UIComponent cannot be created |
true |
|
true |
| JSF:JAVADOC:42 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String )
throws NullPointerException
|
if any
parameter is null A default implementation is provided that throws
UnsupportedOperationException so that users that decorate Application
can continue to function. |
true |
|
true |
| JSF:JAVADOC:43 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String ,
String ) |
Like
#createComponent(ValueExpression, FacesContext, String) except the
Renderer for the component to be returned must be inspected for the
annotations mentioned in #createComponent(ValueExpression,
FacesContext, String) as specified in the documentation for that
method. The Renderer instance to inspect must be obtained by calling
FacesContext#getRenderKit and calling
jakarta.faces.render.RenderKit#getRenderer on the result, passing the
argument componentType as the first argument and the result of calling
UIComponent#getFamily on the newly created component as the second
argument. If no such Renderer can be found, a message must be logged
with a helpful error message. Otherwise, UIComponent#setRendererType
must be called on the newly created UIComponent instance, passing the
argument rendererType as the argument. A default implementation is
provided that throws UnsupportedOperationException so that users that
decorate Application can continue to function. |
true |
|
true |
| JSF:JAVADOC:44 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String ,
String )
throws FacesException
|
if a
UIComponent cannot be created |
true |
|
true |
| JSF:JAVADOC:45 |
UIComponent |
jakarta.faces.application.Application.createComponent
( ValueExpression ,
FacesContext ,
String ,
String )
throws NullPointerException
|
if any
of the parameters componentExpression, context, or componentType are
null |
true |
|
true |
| JSF:JAVADOC:46 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
String ,
String ) |
Like
#createComponent(String) except the Renderer for the component to be
returned must be inspected for the annotations mentioned in
#createComponent(ValueExpression, FacesContext, String) as specified
in the documentation for that method. The Renderer instance to inspect
must be obtained by calling FacesContext#getRenderKit and calling
jakarta.faces.render.RenderKit#getRenderer on the result, passing the
argument componentType as the first argument and the result of calling
UIComponent#getFamily on the newly created component as the second
argument. If no such Renderer can be found, a message must be logged
with a helpful error message. Otherwise, UIComponent#setRendererType
must be called on the newly created UIComponent instance, passing the
argument rendererType as the argument. A default implementation is
provided that throws UnsupportedOperationException so that users that
decorate Application can continue to function. |
true |
|
true |
| JSF:JAVADOC:47 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
String ,
String )
throws FacesException
|
if a
UIComponent cannot be created |
true |
|
true |
| JSF:JAVADOC:48 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
String ,
String )
throws NullPointerException
|
if any
of the parameters context, or componentType are null |
true |
|
true |
| JSF:JAVADOC:49 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
Resource ) |
Instantiate and return a new UIComponent instance from the argument
Resource. An algorithm semantically equivalent to the following must
be followed to instantiate the UIComponent to return. Obtain a
reference to the ViewDeclarationLanguage for this Application instance
by calling ViewHandler#getViewDeclarationLanguage, passing the viewId
found by calling jakarta.faces.component.UIViewRoot#getViewId on the
jakarta.faces.component.UIViewRoot in the argument FacesContext. Obtain
a reference to the composite component metadata for this composite
component by calling ViewDeclarationLanguage#getComponentMetadata,
passing the facesContext and componentResource arguments to this
method. This version of JSF specification uses JavaBeans as the API to
the component metadata. Determine if the component author declared a
component-type for this component instance by obtaining the
BeanDescriptor from the component metadata and calling its getValue()
method, passing UIComponent#COMPOSITE_COMPONENT_TYPE_KEY as the
argument. If non-null, the result must be a ValueExpression whose
value is the component-type of the UIComponent to be created for this
Resource component. Call through to #createComponent(java.lang.String)
to create the component. Otherwise, determine if a script based
component for this Resource can be found by calling
ViewDeclarationLanguage#getScriptComponentResource. If the result is
non-null, and is a script written in one of the languages listed in
JSF.4.3 of the specification prose document, create a UIComponent
instance from the script resource. Otherwise, let library-name be the
return from calling Resource#getLibraryName on the argument
componentResource and resource-name be the return from calling
Resource#getResourceName on the argument componentResource. Create a
fully qualified Java class name by removing any file extension from
resource-name and let fqcn be library-name + "." + resource-name. If a
class with the name of fqcn cannot be found, take no action and
continue to the next step. If any of InstantiationException,
IllegalAccessException, or ClassCastException are thrown, wrap the
exception in a FacesException and re-throw it. If any other exception
is thrown, log the exception and continue to the next step. If none of
the previous steps have yielded a UIComponent instance, call
#createComponent(java.lang.String) passing
"jakarta.faces.NamingContainer" as the argument. Call
UIComponent#setRendererType on the UIComponent instance, passing
"jakarta.faces.Composite" as the argument. Store the argument Resource
in the attributes Map of the UIComponent under the key,
Resource#COMPONENT_RESOURCE_KEY. Store composite component metadata in
the attributes Map of the UIComponent under the key,
UIComponent#BEANINFO_KEY. Before the component instance is returned,
it must be inspected for the presence of a
jakarta.faces.event.ListenerFor annotation. If this annotation is
present, the action listed in jakarta.faces.event.ListenerFor must be
taken on the component, before it is returned from this method. A
default implementation is provided that throws
UnsupportedOperationException so that users that decorate Application
can continue to function. |
true |
|
true |
| JSF:JAVADOC:50 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
Resource )
throws FacesException
|
if a
UIComponent from the Resource cannot be created |
true |
|
true |
| JSF:JAVADOC:51 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
Resource )
throws <code>NullPointerException</code>
|
if any
parameter is null |
true |
|
true |
| JSF:JAVADOC:52 |
UIComponent |
jakarta.faces.application.Application.createComponent
( FacesContext ,
Resource )
throws NullPointerException
|
if
unable, for any reason, to obtain a ViewDeclarationLanguage instance
as described above. |
true |
|
true |
| JSF:JAVADOC:53 |
Converter |
jakarta.faces.application.Application.createConverter
( String ) |
Instantiate and return a new Converter instance of the class specified
by a previous call to addConverter() for the specified converter id.
If the toLowerCase() of the String represenation of the value of the
"jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE"
application configuration parameter is "true" (without the quotes) and
the Converter instance to be returned is an instance of
jakarta.faces.convert.DateTimeConverter,
jakarta.faces.convert.DateTimeConverter#setTimeZone must be called,
passing the return from TimeZone.getDefault(). The argument converter
must be inspected for the presence of the
jakarta.faces.application.ResourceDependency annotation. If the
ResourceDependency annotation is present, the action described in
ResourceDependency must be taken. If the ResourceDependency annotation
is not present, the argument converter must be inspected for the
presence of the jakarta.faces.application.ResourceDependencies
annotation. If the ResourceDependencies annotation is present, the
action described in ResourceDependencies must be taken. |
true |
|
true |
| JSF:JAVADOC:54 |
Converter |
jakarta.faces.application.Application.createConverter
( String )
throws FacesException
|
if the
Converter cannot be created |
true |
|
true |
| JSF:JAVADOC:55 |
Converter |
jakarta.faces.application.Application.createConverter
( String )
throws NullPointerException
|
if
converterId is null |
true |
|
true |
| JSF:JAVADOC:56 |
Converter |
jakarta.faces.application.Application.createConverter
( Class ) |
Instantiate and return a new Converter instance of the class that has
registered itself as capable of performing conversions for objects of
the specified type. If no such Converter class can be identified,
return null. To locate an appropriate Converter class, the following
algorithm is performed, stopping as soon as an appropriate Converter
class is found: Locate a Converter registered for the target class
itself. Locate a Converter registered for interfaces that are
implemented by the target class (directly or indirectly). Locate a
Converter registered for the superclass (if any) of the target class,
recursively working up the inheritance hierarchy. If the Converter has
a single argument constructor that accepts a Class, instantiate the
Converter using that constructor, passing the argument targetClass as
the sole argument. Otherwise, simply use the zero-argument
constructor. If the toLowerCase() of the String represenation of the
value of the
"jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE"
application configuration parameter is "true" (without the quotes) and
the Converter instance to be returned is an instance of
jakarta.faces.convert.DateTimeConverter,
jakarta.faces.convert.DateTimeConverter#setTimeZone must be called,
passing the return from TimeZone.getDefault(). |
true |
|
true |
| JSF:JAVADOC:57 |
Converter |
jakarta.faces.application.Application.createConverter
( Class )
throws FacesException
|
if the
Converter cannot be created |
true |
|
true |
| JSF:JAVADOC:58 |
Converter |
jakarta.faces.application.Application.createConverter
( Class )
throws NullPointerException
|
if
targetClass is null |
true |
|
true |
| JSF:JAVADOC:59 |
MethodBinding |
jakarta.faces.application.Application.createMethodBinding
( String ,
Class[] ) |
Call
#getExpressionFactory then call
ExpressionFactory#createMethodExpression, passing the given arguments,
and wrap the result in a MethodBinding implementation, returning it. |
true |
true |
true |
| JSF:JAVADOC:60 |
MethodBinding |
jakarta.faces.application.Application.createMethodBinding
( String ,
Class[] )
throws ReferenceSyntaxException
|
if the
specified ref has invalid syntax |
true |
true |
true |
| JSF:JAVADOC:61 |
MethodBinding |
jakarta.faces.application.Application.createMethodBinding
( String ,
Class[] )
throws NullPointerException
|
if ref
is null |
true |
true |
true |
| JSF:JAVADOC:62 |
Validator |
jakarta.faces.application.Application.createValidator
( String ) |
Instantiate and return a new Validator instance of the class specified
by a previous call to addValidator() for the specified validator id.
The argument validator must be inspected for the presence of the
jakarta.faces.application.ResourceDependency annotation. If the
ResourceDependency annotation is present, the action described in
ResourceDependency must be taken. If the ResourceDependency annotation
is not present, the argument validator must be inspected for the
presence of the jakarta.faces.application.ResourceDependencies
annotation. If the ResourceDependencies annotation is present, the
action described in ResourceDependencies must be taken. |
true |
|
true |
| JSF:JAVADOC:63 |
Validator |
jakarta.faces.application.Application.createValidator
( String )
throws FacesException
|
if a
Validator of the specified id cannot be created |
true |
|
true |
| JSF:JAVADOC:64 |
Validator |
jakarta.faces.application.Application.createValidator
( String )
throws NullPointerException
|
if
validatorId is null |
true |
|
true |
| JSF:JAVADOC:65 |
ValueBinding |
jakarta.faces.application.Application.createValueBinding
( String ) |
Call
#getExpressionFactory then call
ExpressionFactory#createValueExpression, passing the argument ref,
Object.class for the expectedType, and null, for the fnMapper. |
true |
true |
true |
| JSF:JAVADOC:66 |
ValueBinding |
jakarta.faces.application.Application.createValueBinding
( String )
throws ReferenceSyntaxException
|
if the
specified ref has invalid syntax |
true |
true |
true |
| JSF:JAVADOC:67 |
ValueBinding |
jakarta.faces.application.Application.createValueBinding
( String )
throws NullPointerException
|
if ref
is null |
true |
true |
true |
| JSF:JAVADOC:68 |
Object |
jakarta.faces.application.Application.evaluateExpressionGet
( FacesContext ,
String ,
Class ) |
Get a
value by evaluating an expression. Call #getExpressionFactory then
call ExpressionFactory#createValueExpression passing the argument
expression and expectedType. Call FacesContext#getELContext and pass
it to ValueExpression#getValue, returning the result. An
implementation is provided that throws UnsupportedOperationException
so that users that decorate the Application continue to work. |
true |
|
true |
| JSF:JAVADOC:69 |
Object |
jakarta.faces.application.Application.evaluateExpressionGet
( FacesContext ,
String ,
Class )
throws ELException
|
|
true |
|
true |
| JSF:JAVADOC:70 |
ActionListener |
jakarta.faces.application.Application.getActionListener
|
Return
the default ActionListener to be registered for all
jakarta.faces.component.ActionSource components in this appication. If
not explicitly set, a default implementation must be provided that
performs the following functions: The processAction() method must
first call FacesContext.renderResponse() in order to bypass any
intervening lifecycle phases, once the method returns. The
processAction() method must next determine the logical outcome of this
event, as follows: If the originating component has a non-null action
property, retrieve the MethodBinding from the property, and call
invoke() on it. Convert the returned value (if any) to a String, and
use it as the logical outcome. Otherwise, the logical outcome is null.
The processAction() method must finally retrieve the NavigationHandler
instance for this application and call
NavigationHandler#handleNavigation passing: the FacesContext for the
current request If there is a MethodBinding instance for the action
property of this component, the result of calling
MethodBinding#getExpressionString on it, null otherwise the logical
outcome as determined above Note that the specification for the
default ActionListener contiues to call for the use of a deprecated
property (action) and class (MethodBinding). Unfortunately, this is
necessary because the default ActionListener must continue to work
with components that do not implement
jakarta.faces.component.ActionSource2, and only implement
jakarta.faces.component.ActionSource. |
true |
|
true |
| JSF:JAVADOC:71 |
Iterator |
jakarta.faces.application.Application.getBehaviorIds
|
Return
an Iterator over the set of currently registered behavior ids for this
Application. |
true |
|
true |
| JSF:JAVADOC:72 |
Iterator |
jakarta.faces.application.Application.getComponentTypes
|
Return
an Iterator over the set of currently defined component types for this
Application. |
true |
|
true |
| JSF:JAVADOC:73 |
Iterator |
jakarta.faces.application.Application.getConverterIds
|
Return
an Iterator over the set of currently registered converter ids for
this Application. |
true |
|
true |
| JSF:JAVADOC:74 |
Iterator |
jakarta.faces.application.Application.getConverterTypes
|
Return
an Iterator over the set of Class instances for which Converter
classes have been explicitly registered. |
true |
|
true |
| JSF:JAVADOC:75 |
Locale |
jakarta.faces.application.Application.getDefaultLocale
|
Return
the default Locale for this application. If not explicitly set, null
is returned. |
true |
|
true |
| JSF:JAVADOC:76 |
String |
jakarta.faces.application.Application.getDefaultRenderKitId
|
Return
the renderKitId to be used for rendering this application. If not
explicitly set, null is returned. |
true |
|
true |
| JSF:JAVADOC:77 |
Map |
jakarta.faces.application.Application.getDefaultValidatorInfo
|
Return
an immutable Map over the set of currently registered default
validator IDs and their class name for this Application. An
implementation is provided that returns Collections.emptyMap so that
users that decorate the Application continue to work. |
true |
|
true |
| JSF:JAVADOC:78 |
ELContextListener[] |
jakarta.faces.application.Application.getELContextListeners
|
If no
calls have been made to #addELContextListener, this method must return
an empty array. Otherwise, return an array representing the list of
listeners added by calls to #addELContextListener. An implementation
is provided that throws UnsupportedOperationException so that users
that decorate the Application continue to work. |
true |
|
true |
| JSF:JAVADOC:79 |
ELResolver |
jakarta.faces.application.Application.getELResolver
|
Return
the singleton ELResolver instance to be used for all EL resolution.
This is actually an instance of jakarta.el.CompositeELResolver that must
contain the following ELResolver instances in the following order:
ELResolver instances declared using the element in the application
configuration resources. An implementation that wraps the head of the
legacy VariableResolver chain, as per section VariableResolver
ChainWrapper in Chapter JSF.5 in the spec document. An implementation
that wraps the head of the legacy PropertyResolver chain, as per
section PropertyResolver ChainWrapper in Chapter JSF.5 in the spec
document. Any ELResolver instances added by calls to #addELResolver.
The default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend Application. |
true |
|
true |
| JSF:JAVADOC:80 |
ExpressionFactory |
jakarta.faces.application.Application.getExpressionFactory
|
Return
the ExpressionFactory instance for this application. This instance is
used by the convenience method #evaluateExpressionGet. The
implementation must return the ExpressionFactory from the JSP
container by calling
JspFactory.getDefaultFactory().getJspApplicationContext(servletContext).getExpressionFactory().
An implementation is provided that throws
UnsupportedOperationException so that users that decorate the
Application continue to work. |
true |
|
true |
| JSF:JAVADOC:81 |
String |
jakarta.faces.application.Application.getMessageBundle
|
Return
the fully qualified class name of the ResourceBundle to be used for
Jakarta Server Faces messages for this application. If not explicitly set,
null is returned. |
true |
|
true |
| JSF:JAVADOC:82 |
NavigationHandler |
jakarta.faces.application.Application.getNavigationHandler
|
Return
the NavigationHandler instance that will be passed the outcome
returned by any invoked application action for this web application.
If not explicitly set, a default implementation must be provided that
performs the functions described in the NavigationHandler class
description. |
true |
|
true |
| JSF:JAVADOC:83 |
ProjectStage |
jakarta.faces.application.Application.getProjectStage
|
Return
the project stage for the currently running application instance. The
default value is ProjectStage#Production The implementation of this
method must perform the following algorithm or an equivalent with the
same end result to determine the value to return. If the value has
already been determined by a previous call to this method, simply
return that value. Look for a JNDI environment entry under the key
given by the value of ProjectStage#PROJECT_STAGE_JNDI_NAME (return
type of java.lang.String). If found, continue with the algorithm
below, otherwise, look for an entry in the initParamMap of the
ExternalContext from the current FacesContext with the key given by
the value of ProjectStage#PROJECT_STAGE_PARAM_NAME If a value is
found, see if an enum constant can be obtained by calling
ProjectStage.valueOf(), passing the value from the initParamMap. If
this succeeds without exception, save the value and return it. If not
found, or any of the previous attempts to discover the enum constant
value have failed, log a descriptive error message, assign the value
as ProjectStage.Production and return it. A default implementation is
provided that throws UnsupportedOperationException so that users that
decorate Application can continue to function. |
true |
|
true |
| JSF:JAVADOC:84 |
PropertyResolver |
jakarta.faces.application.Application.getPropertyResolver
|
Return
a PropertyResolver instance that wraps the ELResolver instance that
Faces provides to the unified EL for the resolution of expressions
that appear programmatically in an application. Note that this no
longer returns the default PropertyResolver since that class is now a
no-op that aids in allowing custom PropertyResolvers to affect the EL
resolution process. |
true |
true |
true |
| JSF:JAVADOC:85 |
ResourceBundle |
jakarta.faces.application.Application.getResourceBundle
( FacesContext ,
String ) |
Find a
ResourceBundle as defined in the application configuration resources
under the specified name. If a ResourceBundle was defined for the
name, return an instance that uses the locale of the current
jakarta.faces.component.UIViewRoot. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:86 |
ResourceBundle |
jakarta.faces.application.Application.getResourceBundle
( FacesContext ,
String )
throws FacesException
|
if a
bundle was defined, but not resolvable |
true |
|
true |
| JSF:JAVADOC:87 |
ResourceBundle |
jakarta.faces.application.Application.getResourceBundle
( FacesContext ,
String )
throws NullPointerException
|
if ctx
== null || name == null |
true |
|
true |
| JSF:JAVADOC:88 |
ResourceHandler |
jakarta.faces.application.Application.getResourceHandler
|
Return
the singleton, stateless, thread-safe ResourceHandler for this
application. The JSF implementation must support the following
techniques for declaring an alternate implementation of
ResourceHandler. The ResourceHandler implementation is declared in the
application configuration resources by giving the fully qualified
class name as the value of the element within the element. In all of
the above cases, the runtime must employ the decorator pattern as for
every other pluggable artifact in JSF. A default implementation is
provided that throws UnsupportedOperationException so that users that
decorate Application can continue to function. |
true |
|
true |
| JSF:JAVADOC:89 |
StateManager |
jakarta.faces.application.Application.getStateManager
|
Return
the StateManager instance that will be utilized during the Restore
View and Render Response phases of the request processing lifecycle.
If not explicitly set, a default implementation must be provided that
performs the functions described in the StateManager description in
the Jakarta Server Faces Specification. |
true |
|
true |
| JSF:JAVADOC:90 |
Iterator |
jakarta.faces.application.Application.getSupportedLocales
|
Return
an Iterator over the supported Locales for this appication. |
true |
|
true |
| JSF:JAVADOC:91 |
Iterator |
jakarta.faces.application.Application.getValidatorIds
|
Return
an Iterator over the set of currently registered validator ids for
this Application. |
true |
|
true |
| JSF:JAVADOC:92 |
VariableResolver |
jakarta.faces.application.Application.getVariableResolver
|
Return
the VariableResolver that wraps the ELResolver instance that Faces
provides to the unified EL for the resolution of expressions that
appear programmatically in an application. The implementation of the
VariableResolvermust pass null as the base argument for any methods
invoked on the underlying ELResolver. Note that this method no longer
returns the default VariableResolver, since that class now is a no-op
that aids in allowing custom VariableResolvers to affect the EL
resolution process. |
true |
true |
true |
| JSF:JAVADOC:93 |
ViewHandler |
jakarta.faces.application.Application.getViewHandler
|
Return
the ViewHandler instance that will be utilized during the Restore View
and Render Response phases of the request processing lifecycle. If not
explicitly set, a default implementation must be provided that
performs the functions described in the ViewHandler description in the
Jakarta Server Faces Specification. |
true |
|
true |
| JSF:JAVADOC:94 |
void |
jakarta.faces.application.Application.publishEvent
( FacesContext ,
Class ,
Object ) |
If
jakarta.faces.context.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. The implementation should be as fast as possible in
determining whether or not a listener for the given systemEventClass
and source has been installed, and should return immediately once such
a determination has been made. The implementation of publishEvent must
honor the requirements stated in #subscribeToEvent regarding the
storage and retrieval of listener instances. Specifically, if
#subscribeToEvent(Class,Class,SystemEventListener) was called, the
sourceClass argument must match exactly the Class of the source
argument in the call to publishEvent(). The implementation must not do
any inheritance hierarachy inspection when looking for a match between
the sourceClass passed to
#subscribeToEvent(Class,Class,SystemEventListener) and the sourceClass
passed to publishEvent() in order to find any listeners to which the
event should be published. In the case where the Class of the source
argument does not match the Class of the sourceClass used when the
listener was subscribed using subscribeToEvent(),
#publishEvent(FacesContext,Class,Class,Object) can be used to provide
the Class used to perform the listener lookup and match. The default
implementation must implement an algorithm semantically equivalent to
the following to locate listener instances and to invoke them. If the
source argument implements
jakarta.faces.event.SystemEventListenerHolder, call
jakarta.faces.event.SystemEventListenerHolder#getListenersForEventClass
on it, passing the systemEventClass argument. If the list is not
empty, perform algorithm traverseListenerList on the list. If any view
level listeners have been installed by previous calls to
#subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the jakarta.faces.component.UIViewRoot, perform algorithm
traverseListenerList on the list of listeners for that event installed
on the UIViewRoot. If any Application level listeners have been
installed by previous calls to #subscribeToEvent(Class, Class,
jakarta.faces.event.SystemEventListener), perform algorithm
traverseListenerList on the list. If any Application level listeners
have been installed by previous calls to #subscribeToEvent(Class,
jakarta.faces.event.SystemEventListener), perform algorithm
traverseListenerList on the list. If the act of invoking the
processListener method causes an
jakarta.faces.event.AbortProcessingException to be thrown, processing of
the listeners must be aborted, no further processing of the listeners
for this event must take place, and the exception must be logged with
Level.SEVERE. Algorithm traverseListenerList: For each listener in the
list, Call jakarta.faces.event.SystemEventListener#isListenerForSource,
passing the source argument. If this returns false, take no action on
the listener. Otherwise, if the event to be passed to the listener
instances has not yet been constructed, construct the event, passing
source as the argument to the one-argument constructor that takes an
Object. This same event instance must be passed to all listener
instances. Call jakarta.faces.event.SystemEvent#isAppropriateListener,
passing the listener instance as the argument. If this returns false,
take no action on the listener. Call
jakarta.faces.event.SystemEvent#processListener, passing the listener
instance. A default implementation is provided that throws
UnsupportedOperationException so that users that decorate Application
can continue to function. |
true |
|
true |
| JSF:JAVADOC:95 |
void |
jakarta.faces.application.Application.publishEvent
( FacesContext ,
Class ,
Object )
throws NullPointerException
|
if
either context, systemEventClass or source is null |
true |
|
true |
| JSF:JAVADOC:96 |
void |
jakarta.faces.application.Application.publishEvent
( FacesContext ,
Class ,
Class ,
Object ) |
This
method functions exactly like
#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. A default implementation is
provided that throws UnsupportedOperationException so that users that
decorate Application can continue to function. |
true |
|
true |
| JSF:JAVADOC:97 |
void |
jakarta.faces.application.Application.publishEvent
( FacesContext ,
Class ,
Class ,
Object )
throws NullPointerException
|
if any
arguments are null |
true |
|
true |
| JSF:JAVADOC:98 |
void |
jakarta.faces.application.Application.removeELContextListener
( ELContextListener ) |
Remove
the argument listener from the list of ELContextListeners. If listener
is null, no exception is thrown and no action is performed. If
listener is not in the list, no exception is thrown and no action is
performed. An implementation is provided that throws
UnsupportedOperationException so that users that decorate the
Application continue to work. |
true |
|
true |
| JSF:JAVADOC:99 |
void |
jakarta.faces.application.Application.setActionListener
( ActionListener ) |
Set the
default ActionListener to be registered for all
jakarta.faces.component.ActionSource components. |
true |
|
true |
| JSF:JAVADOC:100 |
void |
jakarta.faces.application.Application.setActionListener
( ActionListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:101 |
void |
jakarta.faces.application.Application.setDefaultLocale
( Locale ) |
Set the
default Locale for this application. |
true |
|
true |
| JSF:JAVADOC:102 |
void |
jakarta.faces.application.Application.setDefaultLocale
( Locale )
throws NullPointerException
|
if
locale is null |
true |
|
true |
| JSF:JAVADOC:103 |
void |
jakarta.faces.application.Application.setDefaultRenderKitId
( String ) |
Set the
renderKitId to be used to render this application. Unless the client
has provided a custom ViewHandler that supports the use of multiple
jakarta.faces.render.RenderKit instances in the same application, this
method must only be called at application startup, before any Faces
requests have been processed. This is a limitation of the current
Specification, and may be lifted in a future release. |
true |
|
true |
| JSF:JAVADOC:104 |
void |
jakarta.faces.application.Application.setMessageBundle
( String ) |
Set the
fully qualified class name of the ResourceBundle to be used for
Jakarta Server Faces messages for this application. See the JavaDocs for
the java.util.ResourceBundle class for more information about the
syntax for resource bundle names. |
true |
|
true |
| JSF:JAVADOC:105 |
void |
jakarta.faces.application.Application.setMessageBundle
( String )
throws NullPointerException
|
if
bundle is null |
true |
|
true |
| JSF:JAVADOC:106 |
void |
jakarta.faces.application.Application.setNavigationHandler
( NavigationHandler ) |
Set the
NavigationHandler instance that will be passed the outcome returned by
any invoked application action for this web application. |
true |
|
true |
| JSF:JAVADOC:107 |
void |
jakarta.faces.application.Application.setNavigationHandler
( NavigationHandler )
throws NullPointerException
|
if
handler is null |
true |
|
true |
| JSF:JAVADOC:108 |
void |
jakarta.faces.application.Application.setPropertyResolver
( PropertyResolver ) |
Set the
PropertyResolver instance that will be utilized to resolve method and
value bindings. This method is now deprecated but the implementation
must cause the argument to be set as the head of the legacy
PropertyResolver chain, replacing any existing value that was set from
the application configuration resources. It is illegal to call this
method after the application has received any requests from the
client. If an attempt is made to register a listener after that time
it must have no effect. |
true |
true |
true |
| JSF:JAVADOC:109 |
void |
jakarta.faces.application.Application.setPropertyResolver
( PropertyResolver )
throws NullPointerException
|
if
resolver is null |
true |
true |
true |
| JSF:JAVADOC:110 |
void |
jakarta.faces.application.Application.setPropertyResolver
( PropertyResolver )
throws IllegalStateException
|
if
called after the first request to the jakarta.faces.webapp.FacesServlet
has been serviced. |
true |
true |
true |
| JSF:JAVADOC:111 |
void |
jakarta.faces.application.Application.setResourceHandler
( ResourceHandler ) |
Set the
ResourceHandler instance that will be utilized for rendering the
markup for resources, and for satisfying client requests to serve up
resources. |
true |
|
true |
| JSF:JAVADOC:112 |
void |
jakarta.faces.application.Application.setResourceHandler
( ResourceHandler )
throws IllegalStateException
|
if this
method is called after at least one request has been processed by the
Lifecycle instance for this application. |
true |
|
true |
| JSF:JAVADOC:113 |
void |
jakarta.faces.application.Application.setResourceHandler
( ResourceHandler )
throws NullPointerException
|
if
resourceHandler is null |
true |
|
true |
| JSF:JAVADOC:114 |
void |
jakarta.faces.application.Application.setStateManager
( StateManager ) |
Set the
StateManager instance that will be utilized during the Restore View
and Render Response phases of the request processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:115 |
void |
jakarta.faces.application.Application.setStateManager
( StateManager )
throws IllegalStateException
|
if this
method is called after at least one request has been processed by the
Lifecycle instance for this application. |
true |
|
true |
| JSF:JAVADOC:116 |
void |
jakarta.faces.application.Application.setStateManager
( StateManager )
throws NullPointerException
|
if
manager is null |
true |
|
true |
| JSF:JAVADOC:117 |
void |
jakarta.faces.application.Application.setSupportedLocales
( Collection ) |
Set the
Locale instances representing the supported Locales for this
application. |
true |
|
true |
| JSF:JAVADOC:118 |
void |
jakarta.faces.application.Application.setSupportedLocales
( Collection )
throws NullPointerException
|
if the
argument newLocales is null. |
true |
|
true |
| JSF:JAVADOC:119 |
void |
jakarta.faces.application.Application.setVariableResolver
( VariableResolver ) |
Set the
VariableResolver instance that will be consulted to resolve method and
value bindings. This method is now deprecated but the implementation
must cause the argument to be set as the head of the legacy
VariableResolver chain, replacing any existing value that was set from
the application configuration resources. It is illegal to call this
method after the application has received any requests from the
client. If an attempt is made to register a listener after that time
it must have no effect. |
true |
true |
true |
| JSF:JAVADOC:120 |
void |
jakarta.faces.application.Application.setVariableResolver
( VariableResolver )
throws NullPointerException
|
if
resolver is null |
true |
true |
true |
| JSF:JAVADOC:121 |
void |
jakarta.faces.application.Application.setVariableResolver
( VariableResolver )
throws IllegalStateException
|
if
called after the first request to the jakarta.faces.webapp.FacesServlet
has been serviced. |
true |
true |
true |
| JSF:JAVADOC:122 |
void |
jakarta.faces.application.Application.setViewHandler
( ViewHandler ) |
Set the
ViewHandler instance that will be utilized during the Restore View and
Render Response phases of the request processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:123 |
void |
jakarta.faces.application.Application.setViewHandler
( ViewHandler )
throws IllegalStateException
|
if this
method is called after at least one request has been processed by the
Lifecycle instance for this application. |
true |
|
true |
| JSF:JAVADOC:124 |
void |
jakarta.faces.application.Application.setViewHandler
( ViewHandler )
throws NullPointerException
|
if
handler is null |
true |
|
true |
| JSF:JAVADOC:125 |
void |
jakarta.faces.application.Application.subscribeToEvent
( Class ,
Class ,
SystemEventListener ) |
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. If argument sourceClass is
non-null, sourceClass and systemEventClass must be used to store the
argument listener in the application in such a way that the listener
can be quickly looked up by the implementation of #publishEvent given
systemEventClass and an instance of the Class referenced by
sourceClass. If argument sourceClass is null, the listener must be
discoverable by the implementation of #publishEvent given only
systemEventClass. |
true |
|
true |
| JSF:JAVADOC:126 |
void |
jakarta.faces.application.Application.subscribeToEvent
( Class ,
Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if any
combination of systemEventClass, or listener are null. |
true |
|
true |
| JSF:JAVADOC:127 |
void |
jakarta.faces.application.Application.subscribeToEvent
( Class ,
SystemEventListener ) |
Install
the listener instance referenced by argument listener into application
as a listener for events of type systemEventClass. The default
implementation simply calls through to #subscribeToEvent(Class, Class,
jakarta.faces.event.SystemEventListener) passing null as the sourceClass
argument A default implementation is provided that throws
UnsupportedOperationException so that users that decorate Application
can continue to function. |
true |
|
true |
| JSF:JAVADOC:128 |
void |
jakarta.faces.application.Application.subscribeToEvent
( Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if any
combination of systemEventClass, or listener are null. |
true |
|
true |
| JSF:JAVADOC:129 |
void |
jakarta.faces.application.Application.unsubscribeFromEvent
( Class ,
Class ,
SystemEventListener ) |
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. See
#subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener)
for the specification of how the listener is stored, and therefore,
how it must be removed. |
true |
|
true |
| JSF:JAVADOC:130 |
void |
jakarta.faces.application.Application.unsubscribeFromEvent
( Class ,
Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if any
combination of context, systemEventClass, or listener are null. |
true |
|
true |
| JSF:JAVADOC:131 |
void |
jakarta.faces.application.Application.unsubscribeFromEvent
( Class ,
SystemEventListener ) |
Remove
the listener instance referenced by argument listener from the
application as a listener for events of type systemEventClass. The
default implementation simply calls through to
#unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener)
passing null as the sourceClass argument |
true |
|
true |
| JSF:JAVADOC:132 |
void |
jakarta.faces.application.Application.unsubscribeFromEvent
( Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if any
combination of context, systemEventClass, or listener are null.
http://java.sun.com/javaee/Jakarta Serverfaces/reference/api/index.html |
true |
|
true |
| JSF:JAVADOC:133 |
ApplicationFactory |
jakarta.faces.application.ApplicationFactory.ApplicationFactory
|
|
true |
|
true |
| JSF:JAVADOC:134 |
Application |
jakarta.faces.application.ApplicationFactory.getApplication
|
Create
(if needed) and return an Application instance for this web
application. |
true |
|
true |
| JSF:JAVADOC:135 |
ApplicationFactory |
jakarta.faces.application.ApplicationFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:136 |
void |
jakarta.faces.application.ApplicationFactory.setApplication
( Application ) |
Replace
the Application instance that will be returned for this web
application. |
true |
|
true |
| JSF:JAVADOC:137 |
void |
jakarta.faces.application.ApplicationFactory.setApplication
( Application )
throws NullPointerException
|
if
application is null. |
true |
|
true |
| JSF:JAVADOC:138 |
void |
jakarta.faces.application.ApplicationWrapper.addBehavior
( String ,
String ) |
The
default behavior of this method is to call
Application#addBehavior(String, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:139 |
void |
jakarta.faces.application.ApplicationWrapper.addComponent
( String ,
String ) |
The
default behavior of this method is to call
Application#addComponent(String, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:140 |
void |
jakarta.faces.application.ApplicationWrapper.addConverter
( String ,
String ) |
The
default behavior of this method is to call
Application#addConverter(String, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:141 |
void |
jakarta.faces.application.ApplicationWrapper.addConverter
( Class ,
String ) |
The
default behavior of this method is to call
Application#addConverter(Class, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:142 |
void |
jakarta.faces.application.ApplicationWrapper.addDefaultValidatorId
( String ) |
The
default behavior of this method is to call
Application#addDefaultValidatorId(String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:143 |
void |
jakarta.faces.application.ApplicationWrapper.addELContextListener
( ELContextListener ) |
The
default behavior of this method is to call
Application#addELContextListener(jakarta.el.ELContextListener) on the
wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:144 |
void |
jakarta.faces.application.ApplicationWrapper.addELResolver
( ELResolver ) |
The
default behavior of this method is to call
Application#addELResolver(jakarta.el.ELResolver) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:145 |
void |
jakarta.faces.application.ApplicationWrapper.addValidator
( String ,
String ) |
The
default behavior of this method is to call
Application#addValidator(String, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:146 |
ApplicationWrapper |
jakarta.faces.application.ApplicationWrapper.ApplicationWrapper
|
|
true |
|
true |
| JSF:JAVADOC:147 |
Behavior |
jakarta.faces.application.ApplicationWrapper.createBehavior
( String ) |
The
default behavior of this method is to call
Application#createBehavior(String) on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:148 |
Behavior |
jakarta.faces.application.ApplicationWrapper.createBehavior
( String )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:149 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( String ) |
The
default behavior of this method is to call
Application#createComponent(String) on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:150 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( String )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:151 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( ValueBinding ,
FacesContext ,
String ) |
The
default behavior of this method is to call
Application#createComponent(jakarta.faces.el.ValueBinding,
jakarta.faces.context.FacesContext, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:152 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( ValueBinding ,
FacesContext ,
String )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:153 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( ValueExpression ,
FacesContext ,
String ) |
The
default behavior of this method is to call
Application#createComponent(jakarta.el.ValueExpression,
jakarta.faces.context.FacesContext, String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:154 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( ValueExpression ,
FacesContext ,
String )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:155 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( ValueExpression ,
FacesContext ,
String ,
String ) |
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. |
true |
|
true |
| JSF:JAVADOC:156 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( FacesContext ,
String ,
String ) |
The
default behavior of this method is to call
Application#createComponent(jakarta.faces.context.FacesContext, String,
String) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:157 |
UIComponent |
jakarta.faces.application.ApplicationWrapper.createComponent
( FacesContext ,
Resource ) |
The
default behavior of this method is to call
Application#createComponent(jakarta.faces.context.FacesContext,
Resource) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:158 |
Converter |
jakarta.faces.application.ApplicationWrapper.createConverter
( String ) |
The
default behavior of this method is to call
Application#createConverter(String) on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:159 |
Converter |
jakarta.faces.application.ApplicationWrapper.createConverter
( Class ) |
The
default behavior of this method is to call
Application#createConverter(Class) on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:160 |
MethodBinding |
jakarta.faces.application.ApplicationWrapper.createMethodBinding
( String ,
Class[] ) |
The
default behavior of this method is to call
Application#createMethodBinding(String, Class[]) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:161 |
MethodBinding |
jakarta.faces.application.ApplicationWrapper.createMethodBinding
( String ,
Class[] )
throws ReferenceSyntaxException
|
|
true |
|
true |
| JSF:JAVADOC:162 |
Validator |
jakarta.faces.application.ApplicationWrapper.createValidator
( String ) |
The
default behavior of this method is to call
Application#createValidator(String) on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:163 |
Validator |
jakarta.faces.application.ApplicationWrapper.createValidator
( String )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:164 |
ValueBinding |
jakarta.faces.application.ApplicationWrapper.createValueBinding
( String ) |
The
default behavior of this method is to call
Application#createValueBinding(String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:165 |
ValueBinding |
jakarta.faces.application.ApplicationWrapper.createValueBinding
( String )
throws ReferenceSyntaxException
|
|
true |
|
true |
| JSF:JAVADOC:166 |
Object |
jakarta.faces.application.ApplicationWrapper.evaluateExpressionGet
( FacesContext ,
String ,
Class ) |
The
default behavior of this method is to call
Application#evaluateExpressionGet(jakarta.faces.context.FacesContext,
String, Class) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:167 |
Object |
jakarta.faces.application.ApplicationWrapper.evaluateExpressionGet
( FacesContext ,
String ,
Class )
throws ELException
|
|
true |
|
true |
| JSF:JAVADOC:168 |
ActionListener |
jakarta.faces.application.ApplicationWrapper.getActionListener
|
The
default behavior of this method is to call
Application#getActionListener on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:169 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getBehaviorIds
|
The
default behavior of this method is to call Application#getBehaviorIds
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:170 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getComponentTypes
|
The
default behavior of this method is to call
Application#getComponentTypes on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:171 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getConverterIds
|
The
default behavior of this method is to call Application#getConverterIds
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:172 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getConverterTypes
|
The
default behavior of this method is to call
Application#getConverterTypes on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:173 |
Locale |
jakarta.faces.application.ApplicationWrapper.getDefaultLocale
|
The
default behavior of this method is to call
Application#getDefaultLocale on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:174 |
String |
jakarta.faces.application.ApplicationWrapper.getDefaultRenderKitId
|
The
default behavior of this method is to call
Application#getDefaultRenderKitId on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:175 |
Map |
jakarta.faces.application.ApplicationWrapper.getDefaultValidatorInfo
|
The
default behavior of this method is to call
Application#getDefaultValidatorInfo on the wrapped Application object.
|
true |
|
true |
| JSF:JAVADOC:176 |
ELContextListener[] |
jakarta.faces.application.ApplicationWrapper.getELContextListeners
|
The
default behavior of this method is to call
Application#getELContextListeners on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:177 |
ELResolver |
jakarta.faces.application.ApplicationWrapper.getELResolver
|
The
default behavior of this method is to call Application#getELResolver
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:178 |
ExpressionFactory |
jakarta.faces.application.ApplicationWrapper.getExpressionFactory
|
The
default behavior of this method is to call
Application#getExpressionFactory on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:179 |
String |
jakarta.faces.application.ApplicationWrapper.getMessageBundle
|
The
default behavior of this method is to call
Application#getMessageBundle on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:180 |
NavigationHandler |
jakarta.faces.application.ApplicationWrapper.getNavigationHandler
|
The
default behavior of this method is to call
Application#getNavigationHandler on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:181 |
ProjectStage |
jakarta.faces.application.ApplicationWrapper.getProjectStage
|
The
default behavior of this method is to call Application#getProjectStage
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:182 |
PropertyResolver |
jakarta.faces.application.ApplicationWrapper.getPropertyResolver
|
The
default behavior of this method is to call
Application#getPropertyResolver on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:183 |
ResourceBundle |
jakarta.faces.application.ApplicationWrapper.getResourceBundle
( FacesContext ,
String ) |
The
default behavior of this method is to call
Application#getResourceBundle(jakarta.faces.context.FacesContext,
String) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:184 |
ResourceHandler |
jakarta.faces.application.ApplicationWrapper.getResourceHandler
|
The
default behavior of this method is to call
Application#getResourceHandler on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:185 |
StateManager |
jakarta.faces.application.ApplicationWrapper.getStateManager
|
The
default behavior of this method is to call Application#getStateManager
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:186 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getSupportedLocales
|
The
default behavior of this method is to call
Application#getSupportedLocales on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:187 |
Iterator |
jakarta.faces.application.ApplicationWrapper.getValidatorIds
|
The
default behavior of this method is to call Application#getValidatorIds
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:188 |
VariableResolver |
jakarta.faces.application.ApplicationWrapper.getVariableResolver
|
The
default behavior of this method is to call
Application#getVariableResolver on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:189 |
ViewHandler |
jakarta.faces.application.ApplicationWrapper.getViewHandler
|
The
default behavior of this method is to call Application#getViewHandler
on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:190 |
Application |
jakarta.faces.application.ApplicationWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:191 |
void |
jakarta.faces.application.ApplicationWrapper.publishEvent
( FacesContext ,
Class ,
Object ) |
The
default behavior of this method is to call
Application#publishEvent(jakarta.faces.context.FacesContext, Class,
Object) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:192 |
void |
jakarta.faces.application.ApplicationWrapper.publishEvent
( FacesContext ,
Class ,
Class ,
Object ) |
The
default behavior of this method is to call
Application#publishEvent(jakarta.faces.context.FacesContext, Class,
Class, Object) on the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:193 |
void |
jakarta.faces.application.ApplicationWrapper.removeELContextListener
( ELContextListener ) |
The
default behavior of this method is to call
Application#removeELContextListener(jakarta.el.ELContextListener) on the
wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:194 |
void |
jakarta.faces.application.ApplicationWrapper.setActionListener
( ActionListener ) |
The
default behavior of this method is to call
Application#setActionListener(jakarta.faces.event.ActionListener) on the
wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:195 |
void |
jakarta.faces.application.ApplicationWrapper.setDefaultLocale
( Locale ) |
The
default behavior of this method is to call
Application#setDefaultLocale(java.util.Locale) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:196 |
void |
jakarta.faces.application.ApplicationWrapper.setDefaultRenderKitId
( String ) |
The
default behavior of this method is to call
Application#setDefaultRenderKitId(String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:197 |
void |
jakarta.faces.application.ApplicationWrapper.setMessageBundle
( String ) |
The
default behavior of this method is to call
Application#setMessageBundle(String) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:198 |
void |
jakarta.faces.application.ApplicationWrapper.setNavigationHandler
( NavigationHandler ) |
The
default behavior of this method is to call
Application#setNavigationHandler(NavigationHandler) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:199 |
void |
jakarta.faces.application.ApplicationWrapper.setPropertyResolver
( PropertyResolver ) |
The
default behavior of this method is to call
Application#setPropertyResolver(jakarta.faces.el.PropertyResolver) on
the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:200 |
void |
jakarta.faces.application.ApplicationWrapper.setResourceHandler
( ResourceHandler ) |
The
default behavior of this method is to call
Application#setResourceHandler(ResourceHandler) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:201 |
void |
jakarta.faces.application.ApplicationWrapper.setStateManager
( StateManager ) |
The
default behavior of this method is to call
Application#setStateManager(StateManager) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:202 |
void |
jakarta.faces.application.ApplicationWrapper.setSupportedLocales
( Collection ) |
The
default behavior of this method is to call
Application#setSupportedLocales(java.util.Collection) on the wrapped
Application object. |
true |
|
true |
| JSF:JAVADOC:203 |
void |
jakarta.faces.application.ApplicationWrapper.setVariableResolver
( VariableResolver ) |
The
default behavior of this method is to call
Application#setVariableResolver(jakarta.faces.el.VariableResolver) on
the wrapped Application object. |
true |
|
true |
| JSF:JAVADOC:204 |
void |
jakarta.faces.application.ApplicationWrapper.setViewHandler
( ViewHandler ) |
The
default behavior of this method is to call
Application#setViewHandler(ViewHandler) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:205 |
void |
jakarta.faces.application.ApplicationWrapper.subscribeToEvent
( Class ,
Class ,
SystemEventListener ) |
The
default behavior of this method is to call
Application#subscribeToEvent(Class, Class,
jakarta.faces.event.SystemEventListener) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:206 |
void |
jakarta.faces.application.ApplicationWrapper.subscribeToEvent
( Class ,
SystemEventListener ) |
The
default behavior of this method is to call
Application#subscribeToEvent(Class,
jakarta.faces.event.SystemEventListener) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:207 |
void |
jakarta.faces.application.ApplicationWrapper.unsubscribeFromEvent
( Class ,
Class ,
SystemEventListener ) |
The
default behavior of this method is to call
Application#unsubscribeFromEvent(Class, Class,
jakarta.faces.event.SystemEventListener) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:208 |
void |
jakarta.faces.application.ApplicationWrapper.unsubscribeFromEvent
( Class ,
SystemEventListener ) |
The
default behavior of this method is to call
Application#unsubscribeFromEvent(Class,
jakarta.faces.event.SystemEventListener) on the wrapped Application
object. |
true |
|
true |
| JSF:JAVADOC:209 |
ConfigurableNavigationHandler |
jakarta.faces.application.ConfigurableNavigationHandler.ConfigurableNavigationHandler
|
|
true |
|
true |
| JSF:JAVADOC:210 |
NavigationCase |
jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCase
( FacesContext ,
String ,
String ) |
Return
the NavigationCase representing the navigation that would be taken had
NavigationHandler#handleNavigation been called with the same arguments
or null if there is no such case. |
true |
|
true |
| JSF:JAVADOC:211 |
NavigationCase |
jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCase
( FacesContext ,
String ,
String )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:212 |
Map |
jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCases
|
Return
a Map where the keys are values and the values are Set where each
element in the Set is a NavigationCase that applies to that . The
implementation must support live modifications to this Map. |
true |
|
true |
| JSF:JAVADOC:213 |
void |
jakarta.faces.application.ConfigurableNavigationHandler.performNavigation
( String ) |
A
convenience method to signal the Jakarta Server Faces implementation to
perform navigaton with the provided outcome. When the
NavigationHandler is invoked, the current viewId is treated as the
"from viewId" and the "from action" is null. |
true |
|
true |
| JSF:JAVADOC:214 |
void |
jakarta.faces.application.ConfigurableNavigationHandler.performNavigation
( String )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:215 |
FacesMessage |
jakarta.faces.application.FacesMessage.FacesMessage
|
Construct a new jakarta.faces.application.FacesMessage with no initial
values. The severity is set to Severity.INFO. |
true |
|
true |
| JSF:JAVADOC:216 |
FacesMessage |
jakarta.faces.application.FacesMessage.FacesMessage
( String ) |
Construct a new jakarta.faces.application.FacesMessage with just a
summary. The detail is null, the severity is set to Severity.INFO. |
true |
|
true |
| JSF:JAVADOC:217 |
FacesMessage |
jakarta.faces.application.FacesMessage.FacesMessage
( String ,
String ) |
Construct a new jakarta.faces.application.FacesMessage with the
specified initial values. The severity is set to Severity.INFO. |
true |
|
true |
| JSF:JAVADOC:218 |
FacesMessage |
jakarta.faces.application.FacesMessage.FacesMessage
( Severity ,
String ,
String ) |
Construct a new FacesMessage with the specified initial values. |
true |
|
true |
| JSF:JAVADOC:219 |
String |
jakarta.faces.application.FacesMessage.getDetail
|
Return
the localized detail text. If no localized detail text has been
defined for this message, return the localized summary text instead. |
true |
|
true |
| JSF:JAVADOC:220 |
Severity |
jakarta.faces.application.FacesMessage.getSeverity
|
Return
the severity level. |
true |
|
true |
| JSF:JAVADOC:221 |
String |
jakarta.faces.application.FacesMessage.getSummary
|
Return
the localized summary text. |
true |
|
true |
| JSF:JAVADOC:222 |
boolean |
jakarta.faces.application.FacesMessage.isRendered
|
|
true |
|
true |
| JSF:JAVADOC:223 |
void |
jakarta.faces.application.FacesMessage.rendered
|
Marks
this message as having been rendered to the client. |
true |
|
true |
| JSF:JAVADOC:224 |
void |
jakarta.faces.application.FacesMessage.setDetail
( String ) |
Set the
localized detail text. |
true |
|
true |
| JSF:JAVADOC:225 |
void |
jakarta.faces.application.FacesMessage.setSeverity
( Severity ) |
Set the
severity level. |
true |
|
true |
| JSF:JAVADOC:226 |
void |
jakarta.faces.application.FacesMessage.setSeverity
( Severity )
throws IllegalArgumentException
|
if the
specified severity level is not one of the supported values |
true |
|
true |
| JSF:JAVADOC:227 |
void |
jakarta.faces.application.FacesMessage.setSummary
( String ) |
Set the
localized summary text. |
true |
|
true |
| JSF:JAVADOC:228 |
int |
jakarta.faces.application.FacesMessage.Severity.compareTo
( Object ) |
Compare
this jakarta.faces.application.FacesMessage.Severity instance to the
specified one. Returns a negative integer, zero, or a positive integer
if this object is less than, equal to, or greater than the specified
object. |
true |
|
true |
| JSF:JAVADOC:229 |
int |
jakarta.faces.application.FacesMessage.Severity.getOrdinal
|
Return
the ordinal value of this FacesMessage.Severity instance. |
true |
|
true |
| JSF:JAVADOC:230 |
String |
jakarta.faces.application.FacesMessage.Severity.toString
|
Return
a String representation of this FacesMessage.Severity instance. |
true |
|
true |
| JSF:JAVADOC:231 |
boolean |
jakarta.faces.application.NavigationCase.equals
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:232 |
URL |
jakarta.faces.application.NavigationCase.getActionURL
( FacesContext ) |
Construct an absolute URL to this NavigationCase instance using
jakarta.faces.application.ViewHandler#getActionURL on the path portion
of the url. |
true |
|
true |
| JSF:JAVADOC:233 |
URL |
jakarta.faces.application.NavigationCase.getActionURL
( FacesContext )
throws MalformedURLException
|
if the
process of constructing the URL causes this exception to be thrown. |
true |
|
true |
| JSF:JAVADOC:234 |
URL |
jakarta.faces.application.NavigationCase.getBookmarkableURL
( FacesContext ) |
Construct an absolute URL suitable for a bookmarkable link to this
NavigationCase instance using
jakarta.faces.application.ViewHandler#getBookmarkableURL on the path
portion of the url. This URL may include view parameters specified as
metadata within the view. |
true |
|
true |
| JSF:JAVADOC:235 |
URL |
jakarta.faces.application.NavigationCase.getBookmarkableURL
( FacesContext )
throws MalformedURLException
|
if the
process of constructing the URL causes this exception to be thrown. |
true |
|
true |
| JSF:JAVADOC:236 |
Boolean |
jakarta.faces.application.NavigationCase.getCondition
( FacesContext ) |
Evaluates the for this , if any. The expression to be evaluated is
passed into the constructor as a string. When the expression is
evaluated, its value must be coerced into a boolean per the normail EL
coercion rules. |
true |
|
true |
| JSF:JAVADOC:237 |
Boolean |
jakarta.faces.application.NavigationCase.getCondition
( FacesContext )
throws any
|
exceptions
encountered during the process of evaluating the expression or
obtaining its value. |
true |
|
true |
| JSF:JAVADOC:238 |
String |
jakarta.faces.application.NavigationCase.getFromAction
|
Return
the for this |
true |
|
true |
| JSF:JAVADOC:239 |
String |
jakarta.faces.application.NavigationCase.getFromOutcome
|
Return
the for this |
true |
|
true |
| JSF:JAVADOC:240 |
String |
jakarta.faces.application.NavigationCase.getFromViewId
|
Return
the of the inside which this is nested. |
true |
|
true |
| JSF:JAVADOC:241 |
Map |
jakarta.faces.application.NavigationCase.getParameters
|
Return
the parameters to be included for navigation cases requiring a
redirect. If no parameters are defined, null will be returned. The
keys in the Map are parameter names. For each key, the corresponding
value is a List of unconverted values. |
true |
|
true |
| JSF:JAVADOC:242 |
URL |
jakarta.faces.application.NavigationCase.getRedirectURL
( FacesContext ) |
Construct an absolute URL suitable for a "redirect" to this
NavigationCase instance using
jakarta.faces.application.ViewHandler#getRedirectURL on the path portion
of the url. |
true |
|
true |
| JSF:JAVADOC:243 |
URL |
jakarta.faces.application.NavigationCase.getRedirectURL
( FacesContext )
throws MalformedURLException
|
if the
process of constructing the URL causes this exception to be thrown. |
true |
|
true |
| JSF:JAVADOC:244 |
URL |
jakarta.faces.application.NavigationCase.getResourceURL
( FacesContext ) |
Construct an absolute URL to this NavigationCase instance using
jakarta.faces.application.ViewHandler#getResourceURL on the path portion
of the url. |
true |
|
true |
| JSF:JAVADOC:245 |
URL |
jakarta.faces.application.NavigationCase.getResourceURL
( FacesContext )
throws MalformedURLException
|
if the
process of constructing the URL causes this exception to be thrown. |
true |
|
true |
| JSF:JAVADOC:246 |
String |
jakarta.faces.application.NavigationCase.getToViewId
( FacesContext ) |
Evaluates the for this |
true |
|
true |
| JSF:JAVADOC:247 |
boolean |
jakarta.faces.application.NavigationCase.hasCondition
|
Test if
this navigation case has an associated element. |
true |
|
true |
| JSF:JAVADOC:248 |
int |
jakarta.faces.application.NavigationCase.hashCode
|
|
true |
|
true |
| JSF:JAVADOC:249 |
boolean |
jakarta.faces.application.NavigationCase.isIncludeViewParams
|
Return
the value for this . This will be true if the view parametets should
be encoded into the redirect URL (only applies to redirect case) |
true |
|
true |
| JSF:JAVADOC:250 |
boolean |
jakarta.faces.application.NavigationCase.isRedirect
|
Return
the value for this . This will be true if the new view should be
navigated to via a
jakarta.faces.context.ExternalContext#redirect(String) |
true |
|
true |
| JSF:JAVADOC:251 |
NavigationCase |
jakarta.faces.application.NavigationCase.NavigationCase
( String ,
String ,
String ,
String ,
String ,
Map ,
boolean ,
boolean ) |
Construct a new NavigationCase based on the provided arguments. See
section JSF.7.4.2 for how a NavigationCase is used by the standard
ConfigurableNavigationHandler |
true |
|
true |
| JSF:JAVADOC:252 |
String |
jakarta.faces.application.NavigationCase.toString
|
|
true |
|
true |
| JSF:JAVADOC:253 |
void |
jakarta.faces.application.NavigationHandler.handleNavigation
( FacesContext ,
String ,
String ) |
Perform
navigation processing based on the state information in the specified
FacesContext, plus the outcome string returned by an executed
application action. If the implementation class also extends
ConfigurableNavigationHandler, the implementation must guarantee that
the logic used in a call to
ConfigurableNavigationHandler#getNavigationCase is used in this method
to determine the correct navigation. This method must set the render
targets (used in partial rendering) to render all invoking
jakarta.faces.context.PartialViewContext#setRenderAll) if the view
identifier has changed as the result of an application action (to take
into account Ajax requests). |
true |
|
false |
| JSF:JAVADOC:254 |
void |
jakarta.faces.application.NavigationHandler.handleNavigation
( FacesContext ,
String ,
String )
throws NullPointerException
|
if
context is null |
true |
|
false |
| JSF:JAVADOC:255 |
NavigationHandler |
jakarta.faces.application.NavigationHandler.NavigationHandler
|
|
true |
|
false |
| JSF:JAVADOC:256 |
ProjectStage |
jakarta.faces.application.ProjectStage.valueOf
( String ) |
|
true |
|
true |
| JSF:JAVADOC:257 |
ProjectStage[] |
jakarta.faces.application.ProjectStage.values
|
|
true |
|
true |
| JSF:JAVADOC:258 |
String |
jakarta.faces.application.Resource.getContentType
|
Return
the MIME content-type for this resource. |
true |
|
true |
| JSF:JAVADOC:259 |
InputStream |
jakarta.faces.application.Resource.getInputStream
|
If the
current request is a resource request, (that is,
ResourceHandler#isResourceRequest returns true), return an InputStream
containing the bytes of the resource. Otherwise, throw an IOException.
|
true |
|
true |
| JSF:JAVADOC:260 |
InputStream |
jakarta.faces.application.Resource.getInputStream
throws IOException
|
if the
current request is not a resource request. |
true |
|
true |
| JSF:JAVADOC:261 |
String |
jakarta.faces.application.Resource.getLibraryName
|
Return
the libraryName for this resource. May be null. The libraryName for a
resource is an optional String that indicates membership in a
"resource library". All resources with the same libraryName belong to
the same "resource library". The "resource library" concept allows
disambiguating resources that have the same resourceName. See
ResourceHandler for more information. |
true |
|
true |
| JSF:JAVADOC:262 |
String |
jakarta.faces.application.Resource.getRequestPath
|
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 implementation
must implement the following algorithm. For discussion, the return
result from this method will be called result. Get the context-root
for this web application, not ending in slash. For discussion this
will be caled contextRoot. Discover if the FacesServlet is prefix or
extension mapped, and the value of the mapping (including the leading
'.' in the case of extension mapping). For discussion, this will be
facesServletMapping. If prefix mapped, result must be result =
contextRoot + '/' + facesServletMapping +
ResourceHandler#RESOURCE_IDENTIFIER + '/' + #getResourceName If
extension mapped, result must be result = contextRoot +
ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName +
facesServletMapping If #getLibraryName returns non-null, build up a
string, called resourceMetaData for discussion, as follows:
resourceMetaData = "?ln=" + #getLibraryName Append resourceMetaData to
result. Make it portlet safe by passing the result through
ViewHandler#getResourceURL. |
true |
|
true |
| JSF:JAVADOC:263 |
String |
jakarta.faces.application.Resource.getResourceName
|
Return
the resourceName for this resource. Will never be null. All Resource
instances must have a resourceName. |
true |
|
true |
| JSF:JAVADOC:264 |
Map |
jakarta.faces.application.Resource.getResponseHeaders
|
Returns
a mutable Map whose entries will be sent as response headers during
ResourceHandler#handleResourceRequest. The entries in this map must
not persist beyond the scope of a single request. Any modifications
made to the map after the resource has been served will be ignored by
the run-time. |
true |
|
true |
| JSF:JAVADOC:265 |
URL |
jakarta.faces.application.Resource.getURL
|
Return
an actual URL instance that refers to this resource instance. |
true |
|
true |
| JSF:JAVADOC:266 |
Resource |
jakarta.faces.application.Resource.Resource
|
|
true |
|
true |
| JSF:JAVADOC:267 |
void |
jakarta.faces.application.Resource.setContentType
( String ) |
Set the
MIME content-type for this resource. The default implementation
performs no validation on the argument. |
true |
|
true |
| JSF:JAVADOC:268 |
void |
jakarta.faces.application.Resource.setLibraryName
( String ) |
Set the
libraryName for this resource. |
true |
|
true |
| JSF:JAVADOC:269 |
void |
jakarta.faces.application.Resource.setResourceName
( String ) |
Set the
resourceName for this resource. |
true |
|
true |
| JSF:JAVADOC:270 |
void |
jakarta.faces.application.Resource.setResourceName
( String )
throws NullPointerException
|
if
argument resourceName is null. |
true |
|
true |
| JSF:JAVADOC:271 |
String |
jakarta.faces.application.Resource.toString
|
Call
through to #getRequestPath and return the result. |
true |
|
true |
| JSF:JAVADOC:272 |
boolean |
jakarta.faces.application.Resource.userAgentNeedsUpdate
( FacesContext ) |
Return
true if the user-agent requesting this resource needs an update.
Returns false otherwise. |
true |
|
true |
| JSF:JAVADOC:273 |
ResourceDependency[] |
jakarta.faces.application.ResourceDependencies.value
|
|
true |
|
true |
| JSF:JAVADOC:274 |
String |
jakarta.faces.application.ResourceDependency.library
|
The
libraryName in which the resource pointed to by this
ResourceDependency resides. If not specified, defaults to the empty
string. It is valid to have EL Expressions in the value of this
attribute, as long as the expression resolves to an instance of the
expected type. |
true |
|
true |
| JSF:JAVADOC:275 |
String |
jakarta.faces.application.ResourceDependency.name
|
The
resourceName of the resource pointed to by this ResourceDependency. It
is valid to have EL Expressions in the value of this attribute, as
long as the expression resolves to an instance of the expected type. |
true |
|
true |
| JSF:JAVADOC:276 |
String |
jakarta.faces.application.ResourceDependency.target
|
The
value given for this attribute will be passed as the "target" argument
to
jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext,
jakarta.faces.component.UIComponent, java.lang.String). If this
attribute is specified,
jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent)
must be called instead, as described above. It is valid to have EL
Expressions in the value of this attribute, as long as the expression
resolves to an instance of the expected type. |
true |
|
true |
| JSF:JAVADOC:277 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String ) |
Create
an instance of Resource given the argument resourceName. The
content-type of the resource is derived by passing the resourceName to
jakarta.faces.context.ExternalContext#getMimeType The algorithm
specified in section JSF.2.6.1.4 of the spec prose document linked in
the overview summary must be executed to create the Resource |
true |
|
true |
| JSF:JAVADOC:278 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String )
throws NullPointerException
|
if
resourceName is null. |
true |
|
true |
| JSF:JAVADOC:279 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String ,
String ) |
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. The content-type of the resource is derived by
passing the resourceName to
jakarta.faces.context.ExternalContext#getMimeType. The algorithm
specified in section JSF.2.6.1.4 of the spec prose document linked in
the overview summary must be executed to create the Resource |
true |
|
true |
| JSF:JAVADOC:280 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String ,
String )
throws <code>NullPointerException</code>
|
if
resourceName is null |
true |
|
true |
| JSF:JAVADOC:281 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String ,
String ,
String ) |
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 algorithm specified in section JSF.2.6.1.4
of the spec prose document linked in the overview summary must be
executed to create the Resource |
true |
|
true |
| JSF:JAVADOC:282 |
Resource |
jakarta.faces.application.ResourceHandler.createResource
( String ,
String ,
String )
throws <code>NullPointerException</code>
|
if
resourceName is null. |
true |
|
true |
| JSF:JAVADOC:283 |
String |
jakarta.faces.application.ResourceHandler.getRendererTypeForResourceName
( String ) |
Return
the renderer-type for a jakarta.faces.render.Renderer that is capable of
rendering this resource. The default implementation must return values
according to the following table. If no renderer-type can be
determined, null must be returned. example resource name renderer-type
mycomponent.js jakarta.faces.resource.Script mystyle.css
jakarta.faces.resource.Stylesheet |
true |
|
true |
| JSF:JAVADOC:284 |
void |
jakarta.faces.application.ResourceHandler.handleResourceRequest
( FacesContext ) |
This
method specifies the contract for satisfying resource requests. This
method is called from jakarta.faces.webapp.FacesServlet#service after
that method determines the current request is a resource request by
calling #isResourceRequest. Thus, handleResourceRequest may assume
that the current request is a resource request. The default
implementation must implement an algorithm semantically identical to
the following algorithm. For discussion, in all cases when a status
code is to be set, this spec talks only using the Servlet API, but it
is understood that in a portlet environment the appropriate equivalent
API must be used. If the resourceIdentifier ends with any of the
extensions listed in the value of the #RESOURCE_EXCLUDES_PARAM_NAME
init parameter, HttpServletRequest.SC_NOT_FOUND must be passed to
HttpServletResponse.setStatus(), then handleResourceRequest must
immediately return. Extract the resourceName from the
resourceIdentifier by taking the substring of resourceIdentifier that
starts at #RESOURCE_IDENTIFIER.length() + 1 and goes to the end of
resourceIdentifier. If no resourceName can be extracted,
HttpServletRequest.SC_NOT_FOUND must be passed to
HttpServletResponse.setStatus(), then handleResourceRequest must
immediately return. Extract the libraryName from the request by
looking in the request parameter map for an entry under the key "ln",
without the quotes. If found, use its value as the libraryName. If
resourceName and libraryName are present, call #createResource(String,
String) to create the Resource. If only resourceName is present, call
#createResource(String) to create the Resource. If the Resource cannot
be successfully created, HttpServletRequest.SC_NOT_FOUND must be
passed to HttpServletResponse.setStatus(), then handleResourceRequest
must immediately return. Call Resource#userAgentNeedsUpdate. If this
method returns false, HttpServletRequest.SC_NOT_MODIFIED must be
passed to HttpServletResponse.setStatus(), then handleResourceRequest
must immediately return. Pass the result of Resource#getContentType to
HttpServletResponse.setContentType. Call Resource#getResponseHeaders.
For each entry in this Map, call HttpServletResponse.setHeader(),
passing the key as the first argument and the value as the second
argument. Call Resource#getInputStream and serve up the bytes of the
resource to the response. Call HttpServletResponse.setContentLength()
passing the byte count of the resource. If an IOException is thrown
during any of the previous steps, log a descriptive, localized
message, including the resourceName and libraryName (if present).
Then, HttpServletRequest.SC_NOT_FOUND must be passed to
HttpServletResponse.setStatus(), then handleResourceRequest must
immediately return. In all cases in this method, any streams,
channels, sockets, or any other IO resources must be closed before
this method returns. |
true |
|
true |
| JSF:JAVADOC:285 |
void |
jakarta.faces.application.ResourceHandler.handleResourceRequest
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:286 |
boolean |
jakarta.faces.application.ResourceHandler.isResourceRequest
( FacesContext ) |
Return
true if the current request is a resource request. This method is
called by jakarta.faces.webapp.FacesServlet#service to determine if this
request is a view request or a resource request. |
true |
|
true |
| JSF:JAVADOC:287 |
boolean |
jakarta.faces.application.ResourceHandler.libraryExists
( String ) |
Return
true if the resource library named by the argument libraryName can be
found. |
true |
|
true |
| JSF:JAVADOC:288 |
ResourceHandler |
jakarta.faces.application.ResourceHandler.ResourceHandler
|
|
true |
|
true |
| JSF:JAVADOC:289 |
Resource |
jakarta.faces.application.ResourceHandlerWrapper.createResource
( String ) |
The
default behavior of this method is to call
ResourceHandler#createResource(String) on the wrapped ResourceHandler
object. |
true |
|
true |
| JSF:JAVADOC:290 |
Resource |
jakarta.faces.application.ResourceHandlerWrapper.createResource
( String ,
String ) |
The
default behavior of this method is to call
ResourceHandler#createResource(String, String) on the wrapped
ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:291 |
Resource |
jakarta.faces.application.ResourceHandlerWrapper.createResource
( String ,
String ,
String ) |
The
default behavior of this method is to call
ResourceHandler#createResource(String, String, String) on the wrapped
ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:292 |
String |
jakarta.faces.application.ResourceHandlerWrapper.getRendererTypeForResourceName
( String ) |
The
default behavior of this method is to call
ResourceHandler#getRendererTypeForResourceName(String) on the wrapped
ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:293 |
ResourceHandler |
jakarta.faces.application.ResourceHandlerWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:294 |
void |
jakarta.faces.application.ResourceHandlerWrapper.handleResourceRequest
( FacesContext ) |
The
default behavior of this method is to call
ResourceHandler#handleResourceRequest(jakarta.faces.context.FacesContext)
on the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:295 |
void |
jakarta.faces.application.ResourceHandlerWrapper.handleResourceRequest
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:296 |
boolean |
jakarta.faces.application.ResourceHandlerWrapper.isResourceRequest
( FacesContext ) |
The
default behavior of this method is to call
ResourceHandler#isResourceRequest(jakarta.faces.context.FacesContext) on
the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:297 |
boolean |
jakarta.faces.application.ResourceHandlerWrapper.libraryExists
( String ) |
The
default behavior of this method is to call
ResourceHandler#libraryExists(String) on the wrapped ResourceHandler
object. |
true |
|
true |
| JSF:JAVADOC:298 |
ResourceHandlerWrapper |
jakarta.faces.application.ResourceHandlerWrapper.ResourceHandlerWrapper
|
|
true |
|
true |
| JSF:JAVADOC:299 |
InputStream |
jakarta.faces.application.ResourceWrapper.getInputStream
|
The
default behavior of this method is to call Resource#getInputStream on
the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:300 |
InputStream |
jakarta.faces.application.ResourceWrapper.getInputStream
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:301 |
String |
jakarta.faces.application.ResourceWrapper.getRequestPath
|
The
default behavior of this method is to call Resource#getRequestPath on
the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:302 |
Map |
jakarta.faces.application.ResourceWrapper.getResponseHeaders
|
The
default behavior of this method is to call Resource#getResponseHeaders
on the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:303 |
URL |
jakarta.faces.application.ResourceWrapper.getURL
|
The
default behavior of this method is to call Resource#getURL on the
wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:304 |
Resource |
jakarta.faces.application.ResourceWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:305 |
ResourceWrapper |
jakarta.faces.application.ResourceWrapper.ResourceWrapper
|
|
true |
|
true |
| JSF:JAVADOC:306 |
boolean |
jakarta.faces.application.ResourceWrapper.userAgentNeedsUpdate
( FacesContext ) |
The
default behavior of this method is to call
Resource#userAgentNeedsUpdate on the wrapped ResourceHandler object. |
true |
|
true |
| JSF:JAVADOC:307 |
String |
jakarta.faces.application.StateManager.getViewState
( FacesContext ) |
Convenience method to return the view state as a String with no
RenderKit specific markup. This default implementation of this method
will call #saveView(jakarta.faces.context.FacesContext) and passing the
result to and returning the resulting value from
ResponseStateManager#getViewState(jakarta.faces.context.FacesContext,
Object). |
true |
|
true |
| JSF:JAVADOC:308 |
boolean |
jakarta.faces.application.StateManager.isSavingStateInClient
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:309 |
boolean |
jakarta.faces.application.StateManager.isSavingStateInClient
( FacesContext )
throws NullPointerException
|
if
context is null. |
true |
|
true |
| JSF:JAVADOC:310 |
UIViewRoot |
jakarta.faces.application.StateManager.restoreView
( FacesContext ,
String ,
String ) |
Restore
the tree structure and the component state of the view for the
specified viewId, in an implementation dependent manner, and return
the restored UIViewRoot. If there is no saved state information
available for this viewId, return null instead. This method must
consult the context initialization parameter named by the symbolic
constant StateManager.STATE_SAVING_METHOD_PARAM_NAME to determine
whether state should be saved on the client or the server. If not
present, client side state saving is assumed. If the init parameter
indicates that client side state saving should be used, this method
must call the getTreeStructureToRestore() and (if the previous method
call returned a non-null value) getComponentStateToRestore() methods
of the ResponseStateManager instance provided by the RenderKit
responsible for this view. |
true |
|
false |
| JSF:JAVADOC:311 |
UIViewRoot |
jakarta.faces.application.StateManager.restoreView
( FacesContext ,
String ,
String )
throws IllegalArgumentException
|
if
renderKitId is null. |
true |
|
true |
| JSF:JAVADOC:312 |
SerializedView |
jakarta.faces.application.StateManager.saveSerializedView
( FacesContext ) |
Return
the tree structure and component state information for the view
contained in the specified FacesContext instance as an object of type
StateManager.SerializedView. If there is no state information to be
saved, return null instead. Components may opt out of being included
in the serialized view by setting their transient property to true.
This must cause the component itself, as well as all of that
component's children and facets, to be omitted from the saved tree
structure and component state information. This method must also
enforce the rule that, for components with non-null ids, all
components that are descendants of the same nearest NamingContainer
must have unique identifiers. |
true |
true |
true |
| JSF:JAVADOC:313 |
SerializedView |
jakarta.faces.application.StateManager.saveSerializedView
( FacesContext )
throws IllegalStateException
|
if more
than one component or facet within the same NamingContainer in this
view has the same non-null component id |
true |
true |
true |
| JSF:JAVADOC:314 |
Object |
jakarta.faces.application.StateManager.saveView
( FacesContext ) |
Return
an opaque Object containing sufficient information for this same
instance to restore the state of the current UIViewRoot on a
subsequent request. The returned object must implement
java.io.Serializable. If there is no state information to be saved,
return null instead. Components may opt out of being included in the
serialized view by setting their transient property to true. This must
cause the component itself, as well as all of that component's
children and facets, to be omitted from the saved tree structure and
component state information. This method must also enforce the rule
that, for components with non-null ids, all components that are
descendants of the same nearest NamingContainer must have unique
identifiers. For backwards compatability with existing StateManager
implementations, the default implementation of this method calls
#saveSerializedView and creates and returns a two element Object array
with element zero containing the structure property and element one
containing the state property of the SerializedView. |
true |
|
true |
| JSF:JAVADOC:315 |
Object |
jakarta.faces.application.StateManager.saveView
( FacesContext )
throws IllegalStateException
|
if more
than one component or facet within the same NamingContainer in this
view has the same non-null component id |
true |
|
true |
| JSF:JAVADOC:316 |
StateManager |
jakarta.faces.application.StateManager.StateManager
|
|
true |
|
true |
| JSF:JAVADOC:317 |
void |
jakarta.faces.application.StateManager.writeState
( FacesContext ,
Object ) |
Save
the state represented in the specified state Object instance, in an
implementation dependent manner. This method will typically simply
delegate the actual writing to the writeState() method of the
ResponseStateManager instance provided by the RenderKit being used to
render this view. This method assumes that the caller has positioned
the ResponseWriter at the correct position for the saved state to be
written. For backwards compatability with existing StateManager
implementations, the default implementation of this method checks if
the argument is an instance of Object [] of length greater than or
equal to two. If so, it creates a SerializedView instance with the
tree structure coming from element zero and the component state coming
from element one and calls through to
#writeState(jakarta.faces.context.FacesContext,jakarta.faces.application.StateManager.SerializedView).
If not, does nothing. |
true |
|
false |
| JSF:JAVADOC:318 |
void |
jakarta.faces.application.StateManager.writeState
( FacesContext ,
Object )
throws IOException
|
|
true |
|
false |
| JSF:JAVADOC:319 |
void |
jakarta.faces.application.StateManager.writeState
( FacesContext ,
SerializedView ) |
Save
the state represented in the specified SerializedView isntance, in an
implementation dependent manner. This method must consult the context
initialization parameter named by the symbolic constant
StateManager.STATE_SAVING_METHOD_PARAM_NAME to determine whether state
should be saved on the client or the server. If not present, client
side state saving is assumed. If the init parameter indicates that
client side state saving should be used, this method must delegate the
actual writing to the writeState() method of the ResponseStateManager
instance provided by the RenderKit being used to render this view.
This method assumes that the caller has positioned the ResponseWriter
at the correct position for the saved state to be written. |
true |
true |
false |
| JSF:JAVADOC:320 |
void |
jakarta.faces.application.StateManager.writeState
( FacesContext ,
SerializedView )
throws IOException
|
|
true |
true |
false |
| JSF:JAVADOC:321 |
Object |
jakarta.faces.application.StateManager.SerializedView.getState
|
|
true |
true |
true |
| JSF:JAVADOC:322 |
Object |
jakarta.faces.application.StateManager.SerializedView.getStructure
|
|
true |
true |
true |
| JSF:JAVADOC:323 |
SerializedView |
jakarta.faces.application.StateManager.SerializedView.StateManager.SerializedView
( Object ,
Object ) |
|
true |
true |
true |
| JSF:JAVADOC:324 |
String |
jakarta.faces.application.StateManagerWrapper.getViewState
( FacesContext ) |
The
default behavior of this method is to call
StateManager#getViewState(jakarta.faces.context.FacesContext) on the
wrapped StateManager object. |
true |
|
true |
| JSF:JAVADOC:325 |
StateManager |
jakarta.faces.application.StateManagerWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:326 |
boolean |
jakarta.faces.application.StateManagerWrapper.isSavingStateInClient
( FacesContext ) |
The
default behavior of this method is to call
StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext)
on the wrapped StateManager object. |
true |
|
true |
| JSF:JAVADOC:327 |
UIViewRoot |
jakarta.faces.application.StateManagerWrapper.restoreView
( FacesContext ,
String ,
String ) |
The
default behavior of this method is to call
StateManager#restoreView(jakarta.faces.context.FacesContext, String,
String) on the wrapped StateManager object. |
true |
|
true |
| JSF:JAVADOC:328 |
SerializedView |
jakarta.faces.application.StateManagerWrapper.saveSerializedView
( FacesContext ) |
The
default behavior of this method is to call
StateManager#saveSerializedView(jakarta.faces.context.FacesContext) on
the wrapped StateManager object. |
true |
|
true |
| JSF:JAVADOC:329 |
Object |
jakarta.faces.application.StateManagerWrapper.saveView
( FacesContext ) |
The
default behavior of this method is to call
StateManager#saveView(jakarta.faces.context.FacesContext) on the wrapped
StateManager object. |
true |
|
true |
| JSF:JAVADOC:330 |
StateManagerWrapper |
jakarta.faces.application.StateManagerWrapper.StateManagerWrapper
|
|
true |
|
true |
| JSF:JAVADOC:331 |
void |
jakarta.faces.application.StateManagerWrapper.writeState
( FacesContext ,
Object ) |
The
default behavior of this method is to call
StateManager#writeState(jakarta.faces.context.FacesContext,
java.lang.Object) on the wrapped StateManager object. |
true |
|
true |
| JSF:JAVADOC:332 |
void |
jakarta.faces.application.StateManagerWrapper.writeState
( FacesContext ,
Object )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:333 |
void |
jakarta.faces.application.StateManagerWrapper.writeState
( FacesContext ,
SerializedView ) |
The
default behavior of this method is to call
StateManager#writeState(jakarta.faces.context.FacesContext,
jakarta.faces.application.StateManager.SerializedView) on the wrapped
StateManager object. |
true |
|
true |
| JSF:JAVADOC:334 |
void |
jakarta.faces.application.StateManagerWrapper.writeState
( FacesContext ,
SerializedView )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:335 |
String |
jakarta.faces.application.ViewExpiredException.getMessage
|
Return
the message for this exception prepended with the view identifier if
the view identifier is not null, otherwise, return the message. |
true |
|
true |
| JSF:JAVADOC:336 |
String |
jakarta.faces.application.ViewExpiredException.getViewId
|
Return
the view identifier of this exception, or null if the view identifier
is nonexistent or unknown. |
true |
|
true |
| JSF:JAVADOC:337 |
ViewExpiredException |
jakarta.faces.application.ViewExpiredException.ViewExpiredException
|
Construct a new exception with no detail message or root cause. |
true |
|
true |
| JSF:JAVADOC:338 |
ViewExpiredException |
jakarta.faces.application.ViewExpiredException.ViewExpiredException
( String ) |
Construct a new exception with the specified view identifier. |
true |
|
true |
| JSF:JAVADOC:339 |
ViewExpiredException |
jakarta.faces.application.ViewExpiredException.ViewExpiredException
( String ,
String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
|
true |
| JSF:JAVADOC:340 |
ViewExpiredException |
jakarta.faces.application.ViewExpiredException.ViewExpiredException
( Throwable ,
String ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
|
true |
| JSF:JAVADOC:341 |
ViewExpiredException |
jakarta.faces.application.ViewExpiredException.ViewExpiredException
( String ,
Throwable ,
String ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:342 |
String |
jakarta.faces.application.ViewHandler.calculateCharacterEncoding
( FacesContext ) |
Returns
the correct character encoding to be used for this request. The
following algorithm is employed. Examine the Content-Type request
header. If it has a charset parameter, extract it and return that as
the encoding. If no charset parameter was found, check for the
existence of a session by calling ExternalContext#getSession(boolean)
passing false as the argument. If that method returns true, get the
session Map by calling ExternalContext#getSessionMap and look for a
value under the key given by the value of the symbolic constant
ViewHandler#CHARACTER_ENCODING_KEY. If present, return the value,
converted to String. Otherwise, return null |
true |
|
true |
| JSF:JAVADOC:343 |
Locale |
jakarta.faces.application.ViewHandler.calculateLocale
( FacesContext ) |
Returns
an appropriate Locale to use for this and subsequent requests for the
current client. |
true |
|
true |
| JSF:JAVADOC:344 |
Locale |
jakarta.faces.application.ViewHandler.calculateLocale
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:345 |
String |
jakarta.faces.application.ViewHandler.calculateRenderKitId
( FacesContext ) |
Return
an appropriate renderKitId for this and subsequent requests from the
current client. It is an error for this method to return null. The
default return value is
jakarta.faces.render.RenderKitFactory#HTML_BASIC_RENDER_KIT. |
true |
|
true |
| JSF:JAVADOC:346 |
String |
jakarta.faces.application.ViewHandler.calculateRenderKitId
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:347 |
UIViewRoot |
jakarta.faces.application.ViewHandler.createView
( FacesContext ,
String ) |
Create
and return a new UIViewRoot instance initialized with information from
the argument FacesContext and viewId. Locate the
ViewDeclarationLanguage implementation for the VDL used in the view.
The argument viewId must be converted to a physical viewId that can
refer to an actual resource suitable for use by the
ViewDeclarationLanguage ViewDeclarationLanguage#createView, which must
be called by this method. |
true |
|
true |
| JSF:JAVADOC:348 |
UIViewRoot |
jakarta.faces.application.ViewHandler.createView
( FacesContext ,
String )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:349 |
String |
jakarta.faces.application.ViewHandler.deriveViewId
( FacesContext ,
String ) |
Derive
and return the viewId from the current request, or the argument input
by following the algorithm defined in specification section JSF.7.5.2.
The default implementation of this method simply returns rawViewId
unchanged. |
true |
|
true |
| JSF:JAVADOC:350 |
String |
jakarta.faces.application.ViewHandler.getActionURL
( FacesContext ,
String ) |
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 JSF lifecycle. Please see section JSF.7.5.2
for the complete specification. |
true |
|
true |
| JSF:JAVADOC:351 |
String |
jakarta.faces.application.ViewHandler.getActionURL
( FacesContext ,
String )
throws IllegalArgumentException
|
if
viewId is not valid for this ViewHandler, or does not start with "/". |
true |
|
true |
| JSF:JAVADOC:352 |
String |
jakarta.faces.application.ViewHandler.getActionURL
( FacesContext ,
String )
throws NullPointerException
|
if
context or viewId is null. |
true |
|
true |
| JSF:JAVADOC:353 |
String |
jakarta.faces.application.ViewHandler.getBookmarkableURL
( FacesContext ,
String ,
Map ,
boolean ) |
Return
a JSF action URL derived from the viewId argument that is suitable to
be used as the target of a link in a JSF response. Compiliant
implementations must implement this method as specified in section
JSF.7.5.2. The default implementation simply calls through to
#getActionURL, passing the arguments context and viewId. |
true |
|
true |
| JSF:JAVADOC:354 |
String |
jakarta.faces.application.ViewHandler.getRedirectURL
( FacesContext ,
String ,
Map ,
boolean ) |
Return
a JSF 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. Compiliant implementations must
implement this method as specified in section JSF.7.5.2. The default
implementation simply calls through to #getActionURL, passing the
arguments context and viewId. |
true |
|
true |
| JSF:JAVADOC:355 |
String |
jakarta.faces.application.ViewHandler.getResourceURL
( FacesContext ,
String ) |
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. If the specified path starts with a slash,
it must be treated as context relative; otherwise, it must be treated
as relative to the action URL of the current view. |
true |
|
true |
| JSF:JAVADOC:356 |
String |
jakarta.faces.application.ViewHandler.getResourceURL
( FacesContext ,
String )
throws IllegalArgumentException
|
if
viewId is not valid for this ViewHandler. |
true |
|
true |
| JSF:JAVADOC:357 |
String |
jakarta.faces.application.ViewHandler.getResourceURL
( FacesContext ,
String )
throws NullPointerException
|
if
context or path is null. |
true |
|
true |
| JSF:JAVADOC:358 |
ViewDeclarationLanguage |
jakarta.faces.application.ViewHandler.getViewDeclarationLanguage
( FacesContext ,
String ) |
Return
the ViewDeclarationLanguage instance used for this ViewHandler
instance. The default implementation must use
jakarta.faces.view.ViewDeclarationLanguageFactory#getViewDeclarationLanguage
to obtain the appropriate ViewDeclarationLanguage implementation for
the argument viewId. Any exceptions thrown as a result of invoking
that method must not be swallowed. The default implementation of this
method returns null. |
true |
|
true |
| JSF:JAVADOC:359 |
void |
jakarta.faces.application.ViewHandler.initView
( FacesContext ) |
Initialize the view for the request processing lifecycle. This method
must be called at the beginning of the Restore View Phase of the
Request Processing Lifecycle. It is responsible for performing any
per-request initialization necessary to the operation of the
lifycecle. The default implementation must perform the following
actions. If ExternalContext#getRequestCharacterEncoding returns null,
call #calculateCharacterEncoding and pass the result, if non-null,
into the ExternalContext#setRequestCharacterEncoding method. If
ExternalContext#getRequestCharacterEncoding returns non-null take no
action. |
true |
|
true |
| JSF:JAVADOC:360 |
void |
jakarta.faces.application.ViewHandler.initView
( FacesContext )
throws FacesException
|
if a
problem occurs setting the encoding, such as the
UnsupportedEncodingException thrown by the underlying Servlet or
Portlet technology when the encoding is not supported. |
true |
|
true |
| JSF:JAVADOC:361 |
void |
jakarta.faces.application.ViewHandler.renderView
( FacesContext ,
UIViewRoot ) |
Perform
whatever actions are required to render the response view to the
response object associated with the current FacesContext. Otherwise,
the default implementation must obtain a reference to the
ViewDeclarationLanguage for the viewId of the argument viewToRender
and call its ViewDeclarationLanguage#renderView method, returning the
result and not swallowing any exceptions thrown by that method. |
true |
|
true |
| JSF:JAVADOC:362 |
void |
jakarta.faces.application.ViewHandler.renderView
( FacesContext ,
UIViewRoot )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:363 |
void |
jakarta.faces.application.ViewHandler.renderView
( FacesContext ,
UIViewRoot )
throws FacesException
|
if a
servlet error occurs |
true |
|
true |
| JSF:JAVADOC:364 |
void |
jakarta.faces.application.ViewHandler.renderView
( FacesContext ,
UIViewRoot )
throws NullPointerException
|
if
context or viewToRender is null |
true |
|
true |
| JSF:JAVADOC:365 |
UIViewRoot |
jakarta.faces.application.ViewHandler.restoreView
( FacesContext ,
String ) |
Perform
whatever actions are required to restore the view associated with the
specified FacesContext and viewId. It may delegate to the restoreView
of the associated StateManager to do the actual work of restoring the
view. If there is no available state for the specified viewId, return
null. Otherwise, the default implementation must obtain a reference to
the ViewDeclarationLanguage for this viewId and call its
ViewDeclarationLanguage#restoreView method, returning the result and
not swallowing any exceptions thrown by that method. |
true |
|
true |
| JSF:JAVADOC:366 |
UIViewRoot |
jakarta.faces.application.ViewHandler.restoreView
( FacesContext ,
String )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:367 |
UIViewRoot |
jakarta.faces.application.ViewHandler.restoreView
( FacesContext ,
String )
throws FacesException
|
if a
servlet error occurs |
true |
|
true |
| JSF:JAVADOC:368 |
ViewHandler |
jakarta.faces.application.ViewHandler.ViewHandler
|
|
true |
|
true |
| JSF:JAVADOC:369 |
void |
jakarta.faces.application.ViewHandler.writeState
( FacesContext ) |
Take
any appropriate action to either immediately write out the current
state information (by calling StateManager#writeState, or noting where
state information should later be written. This method must do nothing
if the current request is an Ajax request. When responding to Ajax
requests, the state is obtained by calling StateManager#getViewState
and then written into the Ajax response during final encoding
(jakarta.faces.component.UIViewRoot#encodeEnd. |
true |
|
true |
| JSF:JAVADOC:370 |
void |
jakarta.faces.application.ViewHandler.writeState
( FacesContext )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:371 |
void |
jakarta.faces.application.ViewHandler.writeState
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:372 |
String |
jakarta.faces.application.ViewHandlerWrapper.calculateCharacterEncoding
( FacesContext ) |
The
default behavior of this method is to call
ViewHandler#calculateCharacterEncoding(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:373 |
Locale |
jakarta.faces.application.ViewHandlerWrapper.calculateLocale
( FacesContext ) |
The
default behavior of this method is to call
ViewHandler#calculateLocale(jakarta.faces.context.FacesContext) on the
wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:374 |
String |
jakarta.faces.application.ViewHandlerWrapper.calculateRenderKitId
( FacesContext ) |
The
default behavior of this method is to call
ViewHandler#calculateRenderKitId(jakarta.faces.context.FacesContext) on
the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:375 |
UIViewRoot |
jakarta.faces.application.ViewHandlerWrapper.createView
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#createView(jakarta.faces.context.FacesContext, String) on
the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:376 |
String |
jakarta.faces.application.ViewHandlerWrapper.deriveViewId
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#deriveViewId(jakarta.faces.context.FacesContext, String) on
the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:377 |
String |
jakarta.faces.application.ViewHandlerWrapper.getActionURL
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#getActionURL(jakarta.faces.context.FacesContext, String) on
the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:378 |
String |
jakarta.faces.application.ViewHandlerWrapper.getBookmarkableURL
( FacesContext ,
String ,
Map ,
boolean ) |
The
default behavior of this method is to call
ViewHandler#getBookmarkableURL(jakarta.faces.context.FacesContext,
String, java.util.Map, boolean) on the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:379 |
String |
jakarta.faces.application.ViewHandlerWrapper.getRedirectURL
( FacesContext ,
String ,
Map ,
boolean ) |
The
default behavior of this method is to call
ViewHandler#getRedirectURL(jakarta.faces.context.FacesContext, String,
java.util.Map, boolean) on the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:380 |
String |
jakarta.faces.application.ViewHandlerWrapper.getResourceURL
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#getResourceURL(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:381 |
ViewDeclarationLanguage |
jakarta.faces.application.ViewHandlerWrapper.getViewDeclarationLanguage
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#getViewDeclarationLanguage on the wrapped ViewHandler
object. |
true |
|
true |
| JSF:JAVADOC:382 |
ViewHandler |
jakarta.faces.application.ViewHandlerWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:383 |
void |
jakarta.faces.application.ViewHandlerWrapper.initView
( FacesContext ) |
The
default behavior of this method is to call ViewHandler#initView on the
wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:384 |
void |
jakarta.faces.application.ViewHandlerWrapper.initView
( FacesContext )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:385 |
void |
jakarta.faces.application.ViewHandlerWrapper.renderView
( FacesContext ,
UIViewRoot ) |
The
default behavior of this method is to call
ViewHandler#renderView(jakarta.faces.context.FacesContext,
jakarta.faces.component.UIViewRoot) on the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:386 |
void |
jakarta.faces.application.ViewHandlerWrapper.renderView
( FacesContext ,
UIViewRoot )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:387 |
void |
jakarta.faces.application.ViewHandlerWrapper.renderView
( FacesContext ,
UIViewRoot )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:388 |
UIViewRoot |
jakarta.faces.application.ViewHandlerWrapper.restoreView
( FacesContext ,
String ) |
The
default behavior of this method is to call
ViewHandler#restoreView(jakarta.faces.context.FacesContext, String) on
the wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:389 |
ViewHandlerWrapper |
jakarta.faces.application.ViewHandlerWrapper.ViewHandlerWrapper
|
|
true |
|
true |
| JSF:JAVADOC:390 |
void |
jakarta.faces.application.ViewHandlerWrapper.writeState
( FacesContext ) |
The
default behavior of this method is to call
ViewHandler#writeState(jakarta.faces.context.FacesContext) on the
wrapped ViewHandler object. |
true |
|
true |
| JSF:JAVADOC:391 |
void |
jakarta.faces.application.ViewHandlerWrapper.writeState
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:392 |
void |
jakarta.faces.component.ActionSource.addActionListener
( ActionListener ) |
Add a
new ActionListener to the set of listeners interested in being
notified when ActionEvents occur. |
true |
|
true |
| JSF:JAVADOC:393 |
void |
jakarta.faces.component.ActionSource.addActionListener
( ActionListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:394 |
MethodBinding |
jakarta.faces.component.ActionSource.getAction
|
If the
implementing class also implements ActionSource2, the implementation
of this method must call through to ActionSource2#getActionExpression
and examine the result. If the result came from a previous call to
#setAction, extract the MethodBinding from it and return it.
Otherwise, wrap the returned jakarta.el.MethodExpression in a
MethodBinding implementation, and return it. If the implementing class
does not implement ActionSource2, return the MethodBindingpointing 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. |
true |
true |
true |
| JSF:JAVADOC:395 |
MethodBinding |
jakarta.faces.component.ActionSource.getActionListener
|
If
#setActionListener was not previously called for this instance, this
method must return null. If it was called, this method must return the
exact MethodBinding instance that was passed to #setActionListener.
The method to be invoked, if this UIComponent is activated by the
user, will be called during the Apply Request Values or Invoke
Application phase of the request processing lifecycle, depending upon
the value of the immediate property. |
true |
true |
true |
| JSF:JAVADOC:396 |
ActionListener[] |
jakarta.faces.component.ActionSource.getActionListeners
|
Return
the set of registered ActionListeners for this ActionSource instance.
If there are no registered listeners, a zero-length array is returned.
|
true |
|
true |
| JSF:JAVADOC:397 |
boolean |
jakarta.faces.component.ActionSource.isImmediate
|
Return
a flag indicating that the default 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.
The default value for this property must be false. |
true |
|
true |
| JSF:JAVADOC:398 |
void |
jakarta.faces.component.ActionSource.removeActionListener
( ActionListener ) |
Remove
an existing ActionListener (if any) from the set of listeners
interested in being notified when ActionEvents occur. |
true |
|
true |
| JSF:JAVADOC:399 |
void |
jakarta.faces.component.ActionSource.removeActionListener
( ActionListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:400 |
void |
jakarta.faces.component.ActionSource.setAction
( MethodBinding ) |
If the
implementing class also implements ActionSource2, the implementation
of this method must wrap the argument action in a class that
implements jakarta.el.MethodExpression and call through to
ActionSource2#setActionExpression, passing the wrapped action. If the
implementing class does not implement ActionSource2, set the
MethodBinding 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. Any method
referenced by such an expression must be public, with a return type of
String, and accept no parameters. |
true |
true |
true |
| JSF:JAVADOC:401 |
void |
jakarta.faces.component.ActionSource.setActionListener
( MethodBinding ) |
Wrap
the argument actionListener in an implementation of ActionListener and
store it in the internal data structure that backs the
#getActionListeners method, taking care to over-write any instance
that was stored by a previous call to setActionListener. Any method
referenced by such an expression must be public, with a return type of
void, and accept a single parameter of type ActionEvent. |
true |
true |
true |
| JSF:JAVADOC:402 |
void |
jakarta.faces.component.ActionSource.setImmediate
( boolean ) |
Set the
"immediate execution" flag for this UIComponent. |
true |
|
true |
| JSF:JAVADOC:403 |
MethodExpression |
jakarta.faces.component.ActionSource2.getActionExpression
|
Return
the 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. Note that
it's possible that the returned MethodExpression is just a wrapper
around a MethodBinding instance whith was set by a call to
ActionSource#setAction. This makes it possible for the default
ActionListener to continue to work properly with older components. |
true |
|
true |
| JSF:JAVADOC:404 |
void |
jakarta.faces.component.ActionSource2.setActionExpression
( MethodExpression ) |
Set the
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. Any
method referenced by such an expression must be public, with a return
type of String, and accept no parameters. |
true |
|
true |
| JSF:JAVADOC:405 |
void |
jakarta.faces.component.ContextCallback.invokeContextCallback
( FacesContext ,
UIComponent ) |
This
method will be called by an implementation of
UIComponent#invokeOnComponent and must be passed the component with
the clientId given as an argument to invokeOnComponent. At the point
in time when this method is called, the argument target is guaranteed
to be in the proper state with respect to its ancestors in the View. |
true |
|
true |
| JSF:JAVADOC:406 |
void |
jakarta.faces.component.EditableValueHolder.addValidator
( Validator ) |
Add a
Validator instance to the set associated with this component. |
true |
|
true |
| JSF:JAVADOC:407 |
void |
jakarta.faces.component.EditableValueHolder.addValidator
( Validator )
throws NullPointerException
|
if
validator is null |
true |
|
true |
| JSF:JAVADOC:408 |
void |
jakarta.faces.component.EditableValueHolder.addValueChangeListener
( ValueChangeListener ) |
Add a
new ValueChangeListener to the set of listeners interested in being
notified when ValueChangeEvents occur. |
true |
|
true |
| JSF:JAVADOC:409 |
void |
jakarta.faces.component.EditableValueHolder.addValueChangeListener
( ValueChangeListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:410 |
Object |
jakarta.faces.component.EditableValueHolder.getSubmittedValue
|
Return
the submittedValue value of this component. This method should only be
used by the encodeBegin() and/or encodeEnd() methods of this
component, or its corresponding Renderer. |
true |
|
true |
| JSF:JAVADOC:411 |
MethodBinding |
jakarta.faces.component.EditableValueHolder.getValidator
|
If
#setValidator was not previously called for this instance, this method
must return null. If it was called, this method must return the exact
MethodBinding instance that was passed to #setValidator. This method
will be called during the Process Validations or Apply Request Values
phases (depending on the value of the immediate property). |
true |
true |
true |
| JSF:JAVADOC:412 |
Validator[] |
jakarta.faces.component.EditableValueHolder.getValidators
|
Return
the set of registered Validators for this component instance. If there
are no registered validators, a zero-length array is returned. |
true |
|
true |
| JSF:JAVADOC:413 |
MethodBinding |
jakarta.faces.component.EditableValueHolder.getValueChangeListener
|
If
#setValueChangeListener was not previously called for this instance,
this method must return null. If it was called, this method must
return the exact MethodBinding instance that was passed to
#setValueChangeListener. |
true |
true |
true |
| JSF:JAVADOC:414 |
ValueChangeListener[] |
jakarta.faces.component.EditableValueHolder.getValueChangeListeners
|
Return
the set of registered ValueChangeListeners for this component
instance. If there are no registered listeners, a zero-length array is
returned. |
true |
|
true |
| JSF:JAVADOC:415 |
boolean |
jakarta.faces.component.EditableValueHolder.isImmediate
|
Return
the "immediate" state for this component. |
true |
|
true |
| JSF:JAVADOC:416 |
boolean |
jakarta.faces.component.EditableValueHolder.isLocalValueSet
|
Return
the "local value set" state for this component. Calls to setValue()
automatically reset this property to true. |
true |
|
true |
| JSF:JAVADOC:417 |
boolean |
jakarta.faces.component.EditableValueHolder.isRequired
|
Return
the "required field" state for this component. |
true |
|
true |
| JSF:JAVADOC:418 |
boolean |
jakarta.faces.component.EditableValueHolder.isValid
|
Return
a flag indicating whether the local value of this component is valid
(no conversion error has occurred). |
true |
|
true |
| JSF:JAVADOC:419 |
void |
jakarta.faces.component.EditableValueHolder.removeValidator
( Validator ) |
Remove
a Validator instance from the set associated with this component, if
it was previously associated. Otherwise, do nothing. |
true |
|
true |
| JSF:JAVADOC:420 |
void |
jakarta.faces.component.EditableValueHolder.removeValueChangeListener
( ValueChangeListener ) |
Remove
an existing ValueChangeListener (if any) from the set of listeners
interested in being notified when ValueChangeEvents occur. |
true |
|
true |
| JSF:JAVADOC:421 |
void |
jakarta.faces.component.EditableValueHolder.removeValueChangeListener
( ValueChangeListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:422 |
void |
jakarta.faces.component.EditableValueHolder.resetValue
|
Convenience method to reset this component's value to the
un-initialized state. |
true |
|
true |
| JSF:JAVADOC:423 |
void |
jakarta.faces.component.EditableValueHolder.setImmediate
( boolean ) |
Set the
"immediate" state for this component. When set to true, the
component's value will be converted and validated immediately in the
Apply Request Values phase, and ValueChangeEvents will be delivered in
that phase as well. The default value for this property must be false.
|
true |
|
true |
| JSF:JAVADOC:424 |
void |
jakarta.faces.component.EditableValueHolder.setLocalValueSet
( boolean ) |
Sets
the "local value set" state for this component. |
true |
|
true |
| JSF:JAVADOC:425 |
void |
jakarta.faces.component.EditableValueHolder.setRequired
( boolean ) |
Set the
"required field" state for this component. |
true |
|
true |
| JSF:JAVADOC:426 |
void |
jakarta.faces.component.EditableValueHolder.setSubmittedValue
( Object ) |
Set the
submittedValue value of this component. This method should only be
used by the decode() and validate() method of this component, or its
corresponding Renderer. |
true |
|
true |
| JSF:JAVADOC:427 |
void |
jakarta.faces.component.EditableValueHolder.setValid
( boolean ) |
Set a
flag indicating whether the local value of this component is valid (no
conversion error has occurred). |
true |
|
true |
| JSF:JAVADOC:428 |
void |
jakarta.faces.component.EditableValueHolder.setValidator
( MethodBinding ) |
Wrap
the argument validatorBinding in an implementation of
jakarta.faces.validator.Validator and store it in the internal data
structure that backs the #getValidators method, taking care to
over-write any instance that was stored by a previous call to
setValidator. The argument method will be called during the Process
Validations or Apply Request Values phases (depending on the value of
the immediate property). Any method referenced by such an expression
must be public, with a return type of void, and accept parameters of
type jakarta.faces.context.FacesContext, UIComponent, and Object. |
true |
true |
true |
| JSF:JAVADOC:429 |
void |
jakarta.faces.component.EditableValueHolder.setValueChangeListener
( MethodBinding ) |
Wrap
the argument valueChangeMethod in an implementation of
ValueChangeListener and store it in the internal data structure that
backs the #getValueChangeListeners method, taking care to over-write
any instance that was stored by a previous call to
setValueChangeListener. This argument method will be called during the
Process Validations or Apply Request Values phases (depending on the
value of the immediate property). Any method referenced by such an
expression must be public, with a return type of void, and accept a
parameter of type jakarta.faces.event.ValueChangeEvent. |
true |
true |
true |
| JSF:JAVADOC:430 |
String |
jakarta.faces.component.FacesComponent.value
|
The
value of this annotation attribute is taken to be the component-type
with which instances of this class of component can be instantiated by
calling
jakarta.faces.application.Application#createComponent(java.lang.String)
|
true |
|
true |
| JSF:JAVADOC:431 |
void |
jakarta.faces.component.PartialStateHolder.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:432 |
boolean |
jakarta.faces.component.PartialStateHolder.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:433 |
void |
jakarta.faces.component.PartialStateHolder.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:434 |
void |
jakarta.faces.component.StateHelper.add
( Serializable ,
Object ) |
Store
the specified value in a List that is internal to the StateHelper.
It's important to note for delta tracking that any modifications to
the internal List be made through this method or
StateHelper#remove(java.io.Serializable, Object). |
true |
|
true |
| JSF:JAVADOC:435 |
Object |
jakarta.faces.component.StateHelper.eval
( Serializable ) |
Attempts to find a value associated with the specified key, using the
value expression collection from the component if no such value is
found. |
true |
|
true |
| JSF:JAVADOC:436 |
Object |
jakarta.faces.component.StateHelper.eval
( Serializable ,
Object ) |
Performs the same logic as #eval(java.io.Serializable) } but if no
value is found, this will return the specified defaultValue |
true |
|
true |
| JSF:JAVADOC:437 |
Object |
jakarta.faces.component.StateHelper.get
( Serializable ) |
Return
the value currently associated with the specified key if any. |
true |
|
true |
| JSF:JAVADOC:438 |
Object |
jakarta.faces.component.StateHelper.put
( Serializable ,
Object ) |
Return
the previously stored value and store the specified key/value pair.
This is intended to store data that would otherwise reside in an
instance variable on the component. |
true |
|
true |
| JSF:JAVADOC:439 |
Object |
jakarta.faces.component.StateHelper.put
( Serializable ,
String ,
Object ) |
Store
the specified mapKey/value in a Map that is internal to the helper,
and return the previously stored value. The Map will then be
associated with key. It's important to note for delta tracking that
any modifications to the internal Map be made through this method or
StateHelper#remove(java.io.Serializable, Object). |
true |
|
true |
| JSF:JAVADOC:440 |
Object |
jakarta.faces.component.StateHelper.remove
( Serializable ) |
Remove
the key/value pair from the helper, returning the value previously
stored under this key. |
true |
|
true |
| JSF:JAVADOC:441 |
Object |
jakarta.faces.component.StateHelper.remove
( Serializable ,
Object ) |
Remove
a value from the inner data structure. Look in the inner data
structure for the value at the given key. If the value is a Map,
remove and return the value under the key given by the valueOrKey
argument. If the value is a Collection, simply remove the value given
by the argument valueOrKey and return null. |
true |
|
true |
| JSF:JAVADOC:442 |
boolean |
jakarta.faces.component.StateHolder.isTransient
|
If
true, the Object implementing this interface must not participate in
state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:443 |
void |
jakarta.faces.component.StateHolder.restoreState
( FacesContext ,
Object ) |
Perform
any processing required to restore the state from the entries in the
state Object. If the class that implements this interface has
references to instances that also implement StateHolder (such as a
UIComponent with event handlers, validators, etc.) this method must
call the #restoreState method on all those instances as well. |
true |
|
true |
| JSF:JAVADOC:444 |
void |
jakarta.faces.component.StateHolder.restoreState
( FacesContext ,
Object )
throws NullPointerException
|
if
either context or state are null |
true |
|
true |
| JSF:JAVADOC:445 |
Object |
jakarta.faces.component.StateHolder.saveState
( FacesContext ) |
Gets
the state of the instance as a Serializable Object. If the class that
implements this interface has references to instances that implement
StateHolder (such as a UIComponent with event handlers, validators,
etc.) this method must call the #saveState method on all those
instances as well. This method must not save the state of children and
facets. That is done via the jakarta.faces.application.StateManager This
method must not alter the state of the implementing object. In other
words, after executing this code: Object state =
component.saveState(facesContext); component should be the same as
before executing it. The return from this method must be Serializable
|
true |
|
true |
| JSF:JAVADOC:446 |
Object |
jakarta.faces.component.StateHolder.saveState
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:447 |
void |
jakarta.faces.component.StateHolder.setTransient
( boolean ) |
Denotes
whether or not the Object implementing this interface must or must not
participate in state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:448 |
String |
jakarta.faces.component.UIColumn.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:449 |
UIComponent |
jakarta.faces.component.UIColumn.getFooter
|
Return
the footer facet of the column (if any). A convenience method for
getFacet("footer"). |
true |
|
true |
| JSF:JAVADOC:450 |
UIComponent |
jakarta.faces.component.UIColumn.getHeader
|
Return
the header facet of the column (if any). A convenience method for
getFacet("header"). |
true |
|
true |
| JSF:JAVADOC:451 |
void |
jakarta.faces.component.UIColumn.setFooter
( UIComponent ) |
Set the
footer facet of the column. A convenience method for
getFacets().put("footer", footer). |
true |
|
true |
| JSF:JAVADOC:452 |
void |
jakarta.faces.component.UIColumn.setFooter
( UIComponent )
throws NullPointerException
|
if
footer is null |
true |
|
true |
| JSF:JAVADOC:453 |
void |
jakarta.faces.component.UIColumn.setHeader
( UIComponent ) |
Set the
header facet of the column. A convenience method for
getFacets().put("header", header). |
true |
|
true |
| JSF:JAVADOC:454 |
void |
jakarta.faces.component.UIColumn.setHeader
( UIComponent )
throws NullPointerException
|
if
header is null |
true |
|
true |
| JSF:JAVADOC:455 |
UIColumn |
jakarta.faces.component.UIColumn.UIColumn
|
Create
a new UIColumn instance with default property values. |
true |
|
true |
| JSF:JAVADOC:456 |
void |
jakarta.faces.component.UICommand.addActionListener
( ActionListener ) |
|
true |
|
true |
| JSF:JAVADOC:457 |
void |
jakarta.faces.component.UICommand.addActionListener
( ActionListener )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:458 |
void |
jakarta.faces.component.UICommand.broadcast
( FacesEvent ) |
In
addition to to the default UIComponent#broadcast processing, pass the
ActionEvent being broadcast to the method referenced by actionListener
(if any), and to the default ActionListener registered on the
jakarta.faces.application.Application. |
true |
|
true |
| JSF:JAVADOC:459 |
void |
jakarta.faces.component.UICommand.broadcast
( FacesEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:460 |
void |
jakarta.faces.component.UICommand.broadcast
( FacesEvent )
throws IllegalArgumentException
|
if the
implementation class of this FacesEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:461 |
void |
jakarta.faces.component.UICommand.broadcast
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:462 |
MethodBinding |
jakarta.faces.component.UICommand.getAction
|
|
true |
true |
true |
| JSF:JAVADOC:463 |
MethodExpression |
jakarta.faces.component.UICommand.getActionExpression
|
Return
the 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. Note that
it's possible that the returned MethodExpression is just a wrapper
around a MethodBinding instance whith was set by a call to
ActionSource#setAction. This makes it possible for the default
ActionListener to continue to work properly with older components. |
true |
|
true |
| JSF:JAVADOC:464 |
MethodBinding |
jakarta.faces.component.UICommand.getActionListener
|
|
true |
true |
true |
| JSF:JAVADOC:465 |
ActionListener[] |
jakarta.faces.component.UICommand.getActionListeners
|
|
true |
|
true |
| JSF:JAVADOC:466 |
String |
jakarta.faces.component.UICommand.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:467 |
Object |
jakarta.faces.component.UICommand.getValue
|
Returns
the value property of the UICommand. This is most often rendered as a
label. |
true |
|
true |
| JSF:JAVADOC:468 |
boolean |
jakarta.faces.component.UICommand.isImmediate
|
The
immediate flag. |
true |
|
true |
| JSF:JAVADOC:469 |
void |
jakarta.faces.component.UICommand.queueEvent
( FacesEvent ) |
Intercept queueEvent and take the following action. If the event is an
ActionEvent, obtain the UIComponent instance from the event. If the
component is an ActionSource obtain the value of its "immediate"
property. If it is true, mark the phaseId for the event to be
PhaseId.APPLY_REQUEST_VALUES otherwise, mark the phaseId to be
PhaseId.INVOKE_APPLICATION. The event must be passed on to
super.queueEvent() before returning from this method. |
true |
|
true |
| JSF:JAVADOC:470 |
void |
jakarta.faces.component.UICommand.removeActionListener
( ActionListener ) |
|
true |
|
true |
| JSF:JAVADOC:471 |
void |
jakarta.faces.component.UICommand.removeActionListener
( ActionListener )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:472 |
void |
jakarta.faces.component.UICommand.setAction
( MethodBinding ) |
|
true |
true |
true |
| JSF:JAVADOC:473 |
void |
jakarta.faces.component.UICommand.setActionExpression
( MethodExpression ) |
Set the
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. Any
method referenced by such an expression must be public, with a return
type of String, and accept no parameters. |
true |
|
true |
| JSF:JAVADOC:474 |
void |
jakarta.faces.component.UICommand.setActionListener
( MethodBinding ) |
|
true |
true |
true |
| JSF:JAVADOC:475 |
void |
jakarta.faces.component.UICommand.setImmediate
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:476 |
void |
jakarta.faces.component.UICommand.setValue
( Object ) |
Sets
the value property of the UICommand. This is most often rendered as a
label. |
true |
|
true |
| JSF:JAVADOC:477 |
UICommand |
jakarta.faces.component.UICommand.UICommand
|
Create
a new UICommand instance with default property values. |
true |
|
true |
| JSF:JAVADOC:478 |
void |
jakarta.faces.component.UIComponent.broadcast
( FacesEvent ) |
Broadcast the specified FacesEvent to all registered event listeners
who have expressed an interest in events of this type. Listeners are
called in the order in which they were added. If the event is an
instance of jakarta.faces.event.BehaviorEvent and the current component
is the source of the event call
jakarta.faces.event.BehaviorEvent#getBehavior to get the
jakarta.faces.component.behavior.Behavior for the event. If the behavior
implements jakarta.faces.component.behavior.ClientBehavior, call
jakarta.faces.component.behavior.ClientBehavior#broadcast(jakarta.faces.event.BehaviorEvent)}.
|
true |
|
true |
| JSF:JAVADOC:479 |
void |
jakarta.faces.component.UIComponent.broadcast
( FacesEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:480 |
void |
jakarta.faces.component.UIComponent.broadcast
( FacesEvent )
throws IllegalArgumentException
|
if the
implementation class of this FacesEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:481 |
void |
jakarta.faces.component.UIComponent.broadcast
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:482 |
void |
jakarta.faces.component.UIComponent.clearInitialState
|
An
implementation of PartialStateHolder#clearInitialState, this method is
called by the runtime to tell the instance to stop tracking state
changes. |
true |
|
true |
| JSF:JAVADOC:483 |
void |
jakarta.faces.component.UIComponent.decode
( FacesContext ) |
Decode
any new state of this UIComponent from the request contained in the
specified FacesContext, and store this state as needed. During
decoding, events may be enqueued for later processing (by event
listeners who have registered an interest), by calling queueEvent(). |
true |
|
true |
| JSF:JAVADOC:484 |
void |
jakarta.faces.component.UIComponent.decode
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:485 |
void |
jakarta.faces.component.UIComponent.encodeAll
( FacesContext ) |
If this
component returns true from #isRendered, take the following action.
Render this component and all its children that return true from
isRendered(), regardless of the value of the #getRendersChildren flag.
|
true |
|
true |
| JSF:JAVADOC:486 |
void |
jakarta.faces.component.UIComponent.encodeAll
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:487 |
void |
jakarta.faces.component.UIComponent.encodeAll
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:488 |
void |
jakarta.faces.component.UIComponent.encodeBegin
( FacesContext ) |
If our
rendered property is true, render the beginning of the current state
of this UIComponent to the response contained in the specified
FacesContext. Call
#pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent).
Call jakarta.faces.application.Application#publishEvent, passing
jakarta.faces.event.PreRenderComponentEvent.class as the first argument
and the component instance to be rendered as the second argument. If a
Renderer is associated with this UIComponent, the actual encoding will
be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If
our rendered property is false, call
#pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent)
and return immediately. |
true |
|
true |
| JSF:JAVADOC:489 |
void |
jakarta.faces.component.UIComponent.encodeBegin
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:490 |
void |
jakarta.faces.component.UIComponent.encodeBegin
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:491 |
void |
jakarta.faces.component.UIComponent.encodeChildren
( FacesContext ) |
If our
rendered property is true, render the child UIComponents of this
UIComponent. This method will only be called if the rendersChildren
property is true. If a Renderer is associated with this UIComponent,
the actual encoding will be delegated to
Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is
associated with this UIComponent, iterate over each of the children of
this component and call #encodeAll(jakarta.faces.context.FacesContext).
|
true |
|
true |
| JSF:JAVADOC:492 |
void |
jakarta.faces.component.UIComponent.encodeChildren
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:493 |
void |
jakarta.faces.component.UIComponent.encodeChildren
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:494 |
void |
jakarta.faces.component.UIComponent.encodeEnd
( FacesContext ) |
If our
rendered property is true, render the ending of the current state of
this UIComponent. If a Renderer is associated with this UIComponent,
the actual encoding will be delegated to
Renderer#encodeEnd(FacesContext, UIComponent). Call
UIComponent#popComponentFromEL. before returning regardless of the
value of the rendered property. |
true |
|
true |
| JSF:JAVADOC:495 |
void |
jakarta.faces.component.UIComponent.encodeEnd
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:496 |
void |
jakarta.faces.component.UIComponent.encodeEnd
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:497 |
UIComponent |
jakarta.faces.component.UIComponent.findComponent
( String ) |
Search
for and return the UIComponent with an id that matches the specified
search expression (if any), according to the algorithm described
below. For a method to find a component given a simple clientId, see
#invokeOnComponent. Component identifiers are required to be unique
within the scope of the closest ancestor NamingContainer that encloses
this component (which might be this component itself). If there are no
NamingContainer components in the ancestry of this component, the root
component in the tree is treated as if it were a NamingContainer,
whether or not its class actually implements the NamingContainer
interface. A search expression consists of either an identifier (which
is matched exactly against the id property of a UIComponent, or a
series of such identifiers linked by the
UINamingContainer#getSeparatorChar character value. The search
algorithm should operates as follows, though alternate alogrithms may
be used as long as the end result is the same: Identify the
UIComponent that will be the base for searching, by stopping as soon
as one of the following conditions is met: If the search expression
begins with the the separator character (called an "absolute" search
expression), the base will be the root UIComponent of the component
tree. The leading separator character will be stripped off, and the
remainder of the search expression will be treated as a "relative"
search expression as described below. Otherwise, if this UIComponent
is a NamingContainer it will serve as the basis. Otherwise, search up
the parents of this component. If a NamingContainer is encountered, it
will be the base. Otherwise (if no NamingContainer is encountered) the
root UIComponent will be the base. The search expression (possibly
modified in the previous step) is now a "relative" search expression
that will be used to locate the component (if any) that has an id that
matches, within the scope of the base component. The match is
performed as follows: If the search expression is a simple identifier,
this value is compared to the id property, and then recursively
through the facets and children of the base UIComponent (except that
if a descendant NamingContainer is found, its own facets and children
are not searched). If the search expression includes more than one
identifier separated by the separator character, the first identifier
is used to locate a NamingContainer by the rules in the previous
bullet point. Then, the findComponent() method of this NamingContainer
will be called, passing the remainder of the search expression. |
true |
|
true |
| JSF:JAVADOC:498 |
UIComponent |
jakarta.faces.component.UIComponent.findComponent
( String )
throws IllegalArgumentException
|
if an
intermediate identifier in a search expression identifies a
UIComponent that is not a NamingContainer |
true |
|
true |
| JSF:JAVADOC:499 |
UIComponent |
jakarta.faces.component.UIComponent.findComponent
( String )
throws NullPointerException
|
if expr
is null |
true |
|
true |
| JSF:JAVADOC:500 |
Map |
jakarta.faces.component.UIComponent.getAttributes
|
Return
a mutable Map representing the attributes (and properties, see below)
associated wth this UIComponent, keyed by attribute name (which must
be a String). The returned implementation must support all of the
standard and optional Map methods, plus support the following
additional requirements: The Map implementation must implement the
java.io.Serializable interface. Any attempt to add a null key or value
must throw a NullPointerException. Any attempt to add a key that is
not a String must throw a ClassCastException. If the attribute name
specified as a key matches a property of this UIComponent's
implementation class, the following methods will have special
behavior: containsKey - Return false. get() - If the property is
readable, call the getter method and return the returned value
(wrapping primitive values in their corresponding wrapper classes);
otherwise throw IllegalArgumentException. put() - If the property is
writeable, call the setter method to set the corresponding value
(unwrapping primitive values in their corresponding wrapper classes).
If the property is not writeable, or an attempt is made to set a
property of primitive type to null, throw IllegalArgumentException.
remove - Throw IllegalArgumentException. |
true |
|
true |
| JSF:JAVADOC:501 |
int |
jakarta.faces.component.UIComponent.getChildCount
|
Return
the number of child UIComponents that are associated with this
UIComponent. If there are no children, this method must return 0. The
method must not cause the creation of a child component list. |
true |
|
true |
| JSF:JAVADOC:502 |
List |
jakarta.faces.component.UIComponent.getChildren
|
Return
a mutable List representing the child UIComponents associated with
this component. The returned implementation must support all of the
standard and optional List methods, plus support the following
additional requirements: The List implementation must implement the
java.io.Serializable interface. Any attempt to add a null must throw a
NullPointerException Any attempt to add an object that does not
implement UIComponent must throw a ClassCastException. Whenever a new
child component is added, the parent property of the child must be set
to this component instance. If the parent property of the child was
already non-null, the child must first be removed from its previous
parent (where it may have been either a child or a facet). Whenever an
existing child component is removed, the parent property of the child
must be set to null. After the child component has been added to the
view, if the following condition is not met:
jakarta.faces.context.FacesContext#isPostback returns true and
jakarta.faces.context.FacesContext#getCurrentPhaseId returns
jakarta.faces.event.PhaseId#RESTORE_VIEWjakarta.faces.application.Application#publishEvent
must be called, passing jakarta.faces.event.PostAddToViewEvent.class as
the first argument and the newly added component as the second
argument. |
true |
|
true |
| JSF:JAVADOC:503 |
String |
jakarta.faces.component.UIComponent.getClientId
|
Enable
EL to access the clientId of a component. This is particularly useful
in combination with the component and cc implicit objects. A default
implementation is provided that simply calls
FacesContext#getCurrentInstance and then calls through to
#getClientId(FacesContext). |
true |
|
true |
| JSF:JAVADOC:504 |
String |
jakarta.faces.component.UIComponent.getClientId
( FacesContext ) |
Return
a client-side identifier for this component, generating one if
necessary. The associated Renderer, if any, will be asked to convert
the clientId to a form suitable for transmission to the client. The
return from this method must be the same value throughout the lifetime
of the instance, unless the id property of the component is changed,
or the component is placed in a NamingContainer whose client ID
changes (for example, UIData). However, even in these cases,
consecutive calls to this method must always return the same value.
The implementation must follow these steps in determining the
clientId: Find the closest ancestor to this component in the view
hierarchy that implements NamingContainer. Call getContainerClientId()
on it and save the result as the parentId local variable. Call #getId
on this component and save the result as the myId local variable. If
myId is null, call context.getViewRoot().createUniqueId() and assign
the result to myId. If parentId is non-null, let myId equal parentId +
UINamingContainer#getSeparatorChar + myId. Call
Renderer#convertClientId, passing myId, and return the result. |
true |
|
true |
| JSF:JAVADOC:505 |
String |
jakarta.faces.component.UIComponent.getClientId
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:506 |
UIComponent |
jakarta.faces.component.UIComponent.getCompositeComponentParent
( UIComponent ) |
Finds
the nearest composite component parent of the specified component. |
true |
|
true |
| JSF:JAVADOC:507 |
String |
jakarta.faces.component.UIComponent.getContainerClientId
( FacesContext ) |
Allow
components that implement NamingContainer to selectively disable
prepending their clientId to their descendent's clientIds by breaking
the prepending logic into a seperately callable method. See
#getClientId for usage. By default, this method will call through to
#getClientId and return the result. |
true |
|
true |
| JSF:JAVADOC:508 |
String |
jakarta.faces.component.UIComponent.getContainerClientId
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:509 |
UIComponent |
jakarta.faces.component.UIComponent.getCurrentComponent
( FacesContext ) |
Return
the UIComponent instance that is currently processing. This is
equivalent to evaluating the EL expression "#{component}" and doing a
getValue operation on the resultant ValueExpression. This method must
return null if there is no currently processing UIComponent |
true |
|
true |
| JSF:JAVADOC:510 |
UIComponent |
jakarta.faces.component.UIComponent.getCurrentComponent
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:511 |
UIComponent |
jakarta.faces.component.UIComponent.getCurrentCompositeComponent
( FacesContext ) |
Return
the closest ancestor component, relative to the component returned
from #getCurrentComponent, that is a composite component, or null if
no such component exists. |
true |
|
true |
| JSF:JAVADOC:512 |
UIComponent |
jakarta.faces.component.UIComponent.getCurrentCompositeComponent
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:513 |
UIComponent |
jakarta.faces.component.UIComponent.getFacet
( String ) |
Convenience method to return the named facet, if it exists, or null
otherwise. If the requested facet does not exist, the facets Map must
not be created. |
true |
|
true |
| JSF:JAVADOC:514 |
int |
jakarta.faces.component.UIComponent.getFacetCount
|
Return
the number of facet UIComponents that are associated with this
UIComponent. If there are no facets, this method must return 0. The
method must not cause the creation of a facet component map. For
backwards compatability with classes that extend UIComponent directly,
a default implementation is provided that simply calls #getFacets and
then calls the size() method on the returned Map. A more optimized
version of this method is provided in UIComponentBase#getFacetCount. |
true |
|
true |
| JSF:JAVADOC:515 |
Map |
jakarta.faces.component.UIComponent.getFacets
|
Return
a mutable Map representing the facet UIComponents associated with this
UIComponent, keyed by facet name (which must be a String). The
returned implementation must support all of the standard and optional
Map methods, plus support the following additional requirements: The
Map implementation must implement the java.io.Serializable interface.
Any attempt to add a null key or value must throw a
NullPointerException. Any attempt to add a key that is not a String
must throw a ClassCastException. Any attempt to add a value that is
not a UIComponent must throw a ClassCastException. Whenever a new
facet UIComponent is added: The parent property of the component must
be set to this component instance. If the parent property of the
component was already non-null, the component must first be removed
from its previous parent (where it may have been either a child or a
facet). Whenever an existing facet UIComponent is removed: The parent
property of the facet must be set to null. |
true |
|
true |
| JSF:JAVADOC:516 |
Iterator |
jakarta.faces.component.UIComponent.getFacetsAndChildren
|
Return
an Iterator over the facet followed by child UIComponents of this
UIComponent. Facets are returned in an undefined order, followed by
all the children in the order they are stored in the child list. If
this component has no facets or children, an empty Iterator is
returned. The returned Iterator must not support the remove()
operation. |
true |
|
true |
| JSF:JAVADOC:517 |
String |
jakarta.faces.component.UIComponent.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:518 |
String |
jakarta.faces.component.UIComponent.getId
|
Return
the component identifier of this UIComponent. |
true |
|
true |
| JSF:JAVADOC:519 |
List |
jakarta.faces.component.UIComponent.getListenersForEventClass
( Class ) |
Return
the SystemEventListener instances registered on this UIComponent
instance that are interested in events of type eventClass. |
true |
|
true |
| JSF:JAVADOC:520 |
List |
jakarta.faces.component.UIComponent.getListenersForEventClass
( Class )
throws NullPointerException
|
if
argument eventClass is null. |
true |
|
true |
| JSF:JAVADOC:521 |
UIComponent |
jakarta.faces.component.UIComponent.getNamingContainer
|
Starting with "this", return the closest component in the ancestry
that is a NamingContainer or null if none can be found. |
true |
|
true |
| JSF:JAVADOC:522 |
UIComponent |
jakarta.faces.component.UIComponent.getParent
|
Return
the parent UIComponent of this UIComponent, if any. A component must
allow child components to be added to and removed from the list of
children of this component, even though the child component returns
null from getParent( ). |
true |
|
true |
| JSF:JAVADOC:523 |
String |
jakarta.faces.component.UIComponent.getRendererType
|
Return
the Renderer type for this UIComponent (if any). |
true |
|
true |
| JSF:JAVADOC:524 |
boolean |
jakarta.faces.component.UIComponent.getRendersChildren
|
Return
a flag indicating whether this component is responsible for rendering
its child components. The default implementation in
UIComponentBase#getRendersChildren tries to find the renderer for this
component. If it does, it calls Renderer#getRendersChildren and
returns the result. If it doesn't, it returns false. As of version 1.2
of the Jakarta Server Faces Specification, component authors are
encouraged to return true from this method and rely on
UIComponentBase#encodeChildren. |
true |
|
true |
| JSF:JAVADOC:525 |
Map |
jakarta.faces.component.UIComponent.getResourceBundleMap
|
Return
a Map of the ResourceBundle for this component. A component may have a
ResourceBundle associated with it. This bundle may contain localized
properties relating to instances of this component. The default
implementation first looks for a ResourceBundle with a base name equal
to the fully qualified class name of the current UIComponent this and
Locale equal to the Locale of the current UIViewRoot. If no such
bundle is found, and the component is a composite component, let
resourceName be the resourceName of the Resource for this composite
component, replacing the file extension with ".properties". Let
libraryName be the libraryName of the the Resource for this composite
component. Call
jakarta.faces.application.ResourceHandler#createResource(java.lang.String,java.lang.String),
passing the derived resourceName and libraryName. Note that this will
automatically allow for the localization of the ResourceBundle due to
the localization facility implemented in createResource, which is
specified in section JSF.2.6.1.3 of the spec prose document. If the
resultant Resource exists and can be found, the InputStream for the
resource is used to create a ResourceBundle. If either of the two
previous steps for obtaining the ResourceBundle for this component is
successful, the ResourceBundle is wrapped in a Map and returned.
Otherwise Collections.EMPTY_MAP is returned. |
true |
|
true |
| JSF:JAVADOC:526 |
ValueBinding |
jakarta.faces.component.UIComponent.getValueBinding
( String ) |
Call
through to #getValueExpression and examine the result. If the result
is an instance of the wrapper class mandated in #setValueBinding,
extract the ValueBinding instance and return it. Otherwise, wrap the
result in an implementation of ValueBinding, and return it. |
true |
true |
true |
| JSF:JAVADOC:527 |
ValueBinding |
jakarta.faces.component.UIComponent.getValueBinding
( String )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:528 |
ValueExpression |
jakarta.faces.component.UIComponent.getValueExpression
( String ) |
Return
the ValueExpression used to calculate the value for the specified
attribute or property name, if any. This method must be overridden and
implemented for components that comply with JSF 1.2 and later. |
true |
|
true |
| JSF:JAVADOC:529 |
ValueExpression |
jakarta.faces.component.UIComponent.getValueExpression
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:530 |
boolean |
jakarta.faces.component.UIComponent.initialStateMarked
|
An
implementation of PartialStateHolder#initialStateMarked, this method
is called by the runtime to test if the
PartialStateHolder#markInitialState method was called. |
true |
|
true |
| JSF:JAVADOC:531 |
boolean |
jakarta.faces.component.UIComponent.invokeOnComponent
( FacesContext ,
String ,
ContextCallback ) |
Starting at this component in the View hierarchy, search for a
component with a clientId equal to the argument clientId and, if
found, call the ContextCallback#invokeContextCallback method on the
argument callback, passing the current FacesContext and the found
component as arguments. This method is similar to #findComponent but
it does not support the leading UINamingContainer#getSeparatorChar
syntax for searching from the root of the View. The default
implementation will first check if this.getClientId() is equal to the
argument clientId. If so, call the
ContextCallback#invokeContextCallback method on the argument callback,
passing through the FacesContext argument and passing this as the
component argument. If an Exception is thrown by the callback, wrap it
in a FacesException and re-throw it. Otherwise, return true.
Otherwise, for each component returned by #getFacetsAndChildren, call
invokeOnComponent() passing the arguments to this method, in order.
The first time invokeOnComponent() returns true, abort traversing the
rest of the Iterator and return true. When calling
ContextCallback#invokeContextCallback the implementation of this
method must guarantee that the state of the component passed to the
callback correctly reflects the component's position in the View
hierarchy with respect to any state found in the argument clientId.
For example, an iterating component such as UIData will need to set
its row index to correctly reflect the argument clientId before
finding the appropriate child component backed by the correct row.
When the callback returns, either normally or by throwing an Exception
the implementation of this method must restore the state of the view
to the way it was before invoking the callback. If none of the
elements from #getFacetsAndChildren returned true from
invokeOnComponent(), return false. Simple usage example to find a
component by clientId. private UIComponent found = null; private void
doFind(FacesContext context, String clientId) {
context.getViewRoot().invokeOnComponent(context, clientId, new
ContextCallback() { public void invokeContextCallback(FacesContext
context, UIComponent component) { found = component; } }); } |
true |
|
true |
| JSF:JAVADOC:532 |
boolean |
jakarta.faces.component.UIComponent.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws FacesException
|
if the
argument Callback throws an Exception, it is wrapped in a
FacesException and re-thrown. |
true |
|
true |
| JSF:JAVADOC:533 |
boolean |
jakarta.faces.component.UIComponent.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:534 |
boolean |
jakarta.faces.component.UIComponent.isCompositeComponent
( UIComponent ) |
Return
true if component is a composite component, otherwise false. |
true |
|
true |
| JSF:JAVADOC:535 |
boolean |
jakarta.faces.component.UIComponent.isCompositeComponent
( UIComponent )
throws NullPointerException
|
if
component is null |
true |
|
true |
| JSF:JAVADOC:536 |
boolean |
jakarta.faces.component.UIComponent.isInView
|
Return
true if this component is within the view hierarchy otherwise false |
true |
|
true |
| JSF:JAVADOC:537 |
boolean |
jakarta.faces.component.UIComponent.isRendered
|
Return
true if this component (and its children) should be rendered during
the Render Response phase of the request processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:538 |
void |
jakarta.faces.component.UIComponent.markInitialState
|
An
implementation of PartialStateHolder#markInitialState, this method is
called by the runtime to indicate that the instance should start
tracking changes to its state. |
true |
|
true |
| JSF:JAVADOC:539 |
void |
jakarta.faces.component.UIComponent.popComponentFromEL
( FacesContext ) |
Pop the
current UIComponent from the FacesContext attributes map so that the
previous UIComponent, if any, becomes the current component. |
true |
|
true |
| JSF:JAVADOC:540 |
void |
jakarta.faces.component.UIComponent.popComponentFromEL
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:541 |
void |
jakarta.faces.component.UIComponent.processDecodes
( FacesContext ) |
Perform
the component tree processing required by the Apply Request Values
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processDecodes() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). Call the decode() method of this component.
Call #popComponentFromEL from inside of a finally block, just before
returning. If a RuntimeException is thrown during decode processing,
call FacesContext#renderResponse and re-throw the exception. |
true |
|
true |
| JSF:JAVADOC:542 |
void |
jakarta.faces.component.UIComponent.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:543 |
void |
jakarta.faces.component.UIComponent.processEvent
( ComponentSystemEvent ) |
The
default implementation performs the following action. If the argument
event is an instance of PostRestoreStateEvent, call
this.#getValueExpression passing the literal string
“binding”, without the quotes, as the argument. If the
result is non-null, set the value of the ValueExpression to be this. |
true |
|
true |
| JSF:JAVADOC:544 |
void |
jakarta.faces.component.UIComponent.processEvent
( ComponentSystemEvent )
throws AbortProcessingException
|
|
true |
|
true |
| JSF:JAVADOC:545 |
void |
jakarta.faces.component.UIComponent.processRestoreState
( FacesContext ,
Object ) |
Perform
the component tree processing required by the Restore View phase of
the request processing lifecycle for all facets of this component, all
children of this component, and this component itself, as follows.
Call the restoreState() method of this component. Call
UIComponent#pushComponentToEL. Call the processRestoreState() method
of all facets and children of this UIComponent in the order determined
by a call to getFacetsAndChildren(). After returning from the
processRestoreState() method on a child or facet, call
UIComponent#popComponentFromEL This method may not be called if the
state saving method is set to server. |
true |
|
true |
| JSF:JAVADOC:546 |
void |
jakarta.faces.component.UIComponent.processRestoreState
( FacesContext ,
Object )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:547 |
Object |
jakarta.faces.component.UIComponent.processSaveState
( FacesContext ) |
Perform
the component tree processing required by the state saving portion of
the Render Response phase of the request processing lifecycle for all
facets of this component, all children of this component, and this
component itself, as follows. consult the transient property of this
component. If true, just return null. Call #pushComponentToEL. Call
the processSaveState() method of all facets and children of this
UIComponent in the order determined by a call to
getFacetsAndChildren(), skipping children and facets that are
transient. Ensure that #popComponentFromEL is called correctly after
each child or facet. Call the saveState() method of this component.
Encapsulate the child state and your state into a Serializable Object
and return it. This method may not be called if the state saving
method is set to server. |
true |
|
true |
| JSF:JAVADOC:548 |
Object |
jakarta.faces.component.UIComponent.processSaveState
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:549 |
void |
jakarta.faces.component.UIComponent.processUpdates
( FacesContext ) |
Perform
the component tree processing required by the Update Model Values
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processUpdates() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). After returning from the processUpdates()
method on a child or facet, call UIComponent#popComponentFromEL |
true |
|
true |
| JSF:JAVADOC:550 |
void |
jakarta.faces.component.UIComponent.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:551 |
void |
jakarta.faces.component.UIComponent.processValidators
( FacesContext ) |
Perform
the component tree processing required by the Process Validations
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processValidators() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). |
true |
|
true |
| JSF:JAVADOC:552 |
void |
jakarta.faces.component.UIComponent.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:553 |
void |
jakarta.faces.component.UIComponent.pushComponentToEL
( FacesContext ,
UIComponent ) |
Push
the current UIComponent this to the FacesContext attribute map using
the key #CURRENT_COMPONENT saving the previous UIComponent associated
with #CURRENT_COMPONENT for a subsequent call to #popComponentFromEL.
This method and popComponentFromEL() form the basis for the contract
that enables the EL Expression "#{component}" to resolve to the
"current" component that is being processed in the lifecycle. The
requirements for when pushComponentToEL() and popComponentFromEL()
must be called are specified as needed in the javadoc for this class.
After pushComponentToEL() returns, a call to #getCurrentComponent must
return this UIComponent instance until popComponentFromEL() is called,
after which point the previous UIComponent instance will be returned
from getCurrentComponent() |
true |
|
true |
| JSF:JAVADOC:554 |
void |
jakarta.faces.component.UIComponent.pushComponentToEL
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:555 |
void |
jakarta.faces.component.UIComponent.queueEvent
( FacesEvent ) |
Queue
an event for broadcast at the end of the current request processing
lifecycle phase. The default implementation in UIComponentBase must
delegate this call to the queueEvent() method of the parent
UIComponent. |
true |
|
true |
| JSF:JAVADOC:556 |
void |
jakarta.faces.component.UIComponent.queueEvent
( FacesEvent )
throws IllegalStateException
|
if this
component is not a descendant of a UIViewRoot |
true |
|
true |
| JSF:JAVADOC:557 |
void |
jakarta.faces.component.UIComponent.queueEvent
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:558 |
void |
jakarta.faces.component.UIComponent.setId
( String ) |
Set the
component identifier of this UIComponent (if any). Component
identifiers must obey the following syntax restrictions: Must not be a
zero-length String. First character must be a letter or an underscore
('_'). Subsequent characters must be a letter, a digit, an underscore
('_'), or a dash ('-'). Component identifiers must also obey the
following semantic restrictions (note that this restriction is NOT
enforced by the setId() implementation): The specified identifier must
be unique among all the components (including facets) that are
descendents of the nearest ancestor UIComponent that is a
NamingContainer, or within the scope of the entire component tree if
there is no such ancestor that is a NamingContainer. |
true |
|
true |
| JSF:JAVADOC:559 |
void |
jakarta.faces.component.UIComponent.setId
( String )
throws IllegalArgumentException
|
if id is
not syntactically valid |
true |
|
true |
| JSF:JAVADOC:560 |
void |
jakarta.faces.component.UIComponent.setInView
( boolean ) |
Updates
the status as to whether or not this component is currently within the
view hierarchy. This method must never be called by developers; a
UIComponent's internal implementation will call it as components are
added to or removed from a parent's child List or facet Map. |
true |
|
true |
| JSF:JAVADOC:561 |
void |
jakarta.faces.component.UIComponent.setParent
( UIComponent ) |
Set the
parent UIComponent of this UIComponent. This method will cause an
jakarta.faces.event.PostAddToViewEvent to be published and if
parent.isInView() returns true an jakarta.faces.event.PostAddToViewEvent
will be published as well. This method must never be called by
developers; a UIComponent's internal implementation will call it as
components are added to or removed from a parent's child List or facet
Map. |
true |
|
true |
| JSF:JAVADOC:562 |
void |
jakarta.faces.component.UIComponent.setRendered
( boolean ) |
Set the
rendered property of this UIComponent. |
true |
|
true |
| JSF:JAVADOC:563 |
void |
jakarta.faces.component.UIComponent.setRendererType
( String ) |
Set the
Renderer type for this UIComponent, or null for components that render
themselves. |
true |
|
true |
| JSF:JAVADOC:564 |
void |
jakarta.faces.component.UIComponent.setValueBinding
( String ,
ValueBinding ) |
Wrap
the argument binding in an implementation of ValueExpression and call
through to #setValueExpression. |
true |
true |
true |
| JSF:JAVADOC:565 |
void |
jakarta.faces.component.UIComponent.setValueBinding
( String ,
ValueBinding )
throws IllegalArgumentException
|
if name
is one of id or parent |
true |
true |
true |
| JSF:JAVADOC:566 |
void |
jakarta.faces.component.UIComponent.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:567 |
void |
jakarta.faces.component.UIComponent.setValueExpression
( String ,
ValueExpression ) |
Set the
ValueExpression used to calculate the value for the specified
attribute or property name, if any. The implementation must call
ValueExpression#isLiteralText on the argument expression. If
isLiteralText() returns true, invoke ValueExpression#getValue on the
argument expression and pass the result as the value parameter in a
call to this.#getAttributes().put(name, value) where name is the
argument name. If an exception is thrown as a result of calling
ValueExpression#getValue, wrap it in a jakarta.faces.FacesException and
re-throw it. If isLiteralText() returns false, simply store the
un-evaluated expression argument in the collection of ValueExpressions
under the key given by the argument name. This method must be
overridden and implemented for components that comply with JSF 1.2 and
later. |
true |
|
true |
| JSF:JAVADOC:568 |
void |
jakarta.faces.component.UIComponent.setValueExpression
( String ,
ValueExpression )
throws IllegalArgumentException
|
if name
is one of id or parent |
true |
|
true |
| JSF:JAVADOC:569 |
void |
jakarta.faces.component.UIComponent.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:570 |
void |
jakarta.faces.component.UIComponent.subscribeToEvent
( Class ,
ComponentSystemEventListener ) |
Install
the listener instance referenced by argument componentListener as a
listener for events of type eventClass originating from this specific
instance of UIComponent. The default implementation creates an inner
SystemEventListener instance that wraps argument componentListener as
the listener argument. This inner class must call through to the
argument componentListener in its implementation of
SystemEventListener#processEvent and its implementation of
SystemEventListener#isListenerForSource must return true if the
instance class of this UIComponent is assignable from the argument to
isListenerForSource. |
true |
|
true |
| JSF:JAVADOC:571 |
void |
jakarta.faces.component.UIComponent.subscribeToEvent
( Class ,
ComponentSystemEventListener )
throws <code>NullPointerException</code>
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:572 |
UIComponent |
jakarta.faces.component.UIComponent.UIComponent
|
|
true |
|
true |
| JSF:JAVADOC:573 |
void |
jakarta.faces.component.UIComponent.unsubscribeFromEvent
( Class ,
ComponentSystemEventListener ) |
Remove
the listener instance referenced by argument componentListener as a
listener for events of type eventClass originating from this specific
instance of UIComponent. When doing the comparison to determine if an
existing listener is equal to the argument componentListener (and thus
must be removed), the equals() method on the existing listener must be
invoked, passing the argument componentListener, rather than the other
way around. |
true |
|
true |
| JSF:JAVADOC:574 |
void |
jakarta.faces.component.UIComponent.unsubscribeFromEvent
( Class ,
ComponentSystemEventListener )
throws <code>NullPointerException</code>
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:575 |
boolean |
jakarta.faces.component.UIComponent.visitTree
( VisitContext ,
VisitCallback ) |
Perform
a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback directly, but instead call
VisitContext#invokeVisitCallback to invoke the callback. This allows
implementations to provide optimized tree traversals, for example by
only calling the for a subset of components. UIComponent.visitTree()
implementations must call UIComponent.pushComponentToEL() before
performing the visit and UIComponent.popComponentFromEL() after the
visit. |
true |
|
true |
| JSF:JAVADOC:576 |
void |
jakarta.faces.component.UIComponentBase.addClientBehavior
( String ,
ClientBehavior ) |
This is
a default implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#addClientBehavior.
UIComponent does not implement the
jakarta.faces.component.behavior.ClientBehaviorHolder interface, but
provides default implementations for the methods defined by
jakarta.faces.component.behavior.ClientBehaviorHolder to simplify
subclass implementations. Subclasses that wish to support the
jakarta.faces.component.behavior.ClientBehaviorHolder contract must
declare that the subclass implements
jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide
an implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. |
true |
|
true |
| JSF:JAVADOC:577 |
void |
jakarta.faces.component.UIComponentBase.broadcast
( FacesEvent ) |
Broadcast the specified FacesEvent to all registered event listeners
who have expressed an interest in events of this type. Listeners are
called in the order in which they were added. If the event is an
instance of jakarta.faces.event.BehaviorEvent and the current component
is the source of the event call
jakarta.faces.event.BehaviorEvent#getBehavior to get the
jakarta.faces.component.behavior.Behavior for the event. If the behavior
implements jakarta.faces.component.behavior.ClientBehavior, call
jakarta.faces.component.behavior.ClientBehavior#broadcast(jakarta.faces.event.BehaviorEvent)}.
|
true |
|
true |
| JSF:JAVADOC:578 |
void |
jakarta.faces.component.UIComponentBase.broadcast
( FacesEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:579 |
void |
jakarta.faces.component.UIComponentBase.broadcast
( FacesEvent )
throws IllegalArgumentException
|
if the
implementation class of this FacesEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:580 |
void |
jakarta.faces.component.UIComponentBase.broadcast
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:581 |
void |
jakarta.faces.component.UIComponentBase.clearInitialState
|
For
each of the attached objects on this instance that implement
PartialStateHolder, call PartialStateHolder#clearInitialState on the
attached object. |
true |
|
true |
| JSF:JAVADOC:582 |
void |
jakarta.faces.component.UIComponentBase.decode
( FacesContext ) |
Decode
any new state of this UIComponent from the request contained in the
specified FacesContext, and store this state as needed. During
decoding, events may be enqueued for later processing (by event
listeners who have registered an interest), by calling queueEvent(). |
true |
|
true |
| JSF:JAVADOC:583 |
void |
jakarta.faces.component.UIComponentBase.decode
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:584 |
void |
jakarta.faces.component.UIComponentBase.encodeBegin
( FacesContext ) |
If our
rendered property is true, render the beginning of the current state
of this UIComponent to the response contained in the specified
FacesContext. Call
#pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent).
Call jakarta.faces.application.Application#publishEvent, passing
jakarta.faces.event.PreRenderComponentEvent.class as the first argument
and the component instance to be rendered as the second argument. If a
Renderer is associated with this UIComponent, the actual encoding will
be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If
our rendered property is false, call
#pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent)
and return immediately. |
true |
|
true |
| JSF:JAVADOC:585 |
void |
jakarta.faces.component.UIComponentBase.encodeBegin
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:586 |
void |
jakarta.faces.component.UIComponentBase.encodeBegin
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:587 |
void |
jakarta.faces.component.UIComponentBase.encodeChildren
( FacesContext ) |
If our
rendered property is true, render the child UIComponents of this
UIComponent. This method will only be called if the rendersChildren
property is true. If a Renderer is associated with this UIComponent,
the actual encoding will be delegated to
Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is
associated with this UIComponent, iterate over each of the children of
this component and call #encodeAll(jakarta.faces.context.FacesContext).
|
true |
|
true |
| JSF:JAVADOC:588 |
void |
jakarta.faces.component.UIComponentBase.encodeChildren
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:589 |
void |
jakarta.faces.component.UIComponentBase.encodeChildren
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:590 |
void |
jakarta.faces.component.UIComponentBase.encodeEnd
( FacesContext ) |
If our
rendered property is true, render the ending of the current state of
this UIComponent. If a Renderer is associated with this UIComponent,
the actual encoding will be delegated to
Renderer#encodeEnd(FacesContext, UIComponent). Call
UIComponent#popComponentFromEL. before returning regardless of the
value of the rendered property. |
true |
|
true |
| JSF:JAVADOC:591 |
void |
jakarta.faces.component.UIComponentBase.encodeEnd
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:592 |
void |
jakarta.faces.component.UIComponentBase.encodeEnd
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:593 |
UIComponent |
jakarta.faces.component.UIComponentBase.findComponent
( String ) |
Search
for and return the UIComponent with an id that matches the specified
search expression (if any), according to the algorithm described
below. For a method to find a component given a simple clientId, see
#invokeOnComponent. Component identifiers are required to be unique
within the scope of the closest ancestor NamingContainer that encloses
this component (which might be this component itself). If there are no
NamingContainer components in the ancestry of this component, the root
component in the tree is treated as if it were a NamingContainer,
whether or not its class actually implements the NamingContainer
interface. A search expression consists of either an identifier (which
is matched exactly against the id property of a UIComponent, or a
series of such identifiers linked by the
UINamingContainer#getSeparatorChar character value. The search
algorithm should operates as follows, though alternate alogrithms may
be used as long as the end result is the same: Identify the
UIComponent that will be the base for searching, by stopping as soon
as one of the following conditions is met: If the search expression
begins with the the separator character (called an "absolute" search
expression), the base will be the root UIComponent of the component
tree. The leading separator character will be stripped off, and the
remainder of the search expression will be treated as a "relative"
search expression as described below. Otherwise, if this UIComponent
is a NamingContainer it will serve as the basis. Otherwise, search up
the parents of this component. If a NamingContainer is encountered, it
will be the base. Otherwise (if no NamingContainer is encountered) the
root UIComponent will be the base. The search expression (possibly
modified in the previous step) is now a "relative" search expression
that will be used to locate the component (if any) that has an id that
matches, within the scope of the base component. The match is
performed as follows: If the search expression is a simple identifier,
this value is compared to the id property, and then recursively
through the facets and children of the base UIComponent (except that
if a descendant NamingContainer is found, its own facets and children
are not searched). If the search expression includes more than one
identifier separated by the separator character, the first identifier
is used to locate a NamingContainer by the rules in the previous
bullet point. Then, the findComponent() method of this NamingContainer
will be called, passing the remainder of the search expression. |
true |
|
true |
| JSF:JAVADOC:594 |
UIComponent |
jakarta.faces.component.UIComponentBase.findComponent
( String )
throws IllegalArgumentException
|
if an
intermediate identifier in a search expression identifies a
UIComponent that is not a NamingContainer |
true |
|
true |
| JSF:JAVADOC:595 |
UIComponent |
jakarta.faces.component.UIComponentBase.findComponent
( String )
throws NullPointerException
|
if expr
is null |
true |
|
true |
| JSF:JAVADOC:596 |
Map |
jakarta.faces.component.UIComponentBase.getAttributes
|
Return
a mutable Map representing the attributes (and properties, see below)
associated wth this UIComponent, keyed by attribute name (which must
be a String). The returned implementation must support all of the
standard and optional Map methods, plus support the following
additional requirements: The Map implementation must implement the
java.io.Serializable interface. Any attempt to add a null key or value
must throw a NullPointerException. Any attempt to add a key that is
not a String must throw a ClassCastException. If the attribute name
specified as a key matches a property of this UIComponent's
implementation class, the following methods will have special
behavior: containsKey - Return false. get() - If the property is
readable, call the getter method and return the returned value
(wrapping primitive values in their corresponding wrapper classes);
otherwise throw IllegalArgumentException. put() - If the property is
writeable, call the setter method to set the corresponding value
(unwrapping primitive values in their corresponding wrapper classes).
If the property is not writeable, or an attempt is made to set a
property of primitive type to null, throw IllegalArgumentException.
remove - Throw IllegalArgumentException. |
true |
|
true |
| JSF:JAVADOC:597 |
int |
jakarta.faces.component.UIComponentBase.getChildCount
|
Return
the number of child UIComponents that are associated with this
UIComponent. If there are no children, this method must return 0. The
method must not cause the creation of a child component list. |
true |
|
true |
| JSF:JAVADOC:598 |
List |
jakarta.faces.component.UIComponentBase.getChildren
|
Return
a mutable List representing the child UIComponents associated with
this component. The returned implementation must support all of the
standard and optional List methods, plus support the following
additional requirements: The List implementation must implement the
java.io.Serializable interface. Any attempt to add a null must throw a
NullPointerException Any attempt to add an object that does not
implement UIComponent must throw a ClassCastException. Whenever a new
child component is added, the parent property of the child must be set
to this component instance. If the parent property of the child was
already non-null, the child must first be removed from its previous
parent (where it may have been either a child or a facet). Whenever an
existing child component is removed, the parent property of the child
must be set to null. After the child component has been added to the
view, if the following condition is not met:
jakarta.faces.context.FacesContext#isPostback returns true and
jakarta.faces.context.FacesContext#getCurrentPhaseId returns
jakarta.faces.event.PhaseId#RESTORE_VIEWjakarta.faces.application.Application#publishEvent
must be called, passing jakarta.faces.event.PostAddToViewEvent.class as
the first argument and the newly added component as the second
argument. |
true |
|
true |
| JSF:JAVADOC:599 |
Map |
jakarta.faces.component.UIComponentBase.getClientBehaviors
|
This is
a default implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getClientBehaviors.
UIComponent does not implement the
jakarta.faces.component.behavior.ClientBehaviorHolder interface, but
provides default implementations for the methods defined by
jakarta.faces.component.behavior.ClientBehaviorHolder to simplify
subclass implementations. Subclasses that wish to support the
jakarta.faces.component.behavior.ClientBehaviorHolder contract must
declare that the subclass implements
jakarta.faces.component.behavior.ClientBehaviorHolder, and must add an
implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. |
true |
|
true |
| JSF:JAVADOC:600 |
String |
jakarta.faces.component.UIComponentBase.getClientId
( FacesContext ) |
Return
a client-side identifier for this component, generating one if
necessary. The associated Renderer, if any, will be asked to convert
the clientId to a form suitable for transmission to the client. The
return from this method must be the same value throughout the lifetime
of the instance, unless the id property of the component is changed,
or the component is placed in a NamingContainer whose client ID
changes (for example, UIData). However, even in these cases,
consecutive calls to this method must always return the same value.
The implementation must follow these steps in determining the
clientId: Find the closest ancestor to this component in the view
hierarchy that implements NamingContainer. Call getContainerClientId()
on it and save the result as the parentId local variable. Call #getId
on this component and save the result as the myId local variable. If
myId is null, call context.getViewRoot().createUniqueId() and assign
the result to myId. If parentId is non-null, let myId equal parentId +
UINamingContainer#getSeparatorChar + myId. Call
Renderer#convertClientId, passing myId, and return the result. |
true |
|
true |
| JSF:JAVADOC:601 |
String |
jakarta.faces.component.UIComponentBase.getClientId
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:602 |
String |
jakarta.faces.component.UIComponentBase.getDefaultEventName
|
This is
a default implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName.
UIComponent does not implement the
jakarta.faces.component.behavior.ClientBehaviorHolder interface, but
provides default implementations for the methods defined by
jakarta.faces.component.behavior.ClientBehaviorHolder to simplify
subclass implementations. Subclasses that wish to support the
jakarta.faces.component.behavior.ClientBehaviorHolder contract must
declare that the subclass implements
jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide
an implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. |
true |
|
true |
| JSF:JAVADOC:603 |
Collection |
jakarta.faces.component.UIComponentBase.getEventNames
|
This is
a default implementation of
jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames.
UIComponent does not implement the
jakarta.faces.component.behavior.ClientBehaviorHolder interface, but
provides default implementations for the methods defined by
jakarta.faces.component.behavior.ClientBehaviorHolder to simplify
subclass implementations. Subclasses that wish to support the
jakarta.faces.component.behavior.ClientBehaviorHolder contract must
declare that the subclass implements
jakarta.faces.component.behavior.ClientBehaviorHolder, and must override
this method to return a non-Empty Collection of the client event names
that the component supports. |
true |
|
true |
| JSF:JAVADOC:604 |
UIComponent |
jakarta.faces.component.UIComponentBase.getFacet
( String ) |
Convenience method to return the named facet, if it exists, or null
otherwise. If the requested facet does not exist, the facets Map must
not be created. |
true |
|
true |
| JSF:JAVADOC:605 |
int |
jakarta.faces.component.UIComponentBase.getFacetCount
|
Return
the number of facet UIComponents that are associated with this
UIComponent. If there are no facets, this method must return 0. The
method must not cause the creation of a facet component map. For
backwards compatability with classes that extend UIComponent directly,
a default implementation is provided that simply calls #getFacets and
then calls the size() method on the returned Map. A more optimized
version of this method is provided in UIComponentBase#getFacetCount. |
true |
|
true |
| JSF:JAVADOC:606 |
Map |
jakarta.faces.component.UIComponentBase.getFacets
|
Return
a mutable Map representing the facet UIComponents associated with this
UIComponent, keyed by facet name (which must be a String). The
returned implementation must support all of the standard and optional
Map methods, plus support the following additional requirements: The
Map implementation must implement the java.io.Serializable interface.
Any attempt to add a null key or value must throw a
NullPointerException. Any attempt to add a key that is not a String
must throw a ClassCastException. Any attempt to add a value that is
not a UIComponent must throw a ClassCastException. Whenever a new
facet UIComponent is added: The parent property of the component must
be set to this component instance. If the parent property of the
component was already non-null, the component must first be removed
from its previous parent (where it may have been either a child or a
facet). Whenever an existing facet UIComponent is removed: The parent
property of the facet must be set to null. |
true |
|
true |
| JSF:JAVADOC:607 |
Iterator |
jakarta.faces.component.UIComponentBase.getFacetsAndChildren
|
Return
an Iterator over the facet followed by child UIComponents of this
UIComponent. Facets are returned in an undefined order, followed by
all the children in the order they are stored in the child list. If
this component has no facets or children, an empty Iterator is
returned. The returned Iterator must not support the remove()
operation. |
true |
|
true |
| JSF:JAVADOC:608 |
String |
jakarta.faces.component.UIComponentBase.getId
|
Return
the component identifier of this UIComponent. |
true |
|
true |
| JSF:JAVADOC:609 |
UIComponent |
jakarta.faces.component.UIComponentBase.getParent
|
Return
the parent UIComponent of this UIComponent, if any. A component must
allow child components to be added to and removed from the list of
children of this component, even though the child component returns
null from getParent( ). |
true |
|
true |
| JSF:JAVADOC:610 |
String |
jakarta.faces.component.UIComponentBase.getRendererType
|
Return
the Renderer type for this UIComponent (if any). |
true |
|
true |
| JSF:JAVADOC:611 |
boolean |
jakarta.faces.component.UIComponentBase.getRendersChildren
|
Return
a flag indicating whether this component is responsible for rendering
its child components. The default implementation in
UIComponentBase#getRendersChildren tries to find the renderer for this
component. If it does, it calls Renderer#getRendersChildren and
returns the result. If it doesn't, it returns false. As of version 1.2
of the Jakarta Server Faces Specification, component authors are
encouraged to return true from this method and rely on
UIComponentBase#encodeChildren. |
true |
|
true |
| JSF:JAVADOC:612 |
ValueBinding |
jakarta.faces.component.UIComponentBase.getValueBinding
( String ) |
|
true |
true |
true |
| JSF:JAVADOC:613 |
ValueBinding |
jakarta.faces.component.UIComponentBase.getValueBinding
( String )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:614 |
boolean |
jakarta.faces.component.UIComponentBase.invokeOnComponent
( FacesContext ,
String ,
ContextCallback ) |
|
true |
|
true |
| JSF:JAVADOC:615 |
boolean |
jakarta.faces.component.UIComponentBase.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws FacesException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:616 |
boolean |
jakarta.faces.component.UIComponentBase.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:617 |
boolean |
jakarta.faces.component.UIComponentBase.isRendered
|
Return
true if this component (and its children) should be rendered during
the Render Response phase of the request processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:618 |
boolean |
jakarta.faces.component.UIComponentBase.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:619 |
void |
jakarta.faces.component.UIComponentBase.markInitialState
|
For
each of the attached objects on this instance that implement
PartialStateHolder, call PartialStateHolder#markInitialState on the
attached object. |
true |
|
true |
| JSF:JAVADOC:620 |
void |
jakarta.faces.component.UIComponentBase.processDecodes
( FacesContext ) |
Perform
the component tree processing required by the Apply Request Values
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processDecodes() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). Call the decode() method of this component.
Call #popComponentFromEL from inside of a finally block, just before
returning. If a RuntimeException is thrown during decode processing,
call FacesContext#renderResponse and re-throw the exception. |
true |
|
true |
| JSF:JAVADOC:621 |
void |
jakarta.faces.component.UIComponentBase.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:622 |
void |
jakarta.faces.component.UIComponentBase.processRestoreState
( FacesContext ,
Object ) |
Perform
the component tree processing required by the Restore View phase of
the request processing lifecycle for all facets of this component, all
children of this component, and this component itself, as follows.
Call the restoreState() method of this component. Call
UIComponent#pushComponentToEL. Call the processRestoreState() method
of all facets and children of this UIComponent in the order determined
by a call to getFacetsAndChildren(). After returning from the
processRestoreState() method on a child or facet, call
UIComponent#popComponentFromEL This method may not be called if the
state saving method is set to server. |
true |
|
true |
| JSF:JAVADOC:623 |
void |
jakarta.faces.component.UIComponentBase.processRestoreState
( FacesContext ,
Object )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:624 |
Object |
jakarta.faces.component.UIComponentBase.processSaveState
( FacesContext ) |
Perform
the component tree processing required by the state saving portion of
the Render Response phase of the request processing lifecycle for all
facets of this component, all children of this component, and this
component itself, as follows. consult the transient property of this
component. If true, just return null. Call #pushComponentToEL. Call
the processSaveState() method of all facets and children of this
UIComponent in the order determined by a call to
getFacetsAndChildren(), skipping children and facets that are
transient. Ensure that #popComponentFromEL is called correctly after
each child or facet. Call the saveState() method of this component.
Encapsulate the child state and your state into a Serializable Object
and return it. This method may not be called if the state saving
method is set to server. |
true |
|
true |
| JSF:JAVADOC:625 |
Object |
jakarta.faces.component.UIComponentBase.processSaveState
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:626 |
void |
jakarta.faces.component.UIComponentBase.processUpdates
( FacesContext ) |
Perform
the component tree processing required by the Update Model Values
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processUpdates() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). After returning from the processUpdates()
method on a child or facet, call UIComponent#popComponentFromEL |
true |
|
true |
| JSF:JAVADOC:627 |
void |
jakarta.faces.component.UIComponentBase.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:628 |
void |
jakarta.faces.component.UIComponentBase.processValidators
( FacesContext ) |
Perform
the component tree processing required by the Process Validations
phase of the request processing lifecycle for all facets of this
component, all children of this component, and this component itself,
as follows. If the rendered property of this UIComponent is false,
skip further processing. Call #pushComponentToEL. Call the
processValidators() method of all facets and children of this
UIComponent, in the order determined by a call to
getFacetsAndChildren(). |
true |
|
true |
| JSF:JAVADOC:629 |
void |
jakarta.faces.component.UIComponentBase.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:630 |
void |
jakarta.faces.component.UIComponentBase.queueEvent
( FacesEvent ) |
Queue
an event for broadcast at the end of the current request processing
lifecycle phase. The default implementation in UIComponentBase must
delegate this call to the queueEvent() method of the parent
UIComponent. |
true |
|
true |
| JSF:JAVADOC:631 |
void |
jakarta.faces.component.UIComponentBase.queueEvent
( FacesEvent )
throws IllegalStateException
|
if this
component is not a descendant of a UIViewRoot |
true |
|
true |
| JSF:JAVADOC:632 |
void |
jakarta.faces.component.UIComponentBase.queueEvent
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:633 |
Object |
jakarta.faces.component.UIComponentBase.restoreAttachedState
( FacesContext ,
Object ) |
This
method is called by UIComponent subclasses that need to restore the
objects they saved using #saveAttachedState. This method is tightly
coupled with #saveAttachedState. This method supports restoring all
attached objects types supported by #saveAttachedState. |
true |
|
true |
| JSF:JAVADOC:634 |
Object |
jakarta.faces.component.UIComponentBase.restoreAttachedState
( FacesContext ,
Object )
throws IllegalStateException
|
if the
object is not previously returned by #saveAttachedState. |
true |
|
true |
| JSF:JAVADOC:635 |
Object |
jakarta.faces.component.UIComponentBase.restoreAttachedState
( FacesContext ,
Object )
throws NullPointerException
|
if
context is null. |
true |
|
true |
| JSF:JAVADOC:636 |
void |
jakarta.faces.component.UIComponentBase.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:637 |
Object |
jakarta.faces.component.UIComponentBase.saveAttachedState
( FacesContext ,
Object ) |
This
method is called by UIComponent subclasses that want to save one or
more attached objects. It is a convenience method that does the work
of saving attached objects that may or may not implement the
StateHolder interface. Using this method implies the use of
#restoreAttachedState to restore the attached objects. This method
supports saving attached objects of the following type: Objects, null
values, and Collections of these objects. If any contained objects are
not Collections and do not implement StateHolder, they must have
zero-argument public constructors. The exact structure of the returned
object is undefined and opaque, but will be serializable. |
true |
|
true |
| JSF:JAVADOC:638 |
Object |
jakarta.faces.component.UIComponentBase.saveAttachedState
( FacesContext ,
Object )
throws NullPointerException
|
if the
context argument is null. |
true |
|
true |
| JSF:JAVADOC:639 |
Object |
jakarta.faces.component.UIComponentBase.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:640 |
void |
jakarta.faces.component.UIComponentBase.setId
( String ) |
Set the
component identifier of this UIComponent (if any). Component
identifiers must obey the following syntax restrictions: Must not be a
zero-length String. First character must be a letter or an underscore
('_'). Subsequent characters must be a letter, a digit, an underscore
('_'), or a dash ('-'). Component identifiers must also obey the
following semantic restrictions (note that this restriction is NOT
enforced by the setId() implementation): The specified identifier must
be unique among all the components (including facets) that are
descendents of the nearest ancestor UIComponent that is a
NamingContainer, or within the scope of the entire component tree if
there is no such ancestor that is a NamingContainer. |
true |
|
true |
| JSF:JAVADOC:641 |
void |
jakarta.faces.component.UIComponentBase.setId
( String )
throws IllegalArgumentException
|
if id is
not syntactically valid |
true |
|
true |
| JSF:JAVADOC:642 |
void |
jakarta.faces.component.UIComponentBase.setParent
( UIComponent ) |
Set the
parent UIComponent of this UIComponent. This method will cause an
jakarta.faces.event.PostAddToViewEvent to be published and if
parent.isInView() returns true an jakarta.faces.event.PostAddToViewEvent
will be published as well. This method must never be called by
developers; a UIComponent's internal implementation will call it as
components are added to or removed from a parent's child List or facet
Map. |
true |
|
true |
| JSF:JAVADOC:643 |
void |
jakarta.faces.component.UIComponentBase.setRendered
( boolean ) |
Set the
rendered property of this UIComponent. |
true |
|
true |
| JSF:JAVADOC:644 |
void |
jakarta.faces.component.UIComponentBase.setRendererType
( String ) |
Set the
Renderer type for this UIComponent, or null for components that render
themselves. |
true |
|
true |
| JSF:JAVADOC:645 |
void |
jakarta.faces.component.UIComponentBase.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:646 |
void |
jakarta.faces.component.UIComponentBase.setValueBinding
( String ,
ValueBinding ) |
|
true |
true |
true |
| JSF:JAVADOC:647 |
void |
jakarta.faces.component.UIComponentBase.setValueBinding
( String ,
ValueBinding )
throws IllegalArgumentException
|
if name
is one of id or parent |
true |
true |
true |
| JSF:JAVADOC:648 |
void |
jakarta.faces.component.UIComponentBase.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:649 |
UIComponentBase |
jakarta.faces.component.UIComponentBase.UIComponentBase
|
|
true |
|
true |
| JSF:JAVADOC:650 |
void |
jakarta.faces.component.UIData.broadcast
( FacesEvent ) |
Override the default UIComponentBase#broadcast processing to unwrap
any wrapped FacesEvent and reset the current row index, before the
event is actually broadcast. For events that we did not wrap (in
queueEvent()), default processing will occur. |
true |
|
true |
| JSF:JAVADOC:651 |
void |
jakarta.faces.component.UIData.broadcast
( FacesEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:652 |
void |
jakarta.faces.component.UIData.broadcast
( FacesEvent )
throws IllegalArgumentException
|
if the
implementation class of this FacesEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:653 |
void |
jakarta.faces.component.UIData.broadcast
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:654 |
String |
jakarta.faces.component.UIData.createUniqueId
( FacesContext ,
String ) |
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
component-container. Optionally, a unique seed value can be supplied
by component creators which should be included in the generated unique
id. |
true |
|
true |
| JSF:JAVADOC:655 |
void |
jakarta.faces.component.UIData.encodeBegin
( FacesContext ) |
In
addition to the default behavior, ensure that any saved per-row state
for our child input components is discarded unless it is needed to
rerender the current page with errors. |
true |
|
true |
| JSF:JAVADOC:656 |
void |
jakarta.faces.component.UIData.encodeBegin
( FacesContext )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:657 |
void |
jakarta.faces.component.UIData.encodeBegin
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:658 |
String |
jakarta.faces.component.UIData.getClientId
( FacesContext ) |
Return
a client identifier for this component that includes the current value
of the rowIndex property, if it is not set to -1. This implies that
multiple calls to getClientId() may return different results, but
ensures that child components can themselves generate row-specific
client identifiers (since UIData is a NamingContainer). |
true |
|
true |
| JSF:JAVADOC:659 |
String |
jakarta.faces.component.UIData.getClientId
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:660 |
String |
jakarta.faces.component.UIData.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:661 |
int |
jakarta.faces.component.UIData.getFirst
|
Return
the zero-relative row number of the first row to be displayed. |
true |
|
true |
| JSF:JAVADOC:662 |
UIComponent |
jakarta.faces.component.UIData.getFooter
|
Return
the footer facet of this component (if any). A convenience method for
getFacet("footer"). |
true |
|
true |
| JSF:JAVADOC:663 |
UIComponent |
jakarta.faces.component.UIData.getHeader
|
Return
the header facet of this component (if any). A convenience method for
getFacet("header"). |
true |
|
true |
| JSF:JAVADOC:664 |
int |
jakarta.faces.component.UIData.getRowCount
|
Return
the number of rows in the underlying data model. If the number of
available rows is unknown, return -1. |
true |
|
true |
| JSF:JAVADOC:665 |
int |
jakarta.faces.component.UIData.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:666 |
Object |
jakarta.faces.component.UIData.getRowData
|
Return
the data object representing the data for the currently selected row
index, if any. |
true |
|
true |
| JSF:JAVADOC:667 |
Object |
jakarta.faces.component.UIData.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:668 |
Object |
jakarta.faces.component.UIData.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:669 |
int |
jakarta.faces.component.UIData.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, return -1. This property is not enabled
for value binding expressions. |
true |
|
true |
| JSF:JAVADOC:670 |
int |
jakarta.faces.component.UIData.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:671 |
int |
jakarta.faces.component.UIData.getRows
|
Return
the number of rows to be displayed, or zero for all remaining rows in
the table. The default value of this property is zero. |
true |
|
true |
| JSF:JAVADOC:672 |
Object |
jakarta.faces.component.UIData.getValue
|
Return
the value of the UIData. This value must either be be of type
DataModel, or a type that can be adapted into a DataModel. UIData will
automatically adapt the following types: Arrays java.util.List
java.sql.ResultSet jakarta.servlet.jsp.jstl.sql.Result All other types
will be adapted using the ScalarDataModel class, which will treat the
object as a single row of data. |
true |
|
true |
| JSF:JAVADOC:673 |
String |
jakarta.faces.component.UIData.getVar
|
Return
the request-scope attribute under which the data object for the
current row will be exposed when iterating. This property is not
enabled for value binding expressions. |
true |
|
true |
| JSF:JAVADOC:674 |
boolean |
jakarta.faces.component.UIData.invokeOnComponent
( FacesContext ,
String ,
ContextCallback ) |
Override behavior from UIComponentBase#invokeOnComponent to provide
special care for positioning the data properly before finding the
component and invoking the callback on it. If the argument clientId is
equal to this.getClientId() simply invoke the contextCallback, passing
the context argument and this as arguments, and return true. If the
argument clientId is not equal to this.getClientId(), inspect each of
the facet children of this UIData instance and for each one, compare
its clientId with the argument clientId. If there is a match, invoke
the contextCallback, passing the context argument and this as
arguments, and return true. Otherwise, attempt to extract a rowIndex
from the clientId. For example, if the argument clientId was
form:data:3:customerHeader the rowIndex would be 3. Let this value be
called newIndex. The current rowIndex of this instance must be saved
aside and restored before returning in all cases, regardless of the
outcome of the search or if any exceptions are thrown in the process.
The implementation of this method must never return true if setting
the rowIndex of this instance to be equal to newIndex causes this
instance to return false from #isRowAvailable. |
true |
|
true |
| JSF:JAVADOC:675 |
boolean |
jakarta.faces.component.UIData.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws FacesException
|
{@inheritDoc}
Also throws FacesException if any exception is thrown when deriving
the rowIndex from the argument clientId. |
true |
|
true |
| JSF:JAVADOC:676 |
boolean |
jakarta.faces.component.UIData.invokeOnComponent
( FacesContext ,
String ,
ContextCallback )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:677 |
boolean |
jakarta.faces.component.UIData.isRowAvailable
|
Return
a flag indicating whether there is rowData available at the current
rowIndex. If no wrappedData is available, return false. |
true |
|
true |
| JSF:JAVADOC:678 |
boolean |
jakarta.faces.component.UIData.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:679 |
void |
jakarta.faces.component.UIData.processDecodes
( FacesContext ) |
Override the default UIComponentBase#processDecodes processing to
perform the following steps. If the rendered property of this
UIComponent is false, skip further processing. Set the current
rowIndex to -1. Call the processDecodes() method of all facets of this
UIData, in the order determined by a call to
getFacets().keySet().iterator(). Call the processDecodes() method of
all facets of the UIColumn children of this UIData. Iterate over the
set of rows that were included when this component was rendered (i.e.
those defined by the first and rows properties), performing the
following processing for each row: Set the current rowIndex to the
appropriate value for this row. If isRowAvailable() returns true,
iterate over the children components of each UIColumn child of this
UIData component, calling the processDecodes() method for each such
child. Set the current rowIndex to -1. Call the decode() method of
this component. If a RuntimeException is thrown during decode
processing, call FacesContext#renderResponse and re-throw the
exception. |
true |
|
true |
| JSF:JAVADOC:680 |
void |
jakarta.faces.component.UIData.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:681 |
void |
jakarta.faces.component.UIData.processUpdates
( FacesContext ) |
Override the default UIComponentBase#processUpdates processing to
perform the following steps. If the rendered property of this
UIComponent is false, skip further processing. Set the current
rowIndex to -1. Call the processUpdates() method of all facets of this
UIData, in the order determined by a call to
getFacets().keySet().iterator(). Call the processUpdates() method of
all facets of the UIColumn children of this UIData. Iterate over the
set of rows that were included when this component was rendered (i.e.
those defined by the first and rows properties), performing the
following processing for each row: Set the current rowIndex to the
appropriate value for this row. If isRowAvailable() returns true,
iterate over the children components of each UIColumn child of this
UIData component, calling the processUpdates() method for each such
child. Set the current rowIndex to -1. |
true |
|
true |
| JSF:JAVADOC:682 |
void |
jakarta.faces.component.UIData.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:683 |
void |
jakarta.faces.component.UIData.processValidators
( FacesContext ) |
Override the default UIComponentBase#processValidators processing to
perform the following steps. If the rendered property of this
UIComponent is false, skip further processing. Set the current
rowIndex to -1. Call the processValidators() method of all facets of
this UIData, in the order determined by a call to
getFacets().keySet().iterator(). Call the processValidators() method
of all facets of the UIColumn children of this UIData. Iterate over
the set of rows that were included when this component was rendered
(i.e. those defined by the first and rows properties), performing the
following processing for each row: Set the current rowIndex to the
appropriate value for this row. If isRowAvailable() returns true,
iterate over the children components of each UIColumn child of this
UIData component, calling the processValidators() method for each such
child. Set the current rowIndex to -1. |
true |
|
true |
| JSF:JAVADOC:684 |
void |
jakarta.faces.component.UIData.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:685 |
void |
jakarta.faces.component.UIData.queueEvent
( FacesEvent ) |
Override the default UIComponentBase#queueEvent processing to wrap any
queued events in a wrapper so that we can reset the current row index
in broadcast(). |
true |
|
true |
| JSF:JAVADOC:686 |
void |
jakarta.faces.component.UIData.queueEvent
( FacesEvent )
throws IllegalStateException
|
if this
component is not a descendant of a UIViewRoot |
true |
|
true |
| JSF:JAVADOC:687 |
void |
jakarta.faces.component.UIData.queueEvent
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:688 |
void |
jakarta.faces.component.UIData.setFirst
( int ) |
Set the
zero-relative row number of the first row to be displayed. |
true |
|
true |
| JSF:JAVADOC:689 |
void |
jakarta.faces.component.UIData.setFirst
( int )
throws IllegalArgumentException
|
if first
is negative |
true |
|
true |
| JSF:JAVADOC:690 |
void |
jakarta.faces.component.UIData.setFooter
( UIComponent ) |
Set the
footer facet of this component. A convenience method for
getFacets().put("footer", footer). |
true |
|
true |
| JSF:JAVADOC:691 |
void |
jakarta.faces.component.UIData.setFooter
( UIComponent )
throws NullPointerException
|
if
footer is null |
true |
|
true |
| JSF:JAVADOC:692 |
void |
jakarta.faces.component.UIData.setHeader
( UIComponent ) |
Set the
header facet of this component. A convenience method for
getFacets().put("header", header). |
true |
|
true |
| JSF:JAVADOC:693 |
void |
jakarta.faces.component.UIData.setHeader
( UIComponent )
throws NullPointerException
|
if
header is null |
true |
|
true |
| JSF:JAVADOC:694 |
void |
jakarta.faces.component.UIData.setRowIndex
( int ) |
Set the
zero relative index of the current row, or -1 to indicate that no row
is currently selected, by implementing the following algorithm. It is
possible to set the row index at a value for which the underlying data
collection does not contain any row data. Therefore, callers may use
the isRowAvailable() method to detect whether row data will be
available for use by the getRowData() method. Save current state
information for all descendant components (as described below). Store
the new row index, and pass it on to the DataModel associated with
this UIData instance. If the new rowIndex value is -1: If the var
property is not null, remove the corresponding request scope attribute
(if any). Reset the state information for all descendant components
(as described below). If the new rowIndex value is not -1: If the var
property is not null, call getRowData() and expose the resulting data
object as a request scope attribute whose key is the var property
value. Reset the state information for all descendant components (as
described below). To save current state information for all descendant
components, UIData must maintain per-row information for each
descendant as follows: If the descendant is an instance of
EditableValueHolder, save the state of its localValue property. If the
descendant is an instance of EditableValueHolder, save the state of
the localValueSet property. If the descendant is an instance of
EditableValueHolder, save the state of the valid property. If the
descendant is an instance of EditableValueHolder, save the state of
the submittedValue property. To restore current state information for
all descendant components, UIData must reference its previously stored
information for the current rowIndex and call setters for each
descendant as follows: If the descendant is an instance of
EditableValueHolder, restore the value property. If the descendant is
an instance of EditableValueHolder, restore the state of the
localValueSet property. If the descendant is an instance of
EditableValueHolder, restore the state of the valid property. If the
descendant is an instance of EditableValueHolder, restore the state of
the submittedValue property. |
true |
|
true |
| JSF:JAVADOC:695 |
void |
jakarta.faces.component.UIData.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:696 |
void |
jakarta.faces.component.UIData.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:697 |
void |
jakarta.faces.component.UIData.setRows
( int ) |
Set the
number of rows to be displayed, or zero for all remaining rows in the
table. |
true |
|
true |
| JSF:JAVADOC:698 |
void |
jakarta.faces.component.UIData.setRows
( int )
throws IllegalArgumentException
|
if rows
is negative |
true |
|
true |
| JSF:JAVADOC:699 |
void |
jakarta.faces.component.UIData.setValue
( Object ) |
Set the
value of the UIData. This value must either be be of type DataModel,
or a type that can be adapted into a DataModel. |
true |
|
true |
| JSF:JAVADOC:700 |
void |
jakarta.faces.component.UIData.setValueBinding
( String ,
ValueBinding ) |
If
"name" is something other than "value", "var", or "rowIndex", rely on
the superclass conversion from ValueBinding to ValueExpression. |
true |
true |
true |
| JSF:JAVADOC:701 |
void |
jakarta.faces.component.UIData.setValueBinding
( String ,
ValueBinding )
throws IllegalArgumentException
|
if name
is one of id, parent, var, or rowIndex |
true |
true |
true |
| JSF:JAVADOC:702 |
void |
jakarta.faces.component.UIData.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:703 |
void |
jakarta.faces.component.UIData.setValueExpression
( String ,
ValueExpression ) |
Set the
ValueExpression used to calculate the value for the specified
attribute or property name, if any. In addition, if a ValueExpression
is set for the value property, remove any synthesized DataModel for
the data previously bound to this component. |
true |
|
true |
| JSF:JAVADOC:704 |
void |
jakarta.faces.component.UIData.setValueExpression
( String ,
ValueExpression )
throws IllegalArgumentException
|
if name
is one of id, parent, var, or rowIndex |
true |
|
true |
| JSF:JAVADOC:705 |
void |
jakarta.faces.component.UIData.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:706 |
void |
jakarta.faces.component.UIData.setVar
( String ) |
Set the
request-scope attribute under which the data object for the current
row wil be exposed when iterating. |
true |
|
true |
| JSF:JAVADOC:707 |
UIData |
jakarta.faces.component.UIData.UIData
|
Create
a new UIData instance with default property values. |
true |
|
true |
| JSF:JAVADOC:708 |
boolean |
jakarta.faces.component.UIData.visitTree
( VisitContext ,
VisitCallback ) |
Override the behavior in UIComponent#visitTree to handle iteration
correctly. If the UIComponent#isVisitable method of this instance
returns false, take no action and return. Otherwise, save aside the
result of a call to #getRowIndex. Call UIComponent#pushComponentToEL
and invoke the visit callback on this UIData instance as described in
UIComponent#visitTree. Let the result of the invoctaion be
visitResult. If visitResult is VisitResult#COMPLETE, take no further
action and return true. Otherwise, determine if we need to visit our
children. The default implementation calls
VisitContext#getSubtreeIdsToVisit passing this as the argument. If the
result of that call is non-empty, let doVisitChildren be true. If
doVisitChildren is true and visitResult is VisitResult#ACCEPT, take
the following action. If this component has facets, call
UIComponent#getFacets on this instance and invoke the values() method.
For each UIComponent in the returned Map, call UIComponent#visitTree.
If this component has children, for each child UIComponent retured
from calling #getChildren on this instance, if the child has facets,
call UIComponent#getFacets on the child instance and invoke the
values() method. For each UIComponent in the returned Map, call
UIComponent#visitTree. Iterate over the columns and rows. Let
rowsToProcess be the return from #getRows. Let rowIndex be the return
from #getFirst - 1. While the number of rows processed is less than
rowsToProcess, take the following actions. Call #setRowIndex, passing
the current row index. If #isRowAvailable returns false, take no
further action and return false. For each child component of this
UIData that is also an instance of UIColumn, call
UIComponent#visitTree on the child. If such a call returns true,
terminate iteration and return true. Take no action on non UIColumn
children. Call #popComponentFromEL and restore the saved row index
with a call to #setRowIndex. Return false to allow the visiting to
continue. |
true |
|
true |
| JSF:JAVADOC:709 |
boolean |
jakarta.faces.component.UIData.visitTree
( VisitContext ,
VisitCallback )
throws NullPointerException
|
if any
of the parameters are null. |
true |
|
true |
| JSF:JAVADOC:710 |
String |
jakarta.faces.component.UIForm.createUniqueId
( FacesContext ,
String ) |
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
component-container. Optionally, a unique seed value can be supplied
by component creators which should be included in the generated unique
id. |
true |
|
true |
| JSF:JAVADOC:711 |
String |
jakarta.faces.component.UIForm.getContainerClientId
( FacesContext ) |
Override the UIComponent#getContainerClientId to allow users to
disable this form from prepending its clientId to its descendent's
clientIds depending on the value of this form's #isPrependId property.
|
true |
|
true |
| JSF:JAVADOC:712 |
String |
jakarta.faces.component.UIForm.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:713 |
boolean |
jakarta.faces.component.UIForm.isPrependId
|
The
prependId flag. |
true |
|
true |
| JSF:JAVADOC:714 |
boolean |
jakarta.faces.component.UIForm.isSubmitted
|
Returns
the current value of the submitted property. The default value is
false. See #setSubmitted for details. |
true |
|
true |
| JSF:JAVADOC:715 |
void |
jakarta.faces.component.UIForm.processDecodes
( FacesContext ) |
Override UIComponent#processDecodes to ensure that the form is decoded
before its children. This is necessary to allow the submitted property
to be correctly set. |
true |
|
true |
| JSF:JAVADOC:716 |
void |
jakarta.faces.component.UIForm.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:717 |
void |
jakarta.faces.component.UIForm.processUpdates
( FacesContext ) |
Override UIComponent#processUpdates to ensure that the children of
this UIForm instance are only processed if #isSubmitted returns true.
|
true |
|
true |
| JSF:JAVADOC:718 |
void |
jakarta.faces.component.UIForm.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:719 |
void |
jakarta.faces.component.UIForm.processValidators
( FacesContext ) |
Override UIComponent#processValidators to ensure that the children of
this UIForm instance are only processed if #isSubmitted returns true.
|
true |
|
true |
| JSF:JAVADOC:720 |
void |
jakarta.faces.component.UIForm.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:721 |
void |
jakarta.faces.component.UIForm.setPrependId
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:722 |
void |
jakarta.faces.component.UIForm.setSubmitted
( boolean ) |
If this
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 for this UIForm instance. If this UIForm instance
is not experiencing a submit, this method must be called, with false
as the argument, during the UIComponent#decode for this UIForm
instance. The value of a UIForm's submitted property must not be saved
as part of its state. |
true |
|
true |
| JSF:JAVADOC:723 |
UIForm |
jakarta.faces.component.UIForm.UIForm
|
Create
a new UIForm instance with default property values. |
true |
|
true |
| JSF:JAVADOC:724 |
boolean |
jakarta.faces.component.UIForm.visitTree
( VisitContext ,
VisitCallback ) |
Perform
a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback directly, but instead call
VisitContext#invokeVisitCallback to invoke the callback. This allows
implementations to provide optimized tree traversals, for example by
only calling the for a subset of components. UIComponent.visitTree()
implementations must call UIComponent.pushComponentToEL() before
performing the visit and UIComponent.popComponentFromEL() after the
visit. |
true |
|
true |
| JSF:JAVADOC:725 |
String |
jakarta.faces.component.UIGraphic.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:726 |
String |
jakarta.faces.component.UIGraphic.getUrl
|
Return
the image URL for this UIGraphic. This method is a typesafe alias for
getValue(). |
true |
|
true |
| JSF:JAVADOC:727 |
Object |
jakarta.faces.component.UIGraphic.getValue
|
Returns
the value property of the UIGraphic. This will typically be rendered
as an URL. |
true |
|
true |
| JSF:JAVADOC:728 |
ValueBinding |
jakarta.faces.component.UIGraphic.getValueBinding
( String ) |
Return
any ValueBinding set for value if a ValueBinding for url is requested;
otherwise, perform the default superclass processing for this method.
|
true |
true |
true |
| JSF:JAVADOC:729 |
ValueBinding |
jakarta.faces.component.UIGraphic.getValueBinding
( String )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:730 |
ValueExpression |
jakarta.faces.component.UIGraphic.getValueExpression
( String ) |
Return
any ValueExpression set for value if a ValueExpression for url is
requested; otherwise, perform the default superclass processing for
this method. |
true |
|
true |
| JSF:JAVADOC:731 |
ValueExpression |
jakarta.faces.component.UIGraphic.getValueExpression
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:732 |
void |
jakarta.faces.component.UIGraphic.setUrl
( String ) |
Set the
image URL for this UIGraphic. This method is a typesafe alias for
setValue(). |
true |
|
true |
| JSF:JAVADOC:733 |
void |
jakarta.faces.component.UIGraphic.setValue
( Object ) |
Sets
the value property of the UIGraphic. This will typically be rendered
as an URL. |
true |
|
true |
| JSF:JAVADOC:734 |
void |
jakarta.faces.component.UIGraphic.setValueBinding
( String ,
ValueBinding ) |
Store
any ValueBinding specified for url under value instead; otherwise,
perform the default superclass processing for this method. In all
cases, the superclass is relied on to convert the ValueBinding to a
ValueExpression. |
true |
true |
true |
| JSF:JAVADOC:735 |
void |
jakarta.faces.component.UIGraphic.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:736 |
void |
jakarta.faces.component.UIGraphic.setValueExpression
( String ,
ValueExpression ) |
Store
any ValueExpression specified for url under value instead; otherwise,
perform the default superclass processing for this method. |
true |
|
true |
| JSF:JAVADOC:737 |
void |
jakarta.faces.component.UIGraphic.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:738 |
UIGraphic |
jakarta.faces.component.UIGraphic.UIGraphic
|
Create
a new UIGraphic instance with default property values. |
true |
|
true |
| JSF:JAVADOC:739 |
void |
jakarta.faces.component.UIInput.addValidator
( Validator ) |
Add a
Validator instance to the set associated with this UIInput. |
true |
|
true |
| JSF:JAVADOC:740 |
void |
jakarta.faces.component.UIInput.addValidator
( Validator )
throws NullPointerException
|
if
validator is null |
true |
|
true |
| JSF:JAVADOC:741 |
void |
jakarta.faces.component.UIInput.addValueChangeListener
( ValueChangeListener ) |
Add a
new ValueChangeListener to the set of listeners interested in being
notified when ValueChangeEvents occur. |
true |
|
true |
| JSF:JAVADOC:742 |
void |
jakarta.faces.component.UIInput.addValueChangeListener
( ValueChangeListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:743 |
void |
jakarta.faces.component.UIInput.clearInitialState
|
For
each of the attached objects on this instance that implement
PartialStateHolder, call PartialStateHolder#clearInitialState on the
attached object. |
true |
|
true |
| JSF:JAVADOC:744 |
void |
jakarta.faces.component.UIInput.decode
( FacesContext ) |
Decode
any new state of this UIComponent from the request contained in the
specified FacesContext, and store this state as needed. During
decoding, events may be enqueued for later processing (by event
listeners who have registered an interest), by calling queueEvent(). |
true |
|
true |
| JSF:JAVADOC:745 |
void |
jakarta.faces.component.UIInput.decode
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:746 |
String |
jakarta.faces.component.UIInput.getConverterMessage
|
If
there has been a call to #setConverterMessage on this instance, return
the message. Otherwise, call #getValueExpression passing the key
"converterMessage", get the result of the expression, and return it.
Any ELExceptions thrown during the call to getValue() must be wrapped
in a FacesException and rethrown. |
true |
|
true |
| JSF:JAVADOC:747 |
String |
jakarta.faces.component.UIInput.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:748 |
String |
jakarta.faces.component.UIInput.getRequiredMessage
|
If
there has been a call to #setRequiredMessage on this instance, return
the message. Otherwise, call #getValueExpression passing the key
"requiredMessage", get the result of the expression, and return it.
Any ELExceptions thrown during the call to getValue() must be wrapped
in a FacesException and rethrown. |
true |
|
true |
| JSF:JAVADOC:749 |
Object |
jakarta.faces.component.UIInput.getSubmittedValue
|
Return
the submittedValue value of this UIInput component. This method should
only be used by the decode() and validate() method of this component,
or its corresponding Renderer. |
true |
|
true |
| JSF:JAVADOC:750 |
MethodBinding |
jakarta.faces.component.UIInput.getValidator
|
Return
a MethodBinding pointing at a method that will be called during
Process Validations phase of the request processing lifecycle, to
validate the current value of this component. |
true |
true |
true |
| JSF:JAVADOC:751 |
String |
jakarta.faces.component.UIInput.getValidatorMessage
|
If
there has been a call to #setValidatorMessage on this instance, return
the message. Otherwise, call #getValueExpression passing the key
"validatorMessage", get the result of the expression, and return it.
Any ELExceptions thrown during the call to getValue() must be wrapped
in a FacesException and rethrown. |
true |
|
true |
| JSF:JAVADOC:752 |
Validator[] |
jakarta.faces.component.UIInput.getValidators
|
Return
the set of registered Validators for this UIInput instance. If there
are no registered validators, a zero-length array is returned. |
true |
|
true |
| JSF:JAVADOC:753 |
MethodBinding |
jakarta.faces.component.UIInput.getValueChangeListener
|
If
#setValueChangeListener was not previously called for this instance,
this method must return null. If it was called, this method must
return the exact MethodBinding instance that was passed to
#setValueChangeListener. |
true |
true |
true |
| JSF:JAVADOC:754 |
ValueChangeListener[] |
jakarta.faces.component.UIInput.getValueChangeListeners
|
Return
the set of registered ValueChangeListeners for this UIInput instance.
If there are no registered listeners, a zero-length array is returned.
|
true |
|
true |
| JSF:JAVADOC:755 |
boolean |
jakarta.faces.component.UIInput.isEmpty
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:756 |
boolean |
jakarta.faces.component.UIInput.isImmediate
|
Return
the "immediate" state for this component. |
true |
|
true |
| JSF:JAVADOC:757 |
boolean |
jakarta.faces.component.UIInput.isLocalValueSet
|
Return
the "local value set" state for this component. Calls to setValue()
automatically reset this property to true. |
true |
|
true |
| JSF:JAVADOC:758 |
boolean |
jakarta.faces.component.UIInput.isRequired
|
Return
the "required field" state for this component. |
true |
|
true |
| JSF:JAVADOC:759 |
boolean |
jakarta.faces.component.UIInput.isValid
|
Return
a flag indicating whether the local value of this component is valid
(no conversion error has occurred). |
true |
|
true |
| JSF:JAVADOC:760 |
void |
jakarta.faces.component.UIInput.markInitialState
|
In
addition to the actions taken in UIOutput when
PartialStateHolder#markInitialState() is called, check if any of the
installed Validators are PartialStateHolders and if so, call
jakarta.faces.component.PartialStateHolder#markInitialState() as
appropriate. |
true |
|
true |
| JSF:JAVADOC:761 |
void |
jakarta.faces.component.UIInput.processDecodes
( FacesContext ) |
Specialized decode behavior on top of that provided by the superclass.
In addition to the standard processDecodes behavior inherited from
UIComponentBase, calls validate() if the the immediate property is
true; if the component is invalid afterwards or a RuntimeException is
thrown, calls FacesContext#renderResponse. |
true |
|
true |
| JSF:JAVADOC:762 |
void |
jakarta.faces.component.UIInput.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:763 |
void |
jakarta.faces.component.UIInput.processUpdates
( FacesContext ) |
In
addition to the standard processUpdates behavior inherited from
UIComponentBase, calls updateModel(). If the component is invalid
afterwards, calls FacesContext#renderResponse. If a RuntimeException
is thrown during update processing, calls FacesContext#renderResponse
and re-throw the exception. |
true |
|
true |
| JSF:JAVADOC:764 |
void |
jakarta.faces.component.UIInput.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:765 |
void |
jakarta.faces.component.UIInput.processValidators
( FacesContext ) |
In
addition to the standard 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 a RuntimeException is thrown during
validation processing, calls FacesContext#renderResponse and re-throw
the exception. |
true |
|
true |
| JSF:JAVADOC:766 |
void |
jakarta.faces.component.UIInput.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:767 |
void |
jakarta.faces.component.UIInput.removeValidator
( Validator ) |
Remove
a Validator instance from the set associated with this UIInput, if it
was previously associated. Otherwise, do nothing. |
true |
|
true |
| JSF:JAVADOC:768 |
void |
jakarta.faces.component.UIInput.removeValueChangeListener
( ValueChangeListener ) |
Remove
an existing ValueChangeListener (if any) from the set of listeners
interested in being notified when ValueChangeEvents occur. |
true |
|
true |
| JSF:JAVADOC:769 |
void |
jakarta.faces.component.UIInput.removeValueChangeListener
( ValueChangeListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:770 |
void |
jakarta.faces.component.UIInput.resetValue
|
Convenience method to reset this component's value to the
un-initialized state. This method does the following: Call #setValue
passing null. Call #setSubmittedValue passing null. Call
#setLocalValueSet passing false. Call #setValid passing true. Upon
return from this call if the instance had a ValueBinding associated
with it for the "value" property, this binding is evaluated when
UIOutput#getValue is called. Otherwise, null is returned from
getValue(). |
true |
|
true |
| JSF:JAVADOC:771 |
void |
jakarta.faces.component.UIInput.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:772 |
Object |
jakarta.faces.component.UIInput.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:773 |
void |
jakarta.faces.component.UIInput.setConverterMessage
( String ) |
Override any ValueExpression set for the "converterMessage" with the
literal argument provided to this method. Subsequent calls to
#getConverterMessage will return this value; |
true |
|
true |
| JSF:JAVADOC:774 |
void |
jakarta.faces.component.UIInput.setImmediate
( boolean ) |
Set the
"immediate" state for this component. When set to true, the
component's value will be converted and validated immediately in the
Apply Request Values phase, and ValueChangeEvents will be delivered in
that phase as well. The default value for this property must be false.
|
true |
|
true |
| JSF:JAVADOC:775 |
void |
jakarta.faces.component.UIInput.setLocalValueSet
( boolean ) |
Sets
the "local value set" state for this component. |
true |
|
true |
| JSF:JAVADOC:776 |
void |
jakarta.faces.component.UIInput.setRequired
( boolean ) |
Set the
"required field" state for this component. |
true |
|
true |
| JSF:JAVADOC:777 |
void |
jakarta.faces.component.UIInput.setRequiredMessage
( String ) |
Override any ValueExpression set for the "requiredMessage" with the
literal argument provided to this method. Subsequent calls to
#getRequiredMessage will return this value; |
true |
|
true |
| JSF:JAVADOC:778 |
void |
jakarta.faces.component.UIInput.setSubmittedValue
( Object ) |
Set the
submittedValue value of this UIInput component. This method should
only be used by the decode() and validate() method of this component,
or its corresponding Renderer. |
true |
|
true |
| JSF:JAVADOC:779 |
void |
jakarta.faces.component.UIInput.setValid
( boolean ) |
Set a
flag indicating whether the local value of this component is valid (no
conversion error has occurred). |
true |
|
true |
| JSF:JAVADOC:780 |
void |
jakarta.faces.component.UIInput.setValidator
( MethodBinding ) |
Set a
MethodBinding pointing at a method that will be called during Process
Validations phase of the request processing lifecycle, to validate the
current value of this component. Any method referenced by such an
expression must be public, with a return type of void, and accept
parameters of type FacesContext, UIComponent, and Object. |
true |
true |
true |
| JSF:JAVADOC:781 |
void |
jakarta.faces.component.UIInput.setValidatorMessage
( String ) |
Override any ValueExpression set for the "validatorMessage" with the
literal argument provided to this method. Subsequent calls to
#getValidatorMessage will return this value; |
true |
|
true |
| JSF:JAVADOC:782 |
void |
jakarta.faces.component.UIInput.setValue
( Object ) |
Set the
value of this UIComponent (if any). |
true |
|
true |
| JSF:JAVADOC:783 |
void |
jakarta.faces.component.UIInput.setValueChangeListener
( MethodBinding ) |
|
true |
true |
true |
| JSF:JAVADOC:784 |
UIInput |
jakarta.faces.component.UIInput.UIInput
|
Create
a new UIInput instance with default property values. |
true |
|
true |
| JSF:JAVADOC:785 |
void |
jakarta.faces.component.UIInput.updateModel
( FacesContext ) |
Perform
the following algorithm to update the model data associated with this
UIInput, if any, as appropriate. If the valid property of this
component is false, take no further action. If the localValueSet
property of this component is false, take no further action. If no
ValueExpression for value exists, take no further action. Call
setValue() method of the ValueExpression to update the value that the
ValueExpression points at. If the setValue() method returns
successfully: Clear the local value of this UIInput. Set the
localValueSet property of this UIInput to false. If the setValue()
method throws an Exception: Enqueue an error message. Create a
FacesMessage with the id #UPDATE_MESSAGE_ID. Create a
UpdateModelException, passing the FacesMessage and the caught
exception to the constructor. Create an ExceptionQueuedEventContext,
passing the FacesContext, the UpdateModelException, this component
instance, and PhaseId#UPDATE_MODEL_VALUES to its constructor. Call
FacesContext#getExceptionHandler and then call
ExceptionHandler#processEvent, passing the
ExceptionQueuedEventContext. Set the valid property of this UIInput to
false. The exception must not be re-thrown. This enables tree
traversal to continue for this lifecycle phase, as in all the other
lifecycle phases. |
true |
|
true |
| JSF:JAVADOC:786 |
void |
jakarta.faces.component.UIInput.updateModel
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:787 |
void |
jakarta.faces.component.UIInput.validate
( FacesContext ) |
Perform
the following algorithm to validate the local value of this UIInput.
Retrieve the submitted value with #getSubmittedValue. If this returns
null, exit without further processing. (This indicates that no value
was submitted for this component.) If the
jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL context
parameter value is true (ignoring case), and getSubmittedValue()
returns a zero-length String call #setSubmittedValue, passing null as
the argument and continue processing using null as the current
submitted value. Convert the submitted value into a "local value" of
the appropriate data type by calling #getConvertedValue. Validate the
property by calling #validateValue. If the valid property of this
component is still true, retrieve the previous value of the component
(with getValue()), store the new local value using setValue(), and
reset the submitted value to null. If the local value is different
from the previous value of this component, fire a ValueChangeEvent to
be broadcast to all interested listeners. Application components
implementing UIInput that wish to perform validation with logic
embedded in the component should perform their own correctness checks,
and then call the super.validate() method to perform the standard
processing described above. |
true |
|
true |
| JSF:JAVADOC:788 |
void |
jakarta.faces.component.UIInput.validate
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:789 |
String |
jakarta.faces.component.UIMessage.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:790 |
String |
jakarta.faces.component.UIMessage.getFor
|
Return
the client identifier of the component for which this component
represents associated message(s) (if any). |
true |
|
true |
| JSF:JAVADOC:791 |
boolean |
jakarta.faces.component.UIMessage.isRedisplay
|
|
true |
|
true |
| JSF:JAVADOC:792 |
boolean |
jakarta.faces.component.UIMessage.isShowDetail
|
Return
the flag indicating whether the detail property of the associated
message(s) should be displayed. Defaults to true. |
true |
|
true |
| JSF:JAVADOC:793 |
boolean |
jakarta.faces.component.UIMessage.isShowSummary
|
Return
the flag indicating whether the summary property of the associated
message(s) should be displayed. Defaults to false. |
true |
|
true |
| JSF:JAVADOC:794 |
void |
jakarta.faces.component.UIMessage.setFor
( String ) |
Set the
client identifier of the component for which this component represents
associated message(s) (if any). This property must be set before the
message is displayed. |
true |
|
true |
| JSF:JAVADOC:795 |
void |
jakarta.faces.component.UIMessage.setRedisplay
( boolean ) |
Set the
flag indicating whether the detail property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:796 |
void |
jakarta.faces.component.UIMessage.setShowDetail
( boolean ) |
Set the
flag indicating whether the detail property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:797 |
void |
jakarta.faces.component.UIMessage.setShowSummary
( boolean ) |
Set the
flag indicating whether the summary property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:798 |
UIMessage |
jakarta.faces.component.UIMessage.UIMessage
|
Create
a new UIMessage instance with default property values. |
true |
|
true |
| JSF:JAVADOC:799 |
String |
jakarta.faces.component.UIMessages.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:800 |
String |
jakarta.faces.component.UIMessages.getFor
|
Return
the client identifier of the component for which this component
represents associated message(s) (if any). |
true |
|
true |
| JSF:JAVADOC:801 |
boolean |
jakarta.faces.component.UIMessages.isGlobalOnly
|
Return
the flag indicating whether only global messages (that is, messages
with no associated client identifier) should be rendered. Mutually
exclusive with the "for" property which takes precedence. Defaults to
false. |
true |
|
true |
| JSF:JAVADOC:802 |
boolean |
jakarta.faces.component.UIMessages.isRedisplay
|
|
true |
|
true |
| JSF:JAVADOC:803 |
boolean |
jakarta.faces.component.UIMessages.isShowDetail
|
Return
the flag indicating whether the detail property of the associated
message(s) should be displayed. Defaults to false. |
true |
|
true |
| JSF:JAVADOC:804 |
boolean |
jakarta.faces.component.UIMessages.isShowSummary
|
Return
the flag indicating whether the summary property of the associated
message(s) should be displayed. Defaults to true. |
true |
|
true |
| JSF:JAVADOC:805 |
void |
jakarta.faces.component.UIMessages.setFor
( String ) |
Set the
client identifier of the component for which this component represents
associated message(s) (if any). This property must be set before the
message is displayed. |
true |
|
true |
| JSF:JAVADOC:806 |
void |
jakarta.faces.component.UIMessages.setGlobalOnly
( boolean ) |
Set the
flag indicating whether only global messages (that is, messages with
no associated client identifier) should be rendered. |
true |
|
true |
| JSF:JAVADOC:807 |
void |
jakarta.faces.component.UIMessages.setRedisplay
( boolean ) |
Set the
flag indicating whether the detail property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:808 |
void |
jakarta.faces.component.UIMessages.setShowDetail
( boolean ) |
Set the
flag indicating whether the detail property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:809 |
void |
jakarta.faces.component.UIMessages.setShowSummary
( boolean ) |
Set the
flag indicating whether the summary property of the associated
message(s) should be displayed. |
true |
|
true |
| JSF:JAVADOC:810 |
UIMessages |
jakarta.faces.component.UIMessages.UIMessages
|
Create
a new UIMessages instance with default property values. |
true |
|
true |
| JSF:JAVADOC:811 |
String |
jakarta.faces.component.UINamingContainer.createUniqueId
( FacesContext ,
String ) |
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
component-container. Optionally, a unique seed value can be supplied
by component creators which should be included in the generated unique
id. |
true |
|
true |
| JSF:JAVADOC:812 |
String |
jakarta.faces.component.UINamingContainer.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:813 |
char |
jakarta.faces.component.UINamingContainer.getSeparatorChar
( FacesContext ) |
Return
the character used to separate segments of a clientId. The
implementation must determine if there is a with the value given by
the value of the symbolic constant #SEPARATOR_CHAR_PARAM_NAME. If
there is a value for this param, the first character of the value must
be returned from this method. Otherwise, the value of the symbolic
constant NamingContainer#SEPARATOR_CHAR must be returned. |
true |
|
true |
| JSF:JAVADOC:814 |
UINamingContainer |
jakarta.faces.component.UINamingContainer.UINamingContainer
|
Create
a new UINamingContainer instance with default property values. |
true |
|
true |
| JSF:JAVADOC:815 |
boolean |
jakarta.faces.component.UINamingContainer.visitTree
( VisitContext ,
VisitCallback ) |
Perform
a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback directly, but instead call
VisitContext#invokeVisitCallback to invoke the callback. This allows
implementations to provide optimized tree traversals, for example by
only calling the for a subset of components. UIComponent.visitTree()
implementations must call UIComponent.pushComponentToEL() before
performing the visit and UIComponent.popComponentFromEL() after the
visit. |
true |
|
true |
| JSF:JAVADOC:816 |
String |
jakarta.faces.component.UIOutcomeTarget.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:817 |
String |
jakarta.faces.component.UIOutcomeTarget.getOutcome
|
Returns
the outcome property of the UIOutcomeTarget. This value is passed to
the jakarta.faces.application.NavigationHandler when resolving the
target url of this component. |
true |
|
true |
| JSF:JAVADOC:818 |
boolean |
jakarta.faces.component.UIOutcomeTarget.isIncludeViewParams
|
Return
whether or not the view parameters should be encoded into the target
url. |
true |
|
true |
| JSF:JAVADOC:819 |
void |
jakarta.faces.component.UIOutcomeTarget.setIncludeViewParams
( boolean ) |
Set
whether or not the page parameters should be encoded into the target
url. |
true |
|
true |
| JSF:JAVADOC:820 |
void |
jakarta.faces.component.UIOutcomeTarget.setOutcome
( String ) |
Sets
the outcome property of the UIOutcomeTarget. This value is passed to
the NavigationHandler when resolving the target url of this component.
|
true |
|
true |
| JSF:JAVADOC:821 |
UIOutcomeTarget |
jakarta.faces.component.UIOutcomeTarget.UIOutcomeTarget
|
Create
a new UIOutcomeTarget instance with default property values. |
true |
|
true |
| JSF:JAVADOC:822 |
void |
jakarta.faces.component.UIOutput.clearInitialState
|
For
each of the attached objects on this instance that implement
PartialStateHolder, call PartialStateHolder#clearInitialState on the
attached object. |
true |
|
true |
| JSF:JAVADOC:823 |
Converter |
jakarta.faces.component.UIOutput.getConverter
|
Return
the Converter (if any) that is registered for this UIComponent. |
true |
|
true |
| JSF:JAVADOC:824 |
String |
jakarta.faces.component.UIOutput.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:825 |
Object |
jakarta.faces.component.UIOutput.getLocalValue
|
Return
the local value of this UIComponent (if any), without evaluating any
associated ValueExpression. |
true |
|
true |
| JSF:JAVADOC:826 |
Object |
jakarta.faces.component.UIOutput.getValue
|
Gets
the value of this UIComponent. First, consult the local value property
of this component. If non-null return it. If null, see if we have a
ValueExpression for the value property. If so, return the result of
evaluating the property, otherwise return null. Note that because the
specification for UIComponent#setValueBinding requires a call through
to UIComponent#setValueExpression, legacy tags will continue to work.
|
true |
|
true |
| JSF:JAVADOC:827 |
void |
jakarta.faces.component.UIOutput.markInitialState
|
In
addition to the actions taken in UIComponentBase when
PartialStateHolder#markInitialState() is called, check if the
installed Converter is a PartialStateHolder and if it is, call
jakarta.faces.component.PartialStateHolder#markInitialState() on it. |
true |
|
true |
| JSF:JAVADOC:828 |
void |
jakarta.faces.component.UIOutput.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:829 |
Object |
jakarta.faces.component.UIOutput.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:830 |
void |
jakarta.faces.component.UIOutput.setConverter
( Converter ) |
Set the
Converter (if any) that is registered for this UIComponent. |
true |
|
true |
| JSF:JAVADOC:831 |
void |
jakarta.faces.component.UIOutput.setValue
( Object ) |
Set the
value of this UIComponent (if any). |
true |
|
true |
| JSF:JAVADOC:832 |
UIOutput |
jakarta.faces.component.UIOutput.UIOutput
|
Create
a new UIOutput instance with default property values. |
true |
|
true |
| JSF:JAVADOC:833 |
String |
jakarta.faces.component.UIPanel.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:834 |
UIPanel |
jakarta.faces.component.UIPanel.UIPanel
|
Create
a new UIPanel instance with default property values. |
true |
|
true |
| JSF:JAVADOC:835 |
String |
jakarta.faces.component.UIParameter.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:836 |
String |
jakarta.faces.component.UIParameter.getName
|
Return
the optional parameter name for this parameter. |
true |
|
true |
| JSF:JAVADOC:837 |
Object |
jakarta.faces.component.UIParameter.getValue
|
Returns
the value property of the UIParameter. |
true |
|
true |
| JSF:JAVADOC:838 |
boolean |
jakarta.faces.component.UIParameter.isDisable
|
Return
the value of the disable directive for this component. This directive
determines whether the parameter value should be disabled by assigning
it a null value. If true, the value set on this component is ignored.
|
true |
|
true |
| JSF:JAVADOC:839 |
void |
jakarta.faces.component.UIParameter.setDisable
( boolean ) |
Sets
the disable property of the UIParameter. |
true |
|
true |
| JSF:JAVADOC:840 |
void |
jakarta.faces.component.UIParameter.setName
( String ) |
Set the
optional parameter name for this parameter. |
true |
|
true |
| JSF:JAVADOC:841 |
void |
jakarta.faces.component.UIParameter.setValue
( Object ) |
Sets
the value property of the\ UIParameter. |
true |
|
true |
| JSF:JAVADOC:842 |
UIParameter |
jakarta.faces.component.UIParameter.UIParameter
|
Create
a new UIParameter instance with default property values. |
true |
|
true |
| JSF:JAVADOC:843 |
String |
jakarta.faces.component.UISelectBoolean.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:844 |
ValueBinding |
jakarta.faces.component.UISelectBoolean.getValueBinding
( String ) |
Return
any ValueBinding set for value if a ValueBinding for selected is
requested; otherwise, perform the default superclass processing for
this method. Rely on the superclass implementation to wrap the
returned ValueExpression in a ValueBinding. |
true |
true |
true |
| JSF:JAVADOC:845 |
ValueBinding |
jakarta.faces.component.UISelectBoolean.getValueBinding
( String )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:846 |
ValueExpression |
jakarta.faces.component.UISelectBoolean.getValueExpression
( String ) |
Return
any ValueExpression set for value if a ValueExpression for selected is
requested; otherwise, perform the default superclass processing for
this method. |
true |
|
true |
| JSF:JAVADOC:847 |
ValueExpression |
jakarta.faces.component.UISelectBoolean.getValueExpression
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:848 |
boolean |
jakarta.faces.component.UISelectBoolean.isSelected
|
Return
the local value of the selected state of this component. This method
is a typesafe alias for getValue(). |
true |
|
true |
| JSF:JAVADOC:849 |
void |
jakarta.faces.component.UISelectBoolean.setSelected
( boolean ) |
Set the
local value of the selected state of this component. This method is a
typesafe alias for setValue(). |
true |
|
true |
| JSF:JAVADOC:850 |
void |
jakarta.faces.component.UISelectBoolean.setValueBinding
( String ,
ValueBinding ) |
Store
any ValueBinding specified for selected under value instead;
otherwise, perform the default superclass processing for this method.
Rely on the superclass implementation to wrap the argument
ValueBinding in a ValueExpression. |
true |
true |
true |
| JSF:JAVADOC:851 |
void |
jakarta.faces.component.UISelectBoolean.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:852 |
void |
jakarta.faces.component.UISelectBoolean.setValueExpression
( String ,
ValueExpression ) |
Store
any ValueExpression specified for selected under value instead;
otherwise, perform the default superclass processing for this method.
|
true |
|
true |
| JSF:JAVADOC:853 |
void |
jakarta.faces.component.UISelectBoolean.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:854 |
UISelectBoolean |
jakarta.faces.component.UISelectBoolean.UISelectBoolean
|
Create
a new UISelectBoolean instance with default property values. |
true |
|
true |
| JSF:JAVADOC:855 |
String |
jakarta.faces.component.UISelectItem.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:856 |
String |
jakarta.faces.component.UISelectItem.getItemDescription
|
Return
the description for this selection item. |
true |
|
true |
| JSF:JAVADOC:857 |
String |
jakarta.faces.component.UISelectItem.getItemLabel
|
Return
the localized label for this selection item. |
true |
|
true |
| JSF:JAVADOC:858 |
Object |
jakarta.faces.component.UISelectItem.getItemValue
|
Return
the server value for this selection item. |
true |
|
true |
| JSF:JAVADOC:859 |
Object |
jakarta.faces.component.UISelectItem.getValue
|
Returns
the value property of the UISelectItem. |
true |
|
true |
| JSF:JAVADOC:860 |
boolean |
jakarta.faces.component.UISelectItem.isItemDisabled
|
Return
the disabled setting for this selection item. |
true |
|
true |
| JSF:JAVADOC:861 |
boolean |
jakarta.faces.component.UISelectItem.isItemEscaped
|
Return
the escape setting for the label of this selection item. |
true |
|
true |
| JSF:JAVADOC:862 |
boolean |
jakarta.faces.component.UISelectItem.isNoSelectionOption
|
Return
the value of the noSelectionOption property. If the value of this
property is true, the system interprets the option represented by this
UISelectItem instance as representing a "no selection" option. See
UISelectOne#validateValue and UISelectMany#validateValue for usage. |
true |
|
true |
| JSF:JAVADOC:863 |
void |
jakarta.faces.component.UISelectItem.setItemDescription
( String ) |
Set the
description for this selection item. |
true |
|
true |
| JSF:JAVADOC:864 |
void |
jakarta.faces.component.UISelectItem.setItemDisabled
( boolean ) |
Set the
disabled value for this selection item. |
true |
|
true |
| JSF:JAVADOC:865 |
void |
jakarta.faces.component.UISelectItem.setItemEscaped
( boolean ) |
Set the
escape value for the label of this selection item. |
true |
|
true |
| JSF:JAVADOC:866 |
void |
jakarta.faces.component.UISelectItem.setItemLabel
( String ) |
Set the
localized label for this selection item. |
true |
|
true |
| JSF:JAVADOC:867 |
void |
jakarta.faces.component.UISelectItem.setItemValue
( Object ) |
Set the
server value for this selection item. |
true |
|
true |
| JSF:JAVADOC:868 |
void |
jakarta.faces.component.UISelectItem.setNoSelectionOption
( boolean ) |
Set the
value of the noSelectionOption property. |
true |
|
true |
| JSF:JAVADOC:869 |
void |
jakarta.faces.component.UISelectItem.setValue
( Object ) |
Sets
the value property of the UISelectItem. |
true |
|
true |
| JSF:JAVADOC:870 |
UISelectItem |
jakarta.faces.component.UISelectItem.UISelectItem
|
Create
a new UISelectItem instance with default property values. |
true |
|
true |
| JSF:JAVADOC:871 |
String |
jakarta.faces.component.UISelectItems.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:872 |
Object |
jakarta.faces.component.UISelectItems.getValue
|
Returns
the value property of the UISelectItems. |
true |
|
true |
| JSF:JAVADOC:873 |
void |
jakarta.faces.component.UISelectItems.setValue
( Object ) |
Sets
the value property of the UISelectItems. |
true |
|
true |
| JSF:JAVADOC:874 |
UISelectItems |
jakarta.faces.component.UISelectItems.UISelectItems
|
Create
a new UISelectItems instance with default property values. |
true |
|
true |
| JSF:JAVADOC:875 |
String |
jakarta.faces.component.UISelectMany.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:876 |
Object[] |
jakarta.faces.component.UISelectMany.getSelectedValues
|
Return
the currently selected values, or null if there are no currently
selected values. This is a typesafe alias for getValue(). |
true |
|
true |
| JSF:JAVADOC:877 |
ValueBinding |
jakarta.faces.component.UISelectMany.getValueBinding
( String ) |
Return
any ValueBinding set for value if a ValueBinding for selectedValues is
requested; otherwise, perform the default superclass processing for
this method. This method relies on the superclass to provide the
ValueExpression to ValueBinding wrapping. |
true |
true |
true |
| JSF:JAVADOC:878 |
ValueBinding |
jakarta.faces.component.UISelectMany.getValueBinding
( String )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:879 |
ValueExpression |
jakarta.faces.component.UISelectMany.getValueExpression
( String ) |
Return
any ValueExpression set for value if a ValueExpression for
selectedValues is requested; otherwise, perform the default superclass
processing for this method. |
true |
|
true |
| JSF:JAVADOC:880 |
ValueExpression |
jakarta.faces.component.UISelectMany.getValueExpression
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:881 |
void |
jakarta.faces.component.UISelectMany.setSelectedValues
( Object[] ) |
Set the
currently selected values, or null to indicate that there are no
currently selected values. This is a typesafe alias for setValue(). |
true |
|
true |
| JSF:JAVADOC:882 |
void |
jakarta.faces.component.UISelectMany.setValueBinding
( String ,
ValueBinding ) |
Store
any ValueBinding specified for selectedValues under value instead;
otherwise, perform the default superclass processing for this method.
This method relies on the superclass to wrap the argument ValueBinding
in a ValueExpression. |
true |
true |
true |
| JSF:JAVADOC:883 |
void |
jakarta.faces.component.UISelectMany.setValueBinding
( String ,
ValueBinding )
throws NullPointerException
|
if name
is null |
true |
true |
true |
| JSF:JAVADOC:884 |
void |
jakarta.faces.component.UISelectMany.setValueExpression
( String ,
ValueExpression ) |
Store
any ValueExpression specified for selectedValues under value instead;
otherwise, perform the default superclass processing for this method.
|
true |
|
true |
| JSF:JAVADOC:885 |
void |
jakarta.faces.component.UISelectMany.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:886 |
UISelectMany |
jakarta.faces.component.UISelectMany.UISelectMany
|
Create
a new UISelectMany instance with default property values. |
true |
|
true |
| JSF:JAVADOC:887 |
String |
jakarta.faces.component.UISelectOne.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:888 |
UISelectOne |
jakarta.faces.component.UISelectOne.UISelectOne
|
Create
a new UISelectOne instance with default property values. |
true |
|
true |
| JSF:JAVADOC:889 |
void |
jakarta.faces.component.UIViewParameter.decode
( FacesContext ) |
Override behavior from superclass to pull a value from the incoming
request parameter map under the name given by #getName and store it
with a call to UIInput#setSubmittedValue. |
true |
|
true |
| JSF:JAVADOC:890 |
void |
jakarta.faces.component.UIViewParameter.encodeAll
( FacesContext ) |
Called
specially by UIViewRoot#encodeEnd, this method simply sets the
submitted value to be the return from #getStringValue. |
true |
|
true |
| JSF:JAVADOC:891 |
void |
jakarta.faces.component.UIViewParameter.encodeAll
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:892 |
String |
jakarta.faces.component.UIViewParameter.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:893 |
String |
jakarta.faces.component.UIViewParameter.getName
|
Return
the request parameter name from which the value is retrieved. |
true |
|
true |
| JSF:JAVADOC:894 |
String |
jakarta.faces.component.UIViewParameter.getStringValue
( FacesContext ) |
If the
value of this parameter comes from a ValueExpression return the value
of the expression, otherwise, return the local value. |
true |
|
true |
| JSF:JAVADOC:895 |
String |
jakarta.faces.component.UIViewParameter.getStringValueFromModel
( FacesContext ) |
Manually perform standard conversion steps to get a string value from
the value expression. |
true |
|
true |
| JSF:JAVADOC:896 |
String |
jakarta.faces.component.UIViewParameter.getStringValueFromModel
( FacesContext )
throws ConverterException
|
|
true |
|
true |
| JSF:JAVADOC:897 |
String |
jakarta.faces.component.UIViewParameter.getSubmittedValue
|
Assume
that the submitted value is always a string. |
true |
|
true |
| JSF:JAVADOC:898 |
boolean |
jakarta.faces.component.UIViewParameter.isImmediate
|
Return
false. The immediate setting is not relevant for view parameters and
must be assumed to be false. |
true |
|
true |
| JSF:JAVADOC:899 |
void |
jakarta.faces.component.UIViewParameter.processValidators
( FacesContext ) |
Specialize superclass behavior to treat null differently. In this
class, a null value along with the "required" flag being set to true
will cause a validation failure. |
true |
|
true |
| JSF:JAVADOC:900 |
void |
jakarta.faces.component.UIViewParameter.setName
( String ) |
Set the
request parameter name from which the value is retrieved. |
true |
|
true |
| JSF:JAVADOC:901 |
void |
jakarta.faces.component.UIViewParameter.setSubmittedValue
( Object ) |
PENDING
(docs) Interesting that submitted value isn't saved by the parent |
true |
|
true |
| JSF:JAVADOC:902 |
UIViewParameter |
jakarta.faces.component.UIViewParameter.UIViewParameter
|
Create
a new UIViewParameter instance with default property values. |
true |
|
true |
| JSF:JAVADOC:903 |
void |
jakarta.faces.component.UIViewParameter.updateModel
( FacesContext ) |
Call
through to superclass UIInput#updateModel 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. |
true |
|
true |
| JSF:JAVADOC:904 |
UIViewParameter |
jakarta.faces.component.UIViewParameter.Reference.getUIViewParameter
( FacesContext ) |
Return
the UIViewParameter to which this instance refers. If the current
viewId is the same as the viewId passed to our constructor, use the
index passed to the constructor to find the actual UIViewParameter
instance and return it. Otherwise, call StateHolder#restoreState on
the saved state and return the result. |
true |
|
true |
| JSF:JAVADOC:905 |
Reference |
jakarta.faces.component.UIViewParameter.Reference.UIViewParameter.Reference
( FacesContext ,
UIViewParameter ,
int ,
String ) |
Construct a reference to a UIViewParameter. This constructor cause the
StateHolder#saveState method to be called on argument UIViewParameter.
|
true |
|
true |
| JSF:JAVADOC:906 |
void |
jakarta.faces.component.UIViewRoot.addComponentResource
( FacesContext ,
UIComponent ) |
Add
argument component, which is assumed to represent a resource instance,
as a resource to this view. A resource instance is rendered by a
resource Renderer, as described in the Standard HTML RenderKit. The
default implementation must call through to
#addComponentResource(jakarta.faces.context.FacesContext,
jakarta.faces.component.UIComponent, java.lang.String). |
true |
|
true |
| JSF:JAVADOC:907 |
void |
jakarta.faces.component.UIViewRoot.addComponentResource
( FacesContext ,
UIComponent ,
String ) |
Add
argument component, which is assumed to represent a resource instance,
as a resource to this view. A resource instance is rendered by a
resource Renderer, as described in the Standard HTML RenderKit. The
component must be added using the following algorithm: If the target
argument is null, look for a target attribute on the component. If
there is no target attribute, set target to be the default value head
Call #getComponentResources to obtain the child list for the given
target. If the component ID of componentResource matches the the ID of
a resource that has allready been added, remove the old resource. Add
the component resource to the list. |
true |
|
true |
| JSF:JAVADOC:908 |
void |
jakarta.faces.component.UIViewRoot.addPhaseListener
( PhaseListener ) |
Add the
argument newPhaseListener to the list of PhaseListeners on this
UIViewRoot. |
true |
|
true |
| JSF:JAVADOC:909 |
void |
jakarta.faces.component.UIViewRoot.broadcastEvents
( FacesContext ,
PhaseId ) |
Broadcast any events that have been queued. First broadcast events
that have been queued for PhaseId#ANY_PHASE. Then broadcast ane events
that have been queued for the current phase. In both cases,
UIComponent#pushComponentToEL must be called before the event is
broadcast, and UIComponent#popComponentFromEL must be called after the
return from the broadcast, even in the case of an exception. |
true |
|
true |
| JSF:JAVADOC:910 |
String |
jakarta.faces.component.UIViewRoot.createUniqueId
|
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
UIViewRoot. |
true |
|
true |
| JSF:JAVADOC:911 |
String |
jakarta.faces.component.UIViewRoot.createUniqueId
( FacesContext ,
String ) |
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
UIViewRoot. Optionally, a unique seed value can be supplied by
component creators which should be included in the generated unique
id. |
true |
|
true |
| JSF:JAVADOC:912 |
void |
jakarta.faces.component.UIViewRoot.encodeBegin
( FacesContext ) |
Override the default UIComponentBase#encodeBegin behavior. If
#getBeforePhaseListener returns non-null, invoke it, passing a
PhaseEvent for the PhaseId#RENDER_RESPONSE phase. If the internal list
populated by calls to #addPhaseListener is non-empty, any listeners in
that list must have their PhaseListener#beforePhase method called,
passing the PhaseEvent. Any errors that occur during invocation of any
of the the beforePhase listeners must be logged and swallowed. After
listeners are invoked call superclass processing. |
true |
|
true |
| JSF:JAVADOC:913 |
void |
jakarta.faces.component.UIViewRoot.encodeBegin
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:914 |
void |
jakarta.faces.component.UIViewRoot.encodeChildren
( FacesContext ) |
If
jakarta.faces.context.PartialViewContext#isAjaxRequest returns true,
perform partial rendering by calling
jakarta.faces.context.PartialViewContext#processPartial with
PhaseId#RENDER_RESPONSE. If
jakarta.faces.context.PartialViewContext#isAjaxRequest returns false,
delegate to the parent
jakarta.faces.component.UIComponentBase#encodeChildren method. |
true |
|
true |
| JSF:JAVADOC:915 |
void |
jakarta.faces.component.UIViewRoot.encodeChildren
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:916 |
void |
jakarta.faces.component.UIViewRoot.encodeEnd
( FacesContext ) |
If
#getAfterPhaseListener returns non-null, invoke it, passing a
PhaseEvent for the PhaseId#RENDER_RESPONSE phase. Any errors that
occur during invocation of the afterPhase listener must be logged and
swallowed. If the current view has view parameters, as indicated by a
non-empty and non-UnsupportedOperationException throwing return from
jakarta.faces.view.ViewDeclarationLanguage#getViewMetadata(jakarta.faces.context.FacesContext,
String), call UIViewParameter#encodeAll on each parameter. If calling
getViewParameters() causes UnsupportedOperationException to be thrown,
the exception must be silently swallowed. |
true |
|
true |
| JSF:JAVADOC:917 |
void |
jakarta.faces.component.UIViewRoot.encodeEnd
( FacesContext )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:918 |
MethodExpression |
jakarta.faces.component.UIViewRoot.getAfterPhaseListener
|
Return
the MethodExpression that will be invoked after this view is rendered.
|
true |
|
true |
| JSF:JAVADOC:919 |
MethodExpression |
jakarta.faces.component.UIViewRoot.getBeforePhaseListener
|
Return
the MethodExpression that will be invoked before this view is
rendered. |
true |
|
true |
| JSF:JAVADOC:920 |
List |
jakarta.faces.component.UIViewRoot.getComponentResources
( FacesContext ,
String ) |
Return
an unmodifiable List of UIComponents for the provided target agrument.
Each component in the List is assumed to represent a resource
instance. The default implementation must use an algorithm equivalent
to the the following. Locate the facet for the component by calling
getFacet() using target as the argument. If the facet is not found,
create the facet by calling context.getApplication().createComponent()
using jakarta.faces.Panel as the argument Set the id of the facet to be
target Add the facet to the facets Map using target as the key return
the children of the facet |
true |
|
true |
| JSF:JAVADOC:921 |
List |
jakarta.faces.component.UIViewRoot.getComponentResources
( FacesContext ,
String )
throws NullPointerException
|
if
target or context is null |
true |
|
true |
| JSF:JAVADOC:922 |
String |
jakarta.faces.component.UIViewRoot.getFamily
|
Return
the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the
rendererType property, may be used to select the appropriate Renderer
for this component instance. |
true |
|
true |
| JSF:JAVADOC:923 |
Locale |
jakarta.faces.component.UIViewRoot.getLocale
|
Return
the Locale to be used in localizing the response being created for
this view. Algorithm: If we have a locale ivar, return it. If we have
a value expression for "locale", get its value. If the value is null,
return the result of calling
jakarta.faces.application.ViewHandler#calculateLocale. If the value is
an instance of java.util.Locale return it. If the value is a String,
convert it to a java.util.Locale and return it. If there is no value
expression for "locale", return the result of calling
jakarta.faces.application.ViewHandler#calculateLocale. |
true |
|
true |
| JSF:JAVADOC:924 |
List |
jakarta.faces.component.UIViewRoot.getPhaseListeners
|
Return
an unmodifiable list of the PhaseListener instances attached to this
UIViewRoot instance. |
true |
|
true |
| JSF:JAVADOC:925 |
String |
jakarta.faces.component.UIViewRoot.getRenderKitId
|
Return
the render kit identifier of the jakarta.faces.render.RenderKit
associated with this view. Unless explicitly set, as in
jakarta.faces.application.ViewHandler#createView, the returned value
will be null. |
true |
|
true |
| JSF:JAVADOC:926 |
boolean |
jakarta.faces.component.UIViewRoot.getRendersChildren
|
Call
UIComponentBase#getRendersChildren If
jakarta.faces.context.PartialViewContext#isAjaxRequest returns true this
method must return true. |
true |
|
true |
| JSF:JAVADOC:927 |
String |
jakarta.faces.component.UIViewRoot.getViewId
|
Return
the view identifier for this view. |
true |
|
true |
| JSF:JAVADOC:928 |
List |
jakarta.faces.component.UIViewRoot.getViewListenersForEventClass
( Class ) |
Return
the SystemEventListener instances registered on this UIComponent
instance that are interested in events of type eventClass. |
true |
|
true |
| JSF:JAVADOC:929 |
List |
jakarta.faces.component.UIViewRoot.getViewListenersForEventClass
( Class )
throws NullPointerException
|
if
argument systemEvent is null. |
true |
|
true |
| JSF:JAVADOC:930 |
Map |
jakarta.faces.component.UIViewRoot.getViewMap
|
This
implementation simply calls through to #getViewMap(boolean), passing
true as the argument, and returns the result. |
true |
|
true |
| JSF:JAVADOC:931 |
Map |
jakarta.faces.component.UIViewRoot.getViewMap
( boolean ) |
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. This map must be
instantiated lazily and cached for return from subsequent calls to
this method on this UIViewRoot instance.
jakarta.faces.application.Application#publishEvent must be called,
passing PostConstructViewMapEvent.class as the first argument and this
UIViewRoot instance as the second argument. The returned Map must be
implemented such that calling clear() on the Map causes
jakarta.faces.application.Application#publishEvent to be called, passing
PreDestroyViewMapEvent.class as the first argument and this UIViewRoot
instance as the second argument. See FacesContext#setViewRoot for the
specification of when the clear() method must be called. |
true |
|
true |
| JSF:JAVADOC:932 |
boolean |
jakarta.faces.component.UIViewRoot.isInView
|
Return
trues. |
true |
|
true |
| JSF:JAVADOC:933 |
void |
jakarta.faces.component.UIViewRoot.processApplication
( FacesContext ) |
Broadcast any events that have been queued for the Invoke Application
phase of the request processing lifecycle and to clear out any events
for later phases if the event processing for this phase caused
FacesContext#renderResponse or FacesContext#responseComplete to be
called. |
true |
|
true |
| JSF:JAVADOC:934 |
void |
jakarta.faces.component.UIViewRoot.processApplication
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:935 |
void |
jakarta.faces.component.UIViewRoot.processDecodes
( FacesContext ) |
Perform
partial processing by calling
jakarta.faces.context.PartialViewContext#processPartial with
PhaseId#APPLY_REQUEST_VALUES if:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we don't have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns false)
Perform full processing by calling UIComponentBase#processDecodes if
one of the following conditions are met:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns true)
jakarta.faces.context.PartialViewContext#isPartialRequest returns false
Override the default UIComponentBase#processDecodes behavior to
broadcast any queued events after the default processing or partial
processing has been completed and to clear out any events for later
phases if the event processing for this phase caused
FacesContext#renderResponse or FacesContext#responseComplete to be
called. |
true |
|
true |
| JSF:JAVADOC:936 |
void |
jakarta.faces.component.UIViewRoot.processDecodes
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:937 |
void |
jakarta.faces.component.UIViewRoot.processRestoreState
( FacesContext ,
Object ) |
The
default implementation must call UIComponentBase#processRestoreState
from within a try block. The try block must have a finally block that
ensures that no FacesEvents remain in the event queue, and that the
this.UIComponent#visitTree is called, passing a ContextCallback that
takes the following action: call the UIComponent#processEvent method
of the current component. The argument event must be an instance of
jakarta.faces.event.PostRestoreStateEvent whose component property is
the current component in the traversal. |
true |
|
true |
| JSF:JAVADOC:938 |
void |
jakarta.faces.component.UIViewRoot.processUpdates
( FacesContext ) |
Perform
partial processing by calling
jakarta.faces.context.PartialViewContext#processPartial with
PhaseId#UPDATE_MODEL_VALUES if:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we don't have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns false)
Perform full processing by calling UIComponentBase#processUpdates if
one of the following conditions are met:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns true)
jakarta.faces.context.PartialViewContext#isPartialRequest returns false
Override the default UIComponentBase behavior to broadcast any queued
events after the default processing or partial processing has been
completed and to clear out any events for later phases if the event
processing for this phase caused FacesContext#renderResponse or
FacesContext#responseComplete to be called. |
true |
|
true |
| JSF:JAVADOC:939 |
void |
jakarta.faces.component.UIViewRoot.processUpdates
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:940 |
void |
jakarta.faces.component.UIViewRoot.processValidators
( FacesContext ) |
Perform
partial processing by calling
jakarta.faces.context.PartialViewContext#processPartial with
PhaseId#PROCESS_VALIDATIONS if:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we don't have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns false)
Perform full processing by calling UIComponentBase#processValidators
if one of the following conditions are met:
jakarta.faces.context.PartialViewContext#isPartialRequest returns true
and we have a request to process all components in the view
(jakarta.faces.context.PartialViewContext#isExecuteAll returns true)
jakarta.faces.context.PartialViewContext#isPartialRequest returns false
Override the default UIComponentBase#processValidators behavior to
broadcast any queued events after the default processing or partial
processing has been completed and to clear out any events for later
phases if the event processing for this phase caused
FacesContext#renderResponse or FacesContext#responseComplete to be
called. |
true |
|
true |
| JSF:JAVADOC:941 |
void |
jakarta.faces.component.UIViewRoot.processValidators
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:942 |
void |
jakarta.faces.component.UIViewRoot.queueEvent
( FacesEvent ) |
Override the default UIComponentBase#queueEvent behavior to accumulate
the queued events for later broadcasting. |
true |
|
true |
| JSF:JAVADOC:943 |
void |
jakarta.faces.component.UIViewRoot.queueEvent
( FacesEvent )
throws IllegalStateException
|
if this
component is not a descendant of a UIViewRoot |
true |
|
true |
| JSF:JAVADOC:944 |
void |
jakarta.faces.component.UIViewRoot.queueEvent
( FacesEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:945 |
void |
jakarta.faces.component.UIViewRoot.removeComponentResource
( FacesContext ,
UIComponent ) |
Remove
argument component, which is assumed to represent a resource instance,
as a resource to this view. |
true |
|
true |
| JSF:JAVADOC:946 |
void |
jakarta.faces.component.UIViewRoot.removeComponentResource
( FacesContext ,
UIComponent ,
String ) |
Remove
argument component, which is assumed to represent a resource instance,
as a resource to this view. A resource instance is rendered by a
resource Renderer, as described in the Standard HTML RenderKit. The
component must be removed using the following algorithm: If the target
argument is null, look for a target attribute on the component. If
there is no target attribute, set target to be the default value head
Call #getComponentResources to obtain the child list for the given
target. Remove the component resource from the child list. |
true |
|
true |
| JSF:JAVADOC:947 |
void |
jakarta.faces.component.UIViewRoot.removePhaseListener
( PhaseListener ) |
If the
argument toRemove is in the list of PhaseListeners for this instance,
it must be removed. |
true |
|
true |
| JSF:JAVADOC:948 |
void |
jakarta.faces.component.UIViewRoot.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:949 |
Object |
jakarta.faces.component.UIViewRoot.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:950 |
void |
jakarta.faces.component.UIViewRoot.setAfterPhaseListener
( MethodExpression ) |
Allow
an arbitrary method to be called for the "afterPhase" event as the
UIViewRoot runs through its lifecycle. This method will be called for
all phases including PhaseId#RESTORE_VIEW. Unlike a true
PhaseListener, this approach doesn't allow for only receiving
PhaseEvents for a given phase. The method must conform to the
signature of PhaseListener#afterPhase. |
true |
|
true |
| JSF:JAVADOC:951 |
void |
jakarta.faces.component.UIViewRoot.setBeforePhaseListener
( MethodExpression ) |
Allow
an arbitrary method to be called for the "beforePhase" event as the
UIViewRoot runs through its lifecycle. This method will be called for
all phases except PhaseId#RESTORE_VIEW. Unlike a true PhaseListener,
this approach doesn't allow for only receiving PhaseEvents for a given
phase. The method must conform to the signature of
PhaseListener#beforePhase. |
true |
|
true |
| JSF:JAVADOC:952 |
void |
jakarta.faces.component.UIViewRoot.setInView
( boolean ) |
Overridden to take no action. |
true |
|
true |
| JSF:JAVADOC:953 |
void |
jakarta.faces.component.UIViewRoot.setLocale
( Locale ) |
Set the
Locale to be used in localizing the response being created for this
view. |
true |
|
true |
| JSF:JAVADOC:954 |
void |
jakarta.faces.component.UIViewRoot.setRenderKitId
( String ) |
Set the
render kit identifier of the jakarta.faces.render.RenderKit associated
with this view. This method may be called at any time between the end
of Apply Request Values phase of the request processing lifecycle
(i.e. when events are being broadcast) and the beginning of the Render
Response phase. |
true |
|
true |
| JSF:JAVADOC:955 |
void |
jakarta.faces.component.UIViewRoot.setViewId
( String ) |
Set the
view identifier for this view. |
true |
|
true |
| JSF:JAVADOC:956 |
void |
jakarta.faces.component.UIViewRoot.subscribeToViewEvent
( Class ,
SystemEventListener ) |
Install
the listener instance referenced by argument listener into the
UIViewRoot as a listener for events of type systemEventClass. Note
that installed listeners are not maintained as part of the
UIViewRoot's state. |
true |
|
true |
| JSF:JAVADOC:957 |
void |
jakarta.faces.component.UIViewRoot.subscribeToViewEvent
( Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if
systemEventClass or listener are null. |
true |
|
true |
| JSF:JAVADOC:958 |
UIViewRoot |
jakarta.faces.component.UIViewRoot.UIViewRoot
|
Create
a new UIViewRoot instance with default property values. |
true |
|
true |
| JSF:JAVADOC:959 |
void |
jakarta.faces.component.UIViewRoot.unsubscribeFromViewEvent
( Class ,
SystemEventListener ) |
Remove
the listener instance referenced by argument listener from the
UIViewRoot as a listener for events of type systemEventClass. |
true |
|
true |
| JSF:JAVADOC:960 |
void |
jakarta.faces.component.UIViewRoot.unsubscribeFromViewEvent
( Class ,
SystemEventListener )
throws <code>NullPointerException</code>
|
if
systemEventClass or listener are null. |
true |
|
true |
| JSF:JAVADOC:961 |
String |
jakarta.faces.component.UniqueIdVendor.createUniqueId
( FacesContext ,
String ) |
Generate an identifier for a component. The identifier will be
prefixed with UNIQUE_ID_PREFIX, and will be unique within this
component-container. Optionally, a unique seed value can be supplied
by component creators which should be included in the generated unique
id. |
true |
|
true |
| JSF:JAVADOC:962 |
FacesMessage |
jakarta.faces.component.UpdateModelException.getFacesMessage
|
Return
the FacesMessage passed to the constructor. |
true |
|
true |
| JSF:JAVADOC:963 |
UpdateModelException |
jakarta.faces.component.UpdateModelException.UpdateModelException
( FacesMessage ,
Throwable ) |
Store
the argument facesMessage so it may be returned from #getFacesMessage
and pass the argument cause to the super constructor. |
true |
|
true |
| JSF:JAVADOC:964 |
Converter |
jakarta.faces.component.ValueHolder.getConverter
|
Return
the Converter (if any) that is registered for this UIComponent. |
true |
|
true |
| JSF:JAVADOC:965 |
Object |
jakarta.faces.component.ValueHolder.getLocalValue
|
Return
the local value of this UIComponent (if any), without evaluating any
associated ValueExpression. |
true |
|
true |
| JSF:JAVADOC:966 |
Object |
jakarta.faces.component.ValueHolder.getValue
|
Gets
the value of this UIComponent. First, consult the local value property
of this component. If non-null return it. If null, see if we have a
ValueExpression for the value property. If so, return the result of
evaluating the property, otherwise return null. Note that because the
specification for UIComponent#setValueBinding requires a call through
to UIComponent#setValueExpression, legacy tags will continue to work.
|
true |
|
true |
| JSF:JAVADOC:967 |
void |
jakarta.faces.component.ValueHolder.setConverter
( Converter ) |
Set the
Converter (if any) that is registered for this UIComponent. |
true |
|
true |
| JSF:JAVADOC:968 |
void |
jakarta.faces.component.ValueHolder.setValue
( Object ) |
Set the
value of this UIComponent (if any). |
true |
|
true |
| JSF:JAVADOC:969 |
void |
jakarta.faces.component.behavior.AjaxBehavior.addAjaxBehaviorListener
( AjaxBehaviorListener ) |
Add the
specified AjaxBehaviorListener to the set of listeners registered to
receive event notifications from this AjaxBehavior. |
true |
|
true |
| JSF:JAVADOC:970 |
void |
jakarta.faces.component.behavior.AjaxBehavior.addAjaxBehaviorListener
( AjaxBehaviorListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:971 |
AjaxBehavior |
jakarta.faces.component.behavior.AjaxBehavior.AjaxBehavior
|
|
true |
|
true |
| JSF:JAVADOC:972 |
Collection |
jakarta.faces.component.behavior.AjaxBehavior.getExecute
|
Return
a non-empty Collection of component identifiers that will be used to
identify components that should be processed during the execute phase
of the request processing lifecycle. Note that the returned collection
may be unmodifiable. Modifications should be performed by calling
#setExecute. |
true |
|
true |
| JSF:JAVADOC:973 |
Set |
jakarta.faces.component.behavior.AjaxBehavior.getHints
|
This
method returns an unmodifiable Set containing the ClientBehaviorHint
SUBMITTING. |
true |
|
true |
| JSF:JAVADOC:974 |
String |
jakarta.faces.component.behavior.AjaxBehavior.getOnerror
|
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. |
true |
|
true |
| JSF:JAVADOC:975 |
String |
jakarta.faces.component.behavior.AjaxBehavior.getOnevent
|
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. |
true |
|
true |
| JSF:JAVADOC:976 |
Collection |
jakarta.faces.component.behavior.AjaxBehavior.getRender
|
Return
a non-empty Collection of component identifiers that will be used to
identify components that should be processed during the render phase
of the request processing lifecycle. Note that the returned collection
may be unmodifiable. Modifications should be performed by calling
#setRender. |
true |
|
true |
| JSF:JAVADOC:977 |
String |
jakarta.faces.component.behavior.AjaxBehavior.getRendererType
|
Returns
the renderer type of the ClientBehaviorRenderer to use for the
behavior. The default implementation returns null. Subclasses should
either override this method to return a string that identifies the
type of ClientBehaviorRenderer to use, or should override #getScript
and perform script rendering locally in the ClientBehavior
implementation. |
true |
|
true |
| JSF:JAVADOC:978 |
ValueExpression |
jakarta.faces.component.behavior.AjaxBehavior.getValueExpression
( String ) |
Returns
the ValueExpression used to calculate the value for the specified
property name, if any. |
true |
|
true |
| JSF:JAVADOC:979 |
ValueExpression |
jakarta.faces.component.behavior.AjaxBehavior.getValueExpression
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:980 |
boolean |
jakarta.faces.component.behavior.AjaxBehavior.isDisabled
|
Return
the disabled status of this behavior. |
true |
|
true |
| JSF:JAVADOC:981 |
boolean |
jakarta.faces.component.behavior.AjaxBehavior.isImmediate
|
Return
the immediate status of this behaivor. |
true |
|
true |
| JSF:JAVADOC:982 |
boolean |
jakarta.faces.component.behavior.AjaxBehavior.isImmediateSet
|
Tests
whether the immediate attribute is specified. Returns true if the
immediate attribute is specified, either as a locally set property or
as a value expression. This information allows an associated client
behavior renderer to fall back on the parent component's immediate
status when immediate is not explicitly specified on the AjaxBehavior.
|
true |
|
true |
| JSF:JAVADOC:983 |
void |
jakarta.faces.component.behavior.AjaxBehavior.removeAjaxBehaviorListener
( AjaxBehaviorListener ) |
Remove
the specified AjaxBehaviorListener from the set of listeners
registered to receive event notifications from this AjaxBehavior. |
true |
|
true |
| JSF:JAVADOC:984 |
void |
jakarta.faces.component.behavior.AjaxBehavior.removeAjaxBehaviorListener
( AjaxBehaviorListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:985 |
void |
jakarta.faces.component.behavior.AjaxBehavior.restoreState
( FacesContext ,
Object ) |
Implementation of jakarta.faces.component.StateHolder#restoreState. |
true |
|
true |
| JSF:JAVADOC:986 |
Object |
jakarta.faces.component.behavior.AjaxBehavior.saveState
( FacesContext ) |
Implementation of jakarta.faces.component.StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:987 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setDisabled
( boolean ) |
Sets
the disabled status of this behavior. |
true |
|
true |
| JSF:JAVADOC:988 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setExecute
( Collection ) |
Sets
the component identifiers that will be used to identify components
that should be processed during the execute phase of the request
processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:989 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setImmediate
( boolean ) |
Sets
the immediate status of this behavior. |
true |
|
true |
| JSF:JAVADOC:990 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setOnerror
( String ) |
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. |
true |
|
true |
| JSF:JAVADOC:991 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setOnevent
( String ) |
Sets
the JavaScript function name that will be used to identify the client
callback function that should be run in response to event activity. |
true |
|
true |
| JSF:JAVADOC:992 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setRender
( Collection ) |
Sets
the component identifiers that will be used to identify components
that should be processed during the render phase of the request
processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:993 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setValueExpression
( String ,
ValueExpression ) |
Sets
the ValueExpression used to calculate the value for the specified
property name. |
true |
|
true |
| JSF:JAVADOC:994 |
void |
jakarta.faces.component.behavior.AjaxBehavior.setValueExpression
( String ,
ValueExpression )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:995 |
void |
jakarta.faces.component.behavior.Behavior.broadcast
( BehaviorEvent ) |
Broadcast the specified BehaviorEvent to all registered event
listeners who have expressed an interest in events of this type.
Listeners are called in the order in which they were added. |
true |
|
true |
| JSF:JAVADOC:996 |
void |
jakarta.faces.component.behavior.Behavior.broadcast
( BehaviorEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:997 |
void |
jakarta.faces.component.behavior.Behavior.broadcast
( BehaviorEvent )
throws IllegalArgumentException
|
if the
implementation class of this BehaviorEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:998 |
void |
jakarta.faces.component.behavior.Behavior.broadcast
( BehaviorEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:999 |
BehaviorBase |
jakarta.faces.component.behavior.BehaviorBase.BehaviorBase
|
|
true |
|
true |
| JSF:JAVADOC:1000 |
void |
jakarta.faces.component.behavior.BehaviorBase.broadcast
( BehaviorEvent ) |
Default
implementation of Behavior#broadcast. Delivers the specified
BehaviorEvent to all registered BehaviorListener event listeners who
have expressed an interest in events of this type. Listeners are
called in the order in which they were registered (added). |
true |
|
true |
| JSF:JAVADOC:1001 |
void |
jakarta.faces.component.behavior.BehaviorBase.broadcast
( BehaviorEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1002 |
void |
jakarta.faces.component.behavior.BehaviorBase.broadcast
( BehaviorEvent )
throws IllegalArgumentException
|
if the
implementation class of this BehaviorEvent is not supported by this
component |
true |
|
true |
| JSF:JAVADOC:1003 |
void |
jakarta.faces.component.behavior.BehaviorBase.broadcast
( BehaviorEvent )
throws NullPointerException
|
if event
is null |
true |
|
true |
| JSF:JAVADOC:1004 |
void |
jakarta.faces.component.behavior.BehaviorBase.clearInitialState
|
Clears
the initial state flag, causing the behavior to revert from partial to
full state saving. |
true |
|
true |
| JSF:JAVADOC:1005 |
boolean |
jakarta.faces.component.behavior.BehaviorBase.initialStateMarked
|
Implementation of
jakarta.faces.component.PartialStateHolder#initialStateMarked. |
true |
|
true |
| JSF:JAVADOC:1006 |
boolean |
jakarta.faces.component.behavior.BehaviorBase.isTransient
|
Implementation of jakarta.faces.component.StateHolder#isTransient. |
true |
|
true |
| JSF:JAVADOC:1007 |
void |
jakarta.faces.component.behavior.BehaviorBase.markInitialState
|
Implementation of
jakarta.faces.component.PartialStateHolder#markInitialState. |
true |
|
true |
| JSF:JAVADOC:1008 |
void |
jakarta.faces.component.behavior.BehaviorBase.restoreState
( FacesContext ,
Object ) |
Implementation of jakarta.faces.component.StateHolder#restoreState. |
true |
|
true |
| JSF:JAVADOC:1009 |
Object |
jakarta.faces.component.behavior.BehaviorBase.saveState
( FacesContext ) |
Implementation of jakarta.faces.component.StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:1010 |
void |
jakarta.faces.component.behavior.BehaviorBase.setTransient
( boolean ) |
Implementation of jakarta.faces.component.StateHolder#setTransient. |
true |
|
true |
| JSF:JAVADOC:1011 |
void |
jakarta.faces.component.behavior.ClientBehavior.decode
( FacesContext ,
UIComponent ) |
Decode
any new state of this ClientBehavior from the request contained in the
specified FacesContext. During decoding, events may be enqueued for
later processing (by event listeners who have registered an interest),
by calling queueEvent(). Default implementation delegates decoding to
jakarta.faces.render.ClientBehaviorRenderer#decode(FacesContext,
UIComponent, ClientBehavior) |
true |
|
true |
| JSF:JAVADOC:1012 |
void |
jakarta.faces.component.behavior.ClientBehavior.decode
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null. |
true |
|
true |
| JSF:JAVADOC:1013 |
Set |
jakarta.faces.component.behavior.ClientBehavior.getHints
|
Returns
hints that describe the behavior of the ClientBehavior implementation.
The hints may impact how Renderers behave in the presence of
Behaviors. For example, when a Behavior that specifies
ClientBehaviorHint.SUBMITTING is present, the Renderer may choose to
alternate the scripts that it generates itself. |
true |
|
true |
| JSF:JAVADOC:1014 |
String |
jakarta.faces.component.behavior.ClientBehavior.getScript
( ClientBehaviorContext ) |
Return
the script that implements this ClientBehavior's client-side logic.
ClientBehavior.getScript() implementations are allowed to return null
to indicate that no script is required for this particular getScript()
call. For example, a ClientBehavior implementation may return null if
the Behavior is disabled. |
true |
|
true |
| JSF:JAVADOC:1015 |
String |
jakarta.faces.component.behavior.ClientBehavior.getScript
( ClientBehaviorContext )
throws NullPointerException
|
if
behaviorContext is null |
true |
|
true |
| JSF:JAVADOC:1016 |
ClientBehaviorBase |
jakarta.faces.component.behavior.ClientBehaviorBase.ClientBehaviorBase
|
|
true |
|
true |
| JSF:JAVADOC:1017 |
void |
jakarta.faces.component.behavior.ClientBehaviorBase.decode
( FacesContext ,
UIComponent ) |
Default
implementation of of ClientBehavior#decode. If a
ClientBehaviorRenderer is available for the specified behavior
renderer type, this method delegates to the ClientBehaviorRenderer's
decode() method. Otherwise, no decoding is performed. |
true |
|
true |
| JSF:JAVADOC:1018 |
void |
jakarta.faces.component.behavior.ClientBehaviorBase.decode
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null. |
true |
|
true |
| JSF:JAVADOC:1019 |
Set |
jakarta.faces.component.behavior.ClientBehaviorBase.getHints
|
Default
implementation of ClientBehavior#getHints(). By default, no hints are
specified, and this method returns an empty, umodifiable set. |
true |
|
true |
| JSF:JAVADOC:1020 |
String |
jakarta.faces.component.behavior.ClientBehaviorBase.getRendererType
|
Returns
the renderer type of the ClientBehaviorRenderer to use for the
behavior. The default implementation returns null. Subclasses should
either override this method to return a string that identifies the
type of ClientBehaviorRenderer to use, or should override #getScript
and perform script rendering locally in the ClientBehavior
implementation. |
true |
|
true |
| JSF:JAVADOC:1021 |
String |
jakarta.faces.component.behavior.ClientBehaviorBase.getScript
( ClientBehaviorContext ) |
Default
implementation of of ClientBehavior#getScript. If a
ClientBehaviorRenderer is available for the specified behavior
renderer type, this method delegates to the
ClientBehaviorRenderer#getScript method. Otherwise, this method
returns null. |
true |
|
true |
| JSF:JAVADOC:1022 |
String |
jakarta.faces.component.behavior.ClientBehaviorBase.getScript
( ClientBehaviorContext )
throws NullPointerException
|
if
behaviorContext is null |
true |
|
true |
| JSF:JAVADOC:1023 |
ClientBehaviorContext |
jakarta.faces.component.behavior.ClientBehaviorContext.ClientBehaviorContext
|
|
true |
|
true |
| JSF:JAVADOC:1024 |
ClientBehaviorContext |
jakarta.faces.component.behavior.ClientBehaviorContext.createClientBehaviorContext
( FacesContext ,
UIComponent ,
String ,
String ,
Collection ) |
Creates
a ClientBehaviorContext instance. |
true |
|
true |
| JSF:JAVADOC:1025 |
ClientBehaviorContext |
jakarta.faces.component.behavior.ClientBehaviorContext.createClientBehaviorContext
( FacesContext ,
UIComponent ,
String ,
String ,
Collection )
throws NullPointerException
|
if
context, component or eventName is null |
true |
|
true |
| JSF:JAVADOC:1026 |
UIComponent |
jakarta.faces.component.behavior.ClientBehaviorContext.getComponent
|
Returns
the UIComponent that is requesting the ClientBehavior script. |
true |
|
true |
| JSF:JAVADOC:1027 |
String |
jakarta.faces.component.behavior.ClientBehaviorContext.getEventName
|
Returns
the name of the behavior event for which the ClientBehavior script is
being requested. |
true |
|
true |
| JSF:JAVADOC:1028 |
FacesContext |
jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext
|
Returns
the FacesContext for the current request. |
true |
|
true |
| JSF:JAVADOC:1029 |
Collection |
jakarta.faces.component.behavior.ClientBehaviorContext.getParameters
|
Returns
parameters that "submitting" ClientBehavior implementations should
include when posting back data into the Faces lifecycle. If no
parameters are specified, this method returns an empty (non-null)
collection. |
true |
|
true |
| JSF:JAVADOC:1030 |
String |
jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId
|
Returns
an id for use as the ClientBehavior source. ClientBehavior
implementations that submit back to the Faces lifecycle are required
to identify which component triggered the ClientBehavior-initiated
request via the jakarta.faces.source request parameter. In most cases,
th source id can be trivially derived from the element to which the
behavior's client-side script is attached - ie. the source id is
typically the id of this element. However, in components which produce
more complex content, the behavior script may not be able to determine
the correct id to use for the jakarta.faces.source value. The
ClientBehaviorContext#getSourceId method allows the component to pass
this information into the ClientBehavior#getScript implementation. |
true |
|
true |
| JSF:JAVADOC:1031 |
Parameter |
jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.ClientBehaviorContext.Parameter
( String ,
Object ) |
Creates
a Parameter instance. |
true |
|
true |
| JSF:JAVADOC:1032 |
String |
jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.getName
|
Returns
the Parameter's name. |
true |
|
true |
| JSF:JAVADOC:1033 |
Object |
jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.getValue
|
Returns
the Parameter's value. |
true |
|
true |
| JSF:JAVADOC:1034 |
ClientBehaviorHint |
jakarta.faces.component.behavior.ClientBehaviorHint.valueOf
( String ) |
|
true |
|
true |
| JSF:JAVADOC:1035 |
ClientBehaviorHint[] |
jakarta.faces.component.behavior.ClientBehaviorHint.values
|
|
true |
|
true |
| JSF:JAVADOC:1036 |
void |
jakarta.faces.component.behavior.ClientBehaviorHolder.addClientBehavior
( String ,
ClientBehavior ) |
Attaches a ClientBehavior to the component implementing this interface
for the specified event. Valid event names for a UIComponent
implementation are defined by . |
true |
|
true |
| JSF:JAVADOC:1037 |
Map |
jakarta.faces.component.behavior.ClientBehaviorHolder.getClientBehaviors
|
Returns
a non-null, unmodifiable Map that contains the the ClientBehaviors
that have been attached to the component implementing this interface.
The keys in this Map are event names defined by #getEventNames. |
true |
|
true |
| JSF:JAVADOC:1038 |
String |
jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName
|
Returns
the default event name for this ClientBehaviorHolder implementation.
This must be one of the event names returned by #getEventNames or null
if the component does not have a default event. |
true |
|
true |
| JSF:JAVADOC:1039 |
Collection |
jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames
|
Returns
a non-null, unmodifiable Collection containing the names of the
logical events supported by the component implementing this interface.
|
true |
|
true |
| JSF:JAVADOC:1040 |
String |
jakarta.faces.component.behavior.FacesBehavior.value
|
|
true |
|
true |
| JSF:JAVADOC:1041 |
VisitResult |
jakarta.faces.component.visit.VisitCallback.visit
( VisitContext ,
UIComponent ) |
This
method is called during component tree visits by
VisitContext#invokeVisitCallback VisitContext.invokeVisitCallback() to
visit the specified component. At the point in time when this method
is called, the argument is guaranteed to be in the proper state with
respect to its ancestors in the View. |
true |
|
true |
| JSF:JAVADOC:1042 |
VisitContext |
jakarta.faces.component.visit.VisitContext.createVisitContext
( FacesContext ,
Collection ,
Set ) |
Returns
a VisitContext instance that is initialized with the specified ids and
hintsfor use with UIComponent#visitTree. |
true |
|
true |
| JSF:JAVADOC:1043 |
VisitContext |
jakarta.faces.component.visit.VisitContext.createVisitContext
( FacesContext ) |
Creates
a VisitContext instance for use with UIComponent#visitTree
UIComponent.visitTree(). This method can be used to obtain a
VisitContext instance when all components should be visited with the
default visit hints. |
true |
|
true |
| JSF:JAVADOC:1044 |
FacesContext |
jakarta.faces.component.visit.VisitContext.getFacesContext
|
Returns
the FacesContext for the current request. |
true |
|
true |
| JSF:JAVADOC:1045 |
Set |
jakarta.faces.component.visit.VisitContext.getHints
|
Returns
hints that influence the behavior of the tree visit. Interested
parties, such as UIComponent#visitTree UIComponent.visitTree()
implementations, may check to see whether a particular hint is present
by calling , passing in one of the hints defined by VisitHint. |
true |
|
true |
| JSF:JAVADOC:1046 |
Collection |
jakarta.faces.component.visit.VisitContext.getIdsToVisit
|
Returns
the ids of the components to visit. In the case of a full tree visit,
this method returns the ALL_IDS collection. Otherwise, if a partial
visit is beign performed, returns a modifiable collection containing
the client ids of the components that should be visited. |
true |
|
true |
| JSF:JAVADOC:1047 |
Collection |
jakarta.faces.component.visit.VisitContext.getSubtreeIdsToVisit
( UIComponent ) |
Given a
jakarta.faces.component.NamingContainer component, returns the client
ids of any components underneath the NamingContainer that should be
visited. This method is called by NamingContainer visitTree()
implementations to determine whether the NamingContainer contains
components to be visited. In the case where no such components exist,
the NamingContainer can short-circuit the tree visit and avoid
descending into child subtrees. In addition, iterating components such
as UIData may be able to use the returned ids to determine which
iterated states (ie. rows) need to be visited. This allows the visit
traversal to be contstrained such only those rows that contain visit
targets need to be traversed. |
true |
|
true |
| JSF:JAVADOC:1048 |
Collection |
jakarta.faces.component.visit.VisitContext.getSubtreeIdsToVisit
( UIComponent )
throws IllegalArgumentException
|
if
{@code component} is not an instance of NamingContainer |
true |
|
true |
| JSF:JAVADOC:1049 |
VisitResult |
jakarta.faces.component.visit.VisitContext.invokeVisitCallback
( UIComponent ,
VisitCallback ) |
Called
by UIComponent#visitTree UIComponent.visitTree() to visit a single
component. |
true |
|
true |
| JSF:JAVADOC:1050 |
VisitContext |
jakarta.faces.component.visit.VisitContext.VisitContext
|
|
true |
|
true |
| JSF:JAVADOC:1051 |
VisitContext |
jakarta.faces.component.visit.VisitContextFactory.getVisitContext
( FacesContext ,
Collection ,
Set ) |
Return
a new VisitContext instance. |
true |
|
true |
| JSF:JAVADOC:1052 |
VisitContextFactory |
jakarta.faces.component.visit.VisitContextFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:1053 |
VisitContextFactory |
jakarta.faces.component.visit.VisitContextFactory.VisitContextFactory
|
|
true |
|
true |
| JSF:JAVADOC:1054 |
FacesContext |
jakarta.faces.component.visit.VisitContextWrapper.getFacesContext
|
Returns
the FacesContext for the current request. |
true |
|
true |
| JSF:JAVADOC:1055 |
Set |
jakarta.faces.component.visit.VisitContextWrapper.getHints
|
Returns
hints that influence the behavior of the tree visit. Interested
parties, such as UIComponent#visitTree UIComponent.visitTree()
implementations, may check to see whether a particular hint is present
by calling , passing in one of the hints defined by VisitHint. |
true |
|
true |
| JSF:JAVADOC:1056 |
Collection |
jakarta.faces.component.visit.VisitContextWrapper.getIdsToVisit
|
Returns
the ids of the components to visit. In the case of a full tree visit,
this method returns the ALL_IDS collection. Otherwise, if a partial
visit is beign performed, returns a modifiable collection containing
the client ids of the components that should be visited. |
true |
|
true |
| JSF:JAVADOC:1057 |
Collection |
jakarta.faces.component.visit.VisitContextWrapper.getSubtreeIdsToVisit
( UIComponent ) |
Given a
jakarta.faces.component.NamingContainer component, returns the client
ids of any components underneath the NamingContainer that should be
visited. This method is called by NamingContainer visitTree()
implementations to determine whether the NamingContainer contains
components to be visited. In the case where no such components exist,
the NamingContainer can short-circuit the tree visit and avoid
descending into child subtrees. In addition, iterating components such
as UIData may be able to use the returned ids to determine which
iterated states (ie. rows) need to be visited. This allows the visit
traversal to be contstrained such only those rows that contain visit
targets need to be traversed. |
true |
|
true |
| JSF:JAVADOC:1058 |
Collection |
jakarta.faces.component.visit.VisitContextWrapper.getSubtreeIdsToVisit
( UIComponent )
throws IllegalArgumentException
|
if
{@code component} is not an instance of NamingContainer |
true |
|
true |
| JSF:JAVADOC:1059 |
VisitContext |
jakarta.faces.component.visit.VisitContextWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1060 |
VisitResult |
jakarta.faces.component.visit.VisitContextWrapper.invokeVisitCallback
( UIComponent ,
VisitCallback ) |
Called
by UIComponent#visitTree UIComponent.visitTree() to visit a single
component. |
true |
|
true |
| JSF:JAVADOC:1061 |
VisitContextWrapper |
jakarta.faces.component.visit.VisitContextWrapper.VisitContextWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1062 |
VisitHint |
jakarta.faces.component.visit.VisitHint.valueOf
( String ) |
|
true |
|
true |
| JSF:JAVADOC:1063 |
VisitHint[] |
jakarta.faces.component.visit.VisitHint.values
|
|
true |
|
true |
| JSF:JAVADOC:1064 |
VisitResult |
jakarta.faces.component.visit.VisitResult.valueOf
( String ) |
|
true |
|
true |
| JSF:JAVADOC:1065 |
VisitResult[] |
jakarta.faces.component.visit.VisitResult.values
|
|
true |
|
true |
| JSF:JAVADOC:1066 |
ExceptionHandler |
jakarta.faces.context.ExceptionHandler.ExceptionHandler
|
|
true |
|
true |
| JSF:JAVADOC:1067 |
ExceptionQueuedEvent |
jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvent
|
Return
the first ExceptionQueuedEvent handled by this handler. |
true |
|
true |
| JSF:JAVADOC:1068 |
Iterable |
jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvents
|
The
default implementation must return an Iterable over all
ExceptionQueuedEvents that have been handled by the #handle method. |
true |
|
true |
| JSF:JAVADOC:1069 |
Throwable |
jakarta.faces.context.ExceptionHandler.getRootCause
( Throwable ) |
Unwrap
the argument t until the unwrapping encounters an Object whose
getClass() is not equal to FacesException.class or
jakarta.el.ELException.class. If there is no root cause, null is
returned. |
true |
|
true |
| JSF:JAVADOC:1070 |
Throwable |
jakarta.faces.context.ExceptionHandler.getRootCause
( Throwable )
throws NullPointerException
|
if
argument t is null. |
true |
|
true |
| JSF:JAVADOC:1071 |
Iterable |
jakarta.faces.context.ExceptionHandler.getUnhandledExceptionQueuedEvents
|
Return
an Iterable over all ExceptionQueuedEvents that have not yet been
handled by the #handle method. |
true |
|
true |
| JSF:JAVADOC:1072 |
void |
jakarta.faces.context.ExceptionHandler.handle
|
Take
action to handle the Exception instances residing inside the
ExceptionQueuedEvent instances that have been queued by calls to
Application().publishEvent(ExceptionQueuedEvent.class, eventContext).
The requirements of the default implementation are detailed in section
JSF.6.2.1. |
true |
|
true |
| JSF:JAVADOC:1073 |
void |
jakarta.faces.context.ExceptionHandler.handle
throws FacesException
|
if and
only if a problem occurs while performing the algorithm to handle the
Exception, not as a means of conveying a handled Exception itself. |
true |
|
true |
| JSF:JAVADOC:1074 |
boolean |
jakarta.faces.context.ExceptionHandler.isListenerForSource
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:1075 |
void |
jakarta.faces.context.ExceptionHandler.processEvent
( SystemEvent ) |
|
true |
|
true |
| JSF:JAVADOC:1076 |
void |
jakarta.faces.context.ExceptionHandler.processEvent
( SystemEvent )
throws AbortProcessingException
|
|
true |
|
true |
| JSF:JAVADOC:1077 |
ExceptionHandlerFactory |
jakarta.faces.context.ExceptionHandlerFactory.ExceptionHandlerFactory
|
|
true |
|
true |
| JSF:JAVADOC:1078 |
ExceptionHandler |
jakarta.faces.context.ExceptionHandlerFactory.getExceptionHandler
|
Create
and return a A new ExceptionHandler instance. The implementation must
return an ExceptionHandler instance suitable for the environment. For
example, in some cases it may be desirable for an ExceptionHandler to
write error information to the response instead of throwing exceptions
as in the case of Ajax applications. |
true |
|
true |
| JSF:JAVADOC:1079 |
ExceptionHandlerFactory |
jakarta.faces.context.ExceptionHandlerFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:1080 |
ExceptionHandlerWrapper |
jakarta.faces.context.ExceptionHandlerWrapper.ExceptionHandlerWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1081 |
ExceptionQueuedEvent |
jakarta.faces.context.ExceptionHandlerWrapper.getHandledExceptionQueuedEvent
|
The
default behavior of this method is to call
ExceptionHandler#getHandledExceptionQueuedEvent() on the wrapped
ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1082 |
Iterable |
jakarta.faces.context.ExceptionHandlerWrapper.getHandledExceptionQueuedEvents
|
The
default behavior of this method is to call
ExceptionHandler#getHandledExceptionQueuedEvents() on the wrapped
ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1083 |
Throwable |
jakarta.faces.context.ExceptionHandlerWrapper.getRootCause
( Throwable ) |
The
default behavior of this method is to call
jakarta.faces.context.ExceptionHandler#getRootCause(Throwable) on the
wrapped ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1084 |
Iterable |
jakarta.faces.context.ExceptionHandlerWrapper.getUnhandledExceptionQueuedEvents
|
The
default behavior of this method is to call
ExceptionHandler#getUnhandledExceptionQueuedEvents() on the wrapped
ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1085 |
ExceptionHandler |
jakarta.faces.context.ExceptionHandlerWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1086 |
void |
jakarta.faces.context.ExceptionHandlerWrapper.handle
|
The
default behavior of this method is to call
jakarta.faces.context.ExceptionHandler#handle() on the wrapped
ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1087 |
void |
jakarta.faces.context.ExceptionHandlerWrapper.handle
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:1088 |
boolean |
jakarta.faces.context.ExceptionHandlerWrapper.isListenerForSource
( Object ) |
The
default behavior of this method is to call
jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) on
the wrapped ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1089 |
void |
jakarta.faces.context.ExceptionHandlerWrapper.processEvent
( SystemEvent ) |
The
default behavior of this method is to call
jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent)
on the wrapped ExceptionHandler object. |
true |
|
true |
| JSF:JAVADOC:1090 |
void |
jakarta.faces.context.ExceptionHandlerWrapper.processEvent
( SystemEvent )
throws AbortProcessingException
|
|
true |
|
true |
| JSF:JAVADOC:1091 |
void |
jakarta.faces.context.ExternalContext.addResponseCookie
( String ,
String ,
Map ) |
Adds
the cookie represented by the arguments to the response. Servlet: This
must be accomplished by calling the
jakarta.servlet.http.HttpServletResponse method addCookie(). The Cookie
argument must be constructed by passing the name and value parameters.
If the properties arugument is non-null and not empty, the Cookie
instance must be initialized as described below. Key in "values" Map
Expected type of value. Name of setter method on Cookie instance to be
set with the value from the Map. comment String setComment domain
String setDomain maxAge Integer setMaxAge secure Boolean setSecure
path String setPath The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1092 |
void |
jakarta.faces.context.ExternalContext.addResponseCookie
( String ,
String ,
Map )
throws IllegalArgumentException
|
if the
properties Map is not-null and not empty and contains any keys that
are not one of the keys listed above. |
true |
|
true |
| JSF:JAVADOC:1093 |
void |
jakarta.faces.context.ExternalContext.addResponseHeader
( String ,
String ) |
Add the
given name and value to the response header. Servlet:This must be
performed by calling the jakarta.servlet.http.HttpServletResponse
addHeader method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1094 |
void |
jakarta.faces.context.ExternalContext.dispatch
( String ) |
Dispatch a request to the specified resource to create output for this
response. Servlet: This must be accomplished by calling the
jakarta.servlet.ServletContext method getRequestDispatcher(path), and
calling the forward() method on the resulting object. |
true |
|
true |
| JSF:JAVADOC:1095 |
void |
jakarta.faces.context.ExternalContext.dispatch
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1096 |
void |
jakarta.faces.context.ExternalContext.dispatch
( String )
throws FacesException
|
thrown
if a ServletException occurs |
true |
|
true |
| JSF:JAVADOC:1097 |
void |
jakarta.faces.context.ExternalContext.dispatch
( String )
throws IllegalArgumentException
|
if no
request dispatcher can be created for the specified path |
true |
|
true |
| JSF:JAVADOC:1098 |
void |
jakarta.faces.context.ExternalContext.dispatch
( String )
throws NullPointerException
|
if path
is null |
true |
|
true |
| JSF:JAVADOC:1099 |
String |
jakarta.faces.context.ExternalContext.encodeActionURL
( String ) |
Return
the input URL, after performing any rewriting needed to ensure that it
will correctly identify an addressable action in the current
application. Servlet: This must be the value returned by the
jakarta.servlet.http.HttpServletResponse method encodeURL(url). |
true |
|
true |
| JSF:JAVADOC:1100 |
String |
jakarta.faces.context.ExternalContext.encodeActionURL
( String )
throws NullPointerException
|
if url
is null |
true |
|
true |
| JSF:JAVADOC:1101 |
String |
jakarta.faces.context.ExternalContext.encodeBookmarkableURL
( String ,
Map ) |
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. This method must be able
to encode the parameters to a baseUrl that may or may not have
existing query parameters. The parameter values should be encoded
appropriately for the environment so that the resulting URL can be
used as the target of a link (e.g., in an href attribute) in a JSF
response. It's possible for an ExternalContext implementation to
override this method in any way that would make the URL bookmarkable
in that environment. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1102 |
String |
jakarta.faces.context.ExternalContext.encodeNamespace
( String ) |
Return
the specified name, after prefixing it with a namespace that ensures
that it will be unique within the context of a particular page.
Servlet: The input value must be returned unchanged. |
true |
|
true |
| JSF:JAVADOC:1103 |
String |
jakarta.faces.context.ExternalContext.encodeNamespace
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1104 |
String |
jakarta.faces.context.ExternalContext.encodePartialActionURL
( String ) |
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.
Servlet:Returns the same encoded URL as the #encodeActionURL(String
url) method. Portlet:Returns an encoded URL that, upon HTTP POST, will
invoke the RESOURCE_PHASE of the portlet lifecycle. |
true |
|
true |
| JSF:JAVADOC:1105 |
String |
jakarta.faces.context.ExternalContext.encodePartialActionURL
( String )
throws NullPointerException
|
if url
is null |
true |
|
true |
| JSF:JAVADOC:1106 |
String |
jakarta.faces.context.ExternalContext.encodeRedirectURL
( String ,
Map ) |
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. This method must be able
to encode the parameters to a baseUrl that may or may not have
existing query parameters. The parameter values should be encoded
appropriately for the environment so that the resulting URL can be
used as the target of a redirect. It's possible for an ExternalContext
implementation to override this method to accomodate the definition of
redirect for that environment. |
true |
|
true |
| JSF:JAVADOC:1107 |
String |
jakarta.faces.context.ExternalContext.encodeResourceURL
( String ) |
Return
the input URL, after performing any rewriting needed to ensure that it
will correctly identify an addressable resource in the current
application. Servlet: This must be the value returned by the
jakarta.servlet.http.HttpServletResponse method encodeURL(url). |
true |
|
true |
| JSF:JAVADOC:1108 |
String |
jakarta.faces.context.ExternalContext.encodeResourceURL
( String )
throws NullPointerException
|
if url
is null |
true |
|
true |
| JSF:JAVADOC:1109 |
ExternalContext |
jakarta.faces.context.ExternalContext.ExternalContext
|
|
true |
|
true |
| JSF:JAVADOC:1110 |
Map |
jakarta.faces.context.ExternalContext.getApplicationMap
|
Return
a mutable Map representing the application scope attributes for the
current application. The returned Map must implement the entire
contract for a modifiable map as described in the JavaDocs for
java.util.Map. Modifications made in the Map must cause the
corresponding changes in the set of application scope attributes.
Particularly the clear(), remove(), put(), putAll(), and get()
operations must take the appropriate action on the underlying data
structure. For any of the Map methods that cause an element to be
removed from the underlying data structure, the following action
regarding managed-beans must be taken. If the element to be removed is
a managed-bean, and it has one or more public no-argument void return
methods annotated with jakarta.annotation.PreDestroy, each such method
must be called before the element is removed from the underlying data
structure. Elements that are not managed-beans, but do happen to have
methods with that annotation must not have those methods called on
removal. Any exception thrown by the PreDestroy annotated methods must
by caught and not rethrown. The exception may be logged. It is valid
to call this method during application startup or shutdown. If called
at startup or shutdown time, this method returns a Map that is backed
by the same container context instance (ServletContext or
PortletContext) as the one returned by calling getApplicationMap() on
the ExternalContext returned by the FacesContext during an actual
request. Servlet: This must be the set of attributes available via the
jakarta.servlet.ServletContext methods getAttribute(),
getAttributeNames(), removeAttribute(), and setAttribute(). |
true |
|
true |
| JSF:JAVADOC:1111 |
String |
jakarta.faces.context.ExternalContext.getAuthType
|
Return
the name of the authentication scheme used to authenticate the current
user, if any; otherwise, return null. For standard authentication
schemes, the returned value will match one of the following constants:
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, or FORM_AUTH. Servlet: This
must be the value returned by the
jakarta.servlet.http.HttpServletRequest method getAuthType(). |
true |
|
true |
| JSF:JAVADOC:1112 |
Object |
jakarta.faces.context.ExternalContext.getContext
|
Return
the application environment object instance for the current
appication. It is valid to call this method during application startup
or shutdown. If called during application startup or shutdown, this
returns the same container context instance (ServletContext or
PortletContext) as the one returned when calling getContext() on the
ExternalContext returned by the FacesContext during an actual request.
Servlet: This must be the current application's
jakarta.servlet.ServletContext instance. |
true |
|
true |
| JSF:JAVADOC:1113 |
String |
jakarta.faces.context.ExternalContext.getContextName
|
Return
the name of the container context for this application. Return the
result of calling getServletContextName() on the ServletContext
instance for this application. It is valid to call this method during
application startup or shutdown. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1114 |
Flash |
jakarta.faces.context.ExternalContext.getFlash
|
Return
the threadsafe Flash for this application. The default implementation
will throw UnsupportedOperationException. Compliant JSF runtimes must
provide an implementation of this method. |
true |
|
true |
| JSF:JAVADOC:1115 |
String |
jakarta.faces.context.ExternalContext.getInitParameter
( String ) |
Return
the value of the specified application initialization parameter (if
any). Servlet: This must be the result of the
jakarta.servlet.ServletContext method getInitParameter(name). It is
valid to call this method during application startup or shutdown. If
called during application startup or shutdown, this method calls
through to the actual container context to return the init parameter
value. |
true |
|
true |
| JSF:JAVADOC:1116 |
String |
jakarta.faces.context.ExternalContext.getInitParameter
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1117 |
Map |
jakarta.faces.context.ExternalContext.getInitParameterMap
|
Return
an immutable Map whose keys are the set of application initialization
parameter names configured for this application, and whose values are
the corresponding parameter values. The returned Map must implement
the entire contract for an unmodifiable map as described in the
JavaDocs for java.util.Map. It is valid to call this method during
application startup or shutdown. If called during application startup
or shutdown, this method returns a Map that is backed by the same
container context instance (ServletContext or PortletContext) as the
one returned by calling getInitParameterMap() on the ExternalContext
returned by the FacesContext during an actual request. Servlet: This
result must be as if it were synthesized by calling the
jakarta.servlet.ServletContext method getInitParameterNames, and putting
each configured parameter name/value pair into the result. |
true |
|
true |
| JSF:JAVADOC:1118 |
String |
jakarta.faces.context.ExternalContext.getMimeType
( String ) |
Returns
the MIME type of the specified file or null if the MIME type is not
known. The MIME type is determined by the container. It is valid to
call this method during application startup or shutdown. If called
during application startup or shutdown, this method calls through to
the getMimeType() method on the same container context instance
(ServletContext or PortletContext) as the one used when calling
getMimeType() on the ExternalContext returned by the FacesContext
during an actual request. Servlet: This must be the value returned by
the jakarta.servlet.ServletContext method getMimeType(). |
true |
|
true |
| JSF:JAVADOC:1119 |
String |
jakarta.faces.context.ExternalContext.getRealPath
( String ) |
Returns
a String containing the real path for a given virtual path. Servlet:
This must be the value returned by the jakarta.servlet.ServletContext
method getRealPath(). The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1120 |
String |
jakarta.faces.context.ExternalContext.getRemoteUser
|
Return
the login name of the user making the current request if any;
otherwise, return null. Servlet: This must be the value returned by
the jakarta.servlet.http.HttpServletRequest method getRemoteUser(). |
true |
|
true |
| JSF:JAVADOC:1121 |
Object |
jakarta.faces.context.ExternalContext.getRequest
|
Return
the environment-specific object instance for the current request.
Servlet: This must be the current request's
jakarta.servlet.http.HttpServletRequest instance. |
true |
|
true |
| JSF:JAVADOC:1122 |
String |
jakarta.faces.context.ExternalContext.getRequestCharacterEncoding
|
Return
the character encoding currently being used to interpret this request.
Servlet: This must return the value returned by the
jakarta.servlet.ServletRequest method getCharacterEncoding(). The
default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1123 |
int |
jakarta.faces.context.ExternalContext.getRequestContentLength
|
Return
the result of calling getContentLenth() on the ServletRequest instance
for this request. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1124 |
String |
jakarta.faces.context.ExternalContext.getRequestContentType
|
Return
the MIME Content-Type for this request. If not available, return null.
Servlet: This must return the value returned by the
jakarta.servlet.ServletRequest method getContentType(). The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1125 |
String |
jakarta.faces.context.ExternalContext.getRequestContextPath
|
Return
the portion of the request URI that identifies the web application
context for this request. Servlet: This must be the value returned by
the jakarta.servlet.http.HttpServletRequest method getContextPath(). |
true |
|
true |
| JSF:JAVADOC:1126 |
Map |
jakarta.faces.context.ExternalContext.getRequestCookieMap
|
Return
an immutable 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. The returned Map must
implement the entire contract for an unmodifiable map as described in
the JavaDocs for java.util.Map. Servlet: This must be the value
returned by the jakarta.servlet.http.HttpServletRequest method
getCookies(), unless null was returned, in which case this must be a
zero-length array. |
true |
|
true |
| JSF:JAVADOC:1127 |
Map |
jakarta.faces.context.ExternalContext.getRequestHeaderMap
|
Return
an immutable 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. The returned Map must implement the entire
contract for an unmodifiable map as described in the JavaDocs for
java.util.Map. In addition, key comparisons must be performed in a
case insensitive manner. Servlet: This must be the set of headers
available via the jakarta.servlet.http.HttpServletRequest methods
getHeader() and getHeaderNames(). |
true |
|
true |
| JSF:JAVADOC:1128 |
Map |
jakarta.faces.context.ExternalContext.getRequestHeaderValuesMap
|
Return
an immutable 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. The returned Map must implement the entire contract for an
unmodifiable map as described in the JavaDocs for java.util.Map. In
addition, key comparisons must be performed in a case insensitive
manner. Servlet: This must be the set of headers available via the
jakarta.servlet.http.HttpServletRequest methods getHeaders() and
getHeaderNames(). |
true |
|
true |
| JSF:JAVADOC:1129 |
Locale |
jakarta.faces.context.ExternalContext.getRequestLocale
|
Return
the preferred Locale in which the client will accept content. Servlet:
This must be the value returned by the jakarta.servlet.ServletRequest
method getLocale(). |
true |
|
true |
| JSF:JAVADOC:1130 |
Iterator |
jakarta.faces.context.ExternalContext.getRequestLocales
|
Return
an Iterator over the preferred Locales specified in the request, in
decreasing order of preference. Servlet: This must be an Iterator over
the values returned by the jakarta.servlet.ServletRequest method
getLocales(). |
true |
|
true |
| JSF:JAVADOC:1131 |
Map |
jakarta.faces.context.ExternalContext.getRequestMap
|
Return
a mutable Map representing the request scope attributes for the
current application. The returned Map must implement the entire
contract for a modifiable map as described in the JavaDocs for
java.util.Map. Modifications made in the Map must cause the
corresponding changes in the set of request scope attributes.
Particularly the clear(), remove(), put(), putAll(), and get()
operations must take the appropriate action on the underlying data
structure. For any of the Map methods that cause an element to be
removed from the underlying data structure, the following action
regarding managed-beans must be taken. If the element to be removed is
a managed-bean, and it has one or more public no-argument void return
methods annotated with jakarta.annotation.PreDestroy, each such method
must be called before the element is removed from the underlying data
structure. Elements that are not managed-beans, but do happen to have
methods with that annotation must not have those methods called on
removal. Any exception thrown by the PreDestroy annotated methods must
by caught and not rethrown. The exception may be logged. Servlet: This
must be the set of attributes available via the
jakarta.servlet.ServletRequest methods getAttribute(),
getAttributeNames(), removeAttribute(), and setAttribute(). |
true |
|
true |
| JSF:JAVADOC:1132 |
Map |
jakarta.faces.context.ExternalContext.getRequestParameterMap
|
Return
an immutable 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. The returned Map must implement the entire
contract for an unmodifiable map as described in the JavaDocs for
java.util.Map. Servlet: This must be the set of parameters available
via the jakarta.servlet.ServletRequest methods getParameter() and
getParameterNames(). |
true |
|
true |
| JSF:JAVADOC:1133 |
Iterator |
jakarta.faces.context.ExternalContext.getRequestParameterNames
|
Return
an Iterator over the names of all request parameters included in the
current request. Servlet: This must be an Iterator over the values
returned by the jakarta.servlet.ServletRequest method
getParameterNames(). |
true |
|
true |
| JSF:JAVADOC:1134 |
Map |
jakarta.faces.context.ExternalContext.getRequestParameterValuesMap
|
Return
an immutable 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. The returned Map must implement the entire
contract for an unmodifiable map as described in the JavaDocs for
java.util.Map. Servlet: This must be the set of parameters available
via the jakarta.servlet.ServletRequest methods getParameterValues() and
getParameterNames(). |
true |
|
true |
| JSF:JAVADOC:1135 |
String |
jakarta.faces.context.ExternalContext.getRequestPathInfo
|
Return
the extra path information (if any) included in the request URI;
otherwise, return null. Servlet: This must be the value returned by
the jakarta.servlet.http.HttpServletRequest method getPathInfo(). |
true |
|
true |
| JSF:JAVADOC:1136 |
String |
jakarta.faces.context.ExternalContext.getRequestScheme
|
Returns
the name of the scheme used to make this request, for example, http,
https, or ftp. Servlet: This must be the value returned by the
jakarta.servlet.ServletRequest method getScheme(). The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1137 |
String |
jakarta.faces.context.ExternalContext.getRequestServerName
|
Returns
the host name of the server to which the request was sent. Servlet:
This must be the value returned by the jakarta.servlet.ServletRequest
method getServerName(). The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1138 |
int |
jakarta.faces.context.ExternalContext.getRequestServerPort
|
Returns
the port number to which the request was sent. Servlet: This must be
the value returned by the jakarta.servlet.ServletRequest method
getServerPort(). The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1139 |
String |
jakarta.faces.context.ExternalContext.getRequestServletPath
|
Return
the servlet path information (if any) included in the request URI;
otherwise, return null. Servlet: This must be the value returned by
the jakarta.servlet.http.HttpServletRequest method getServletPath(). |
true |
|
true |
| JSF:JAVADOC:1140 |
URL |
jakarta.faces.context.ExternalContext.getResource
( String ) |
Return
a URL for the application resource mapped to the specified path, if it
exists; otherwise, return null. It is valid to call this method during
application startup or shutdown. If called during application startup
or shutdown, this method calls through to the getResource() method on
the same container context instance (ServletContext or PortletContext)
as the one used when calling getResource() on the ExternalContext
returned by the FacesContext during an actual request. Servlet: This
must be the value returned by the jakarta.servlet.ServletContext method
getResource(path). |
true |
|
true |
| JSF:JAVADOC:1141 |
URL |
jakarta.faces.context.ExternalContext.getResource
( String )
throws MalformedURLException
|
if the
specified path is not in the correct form |
true |
|
true |
| JSF:JAVADOC:1142 |
URL |
jakarta.faces.context.ExternalContext.getResource
( String )
throws NullPointerException
|
if path
is null |
true |
|
true |
| JSF:JAVADOC:1143 |
InputStream |
jakarta.faces.context.ExternalContext.getResourceAsStream
( String ) |
Return
an InputStream for an application resource mapped to the specified
path, if it exists; otherwise, return null. It is valid to call this
method during application startup or shutdown. If called during
application startup or shutdown, this method calls through to the
getResourceAsStream() method on the same container context instance
(ServletContext or PortletContext) as the one used when calling
getResourceAsStream() on the ExternalContext returned by the
FacesContext during an actual request. Servlet: This must be the value
returned by the jakarta.servlet.ServletContext method
getResourceAsStream(path). |
true |
|
true |
| JSF:JAVADOC:1144 |
InputStream |
jakarta.faces.context.ExternalContext.getResourceAsStream
( String )
throws NullPointerException
|
if path
is null |
true |
|
true |
| JSF:JAVADOC:1145 |
Set |
jakarta.faces.context.ExternalContext.getResourcePaths
( String ) |
Return
the Set of resource paths for all application resources whose resource
path starts with the specified argument. It is valid to call this
method during application startup or shutdown. If called during
application startup or shutdown, this method calls through to the
getResourcePaths() method on the same container context instance
(ServletContext or PortletContext) as the one used when calling
getResourcePaths() on the ExternalContext returned by the FacesContext
during an actual request. Servlet: This must be the value returned by
the jakarta.servlet.ServletContext method getResourcePaths(path). |
true |
|
true |
| JSF:JAVADOC:1146 |
Set |
jakarta.faces.context.ExternalContext.getResourcePaths
( String )
throws NullPointerException
|
if path
is null |
true |
|
true |
| JSF:JAVADOC:1147 |
Object |
jakarta.faces.context.ExternalContext.getResponse
|
Return
the environment-specific object instance for the current response.
Servlet: This is the current request's
jakarta.servlet.http.HttpServletResponse instance. |
true |
|
true |
| JSF:JAVADOC:1148 |
int |
jakarta.faces.context.ExternalContext.getResponseBufferSize
|
Return
the buffer size for the current response. Servlet: This must be
performed by calling the jakarta.servlet.http.HttpServletResponse
getBufferSize method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1149 |
String |
jakarta.faces.context.ExternalContext.getResponseCharacterEncoding
|
Returns
the name of the character encoding (MIME charset) used for the body
sent in this response. Servlet: This must return the value returned by
the jakarta.servlet.ServletResponse method getCharacterEncoding(). The
default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1150 |
String |
jakarta.faces.context.ExternalContext.getResponseContentType
|
Return
the MIME Content-Type for this response. If not available, return
null. Servlet: This must return the value returned by the
jakarta.servlet.ServletResponse method getContentType(). The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1151 |
OutputStream |
jakarta.faces.context.ExternalContext.getResponseOutputStream
|
Returns
an OutputStream suitable for writing binary data to the user-agent.
Servlet: This must return the value returned by the
jakarta.servlet.ServletResponse method getOutputStream(). The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1152 |
OutputStream |
jakarta.faces.context.ExternalContext.getResponseOutputStream
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1153 |
Writer |
jakarta.faces.context.ExternalContext.getResponseOutputWriter
|
Returns
a Writer suitable for writing character data to the user-agent.
Servlet: This must return the value returned by the
jakarta.servlet.ServletResponse#getWriter. The default implementation
throws UnsupportedOperationException and is provided for the sole
purpose of not breaking existing applications that extend this class.
|
true |
|
true |
| JSF:JAVADOC:1154 |
Writer |
jakarta.faces.context.ExternalContext.getResponseOutputWriter
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1155 |
Object |
jakarta.faces.context.ExternalContext.getSession
( boolean ) |
If the
create parameter is true, create (if necessary) and return a session
instance associated with the current request. If the create parameter
is false return any existing session instance associated with the
current request, or return null if there is no such session. Servlet:
This must return the result of calling getSession(create) on the
underlying jakarta.servlet.http.HttpServletRequest instance. |
true |
|
true |
| JSF:JAVADOC:1156 |
Map |
jakarta.faces.context.ExternalContext.getSessionMap
|
Return
a mutable Map representing the session scope attributes for the
current application. The returned Map must implement the entire
contract for a modifiable map as described in the JavaDocs for
java.util.Map. Modifications made in the Map must cause the
corresponding changes in the set of session scope attributes.
Particularly the clear(), remove(), put(), and get() operations must
take the appropriate action on the underlying data structure.
Accessing attributes via this Map must cause the creation of a session
associated with the current request, if such a session does not
already exist. For any of the Map methods that cause an element to be
removed from the underlying data structure, the following action
regarding managed-beans must be taken. If the element to be removed is
a managed-bean, and it has one or more public no-argument void return
methods annotated with jakarta.annotation.PreDestroy, each such method
must be called before the element is removed from the underlying data
structure. Elements that are not managed-beans, but do happen to have
methods with that annotation must not have those methods called on
removal. Any exception thrown by the PreDestroy annotated methods must
by caught and not rethrown. The exception may be logged. Servlet: This
must be the set of attributes available via the
jakarta.servlet.http.HttpServletSession methods getAttribute(),
getAttributeNames(), removeAttribute(), and setAttribute(). |
true |
|
true |
| JSF:JAVADOC:1157 |
Principal |
jakarta.faces.context.ExternalContext.getUserPrincipal
|
Return
the Principal object containing the name of the current authenticated
user, if any; otherwise, return null. Servlet: This must be the value
returned by the jakarta.servlet.http.HttpServletRequest method
getUserPrincipal(). |
true |
|
true |
| JSF:JAVADOC:1158 |
void |
jakarta.faces.context.ExternalContext.invalidateSession
|
Invalidates this session then unbinds any objects bound to it.
Servlet: This must be the value returned by the
jakarta.servlet.http.HttpSession method invalidate(). The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1159 |
boolean |
jakarta.faces.context.ExternalContext.isResponseCommitted
|
Check
if the current response has been committed. Servlet: This must be
performed by calling the jakarta.servlet.http.HttpServletResponse
isCommitted method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1160 |
boolean |
jakarta.faces.context.ExternalContext.isUserInRole
( String ) |
Return
true if the currently authenticated user is included in the specified
role. Otherwise, return false. Servlet: This must be the value
returned by the jakarta.servlet.http.HttpServletRequest method
isUserInRole(role). |
true |
|
true |
| JSF:JAVADOC:1161 |
boolean |
jakarta.faces.context.ExternalContext.isUserInRole
( String )
throws NullPointerException
|
if role
is null |
true |
|
true |
| JSF:JAVADOC:1162 |
void |
jakarta.faces.context.ExternalContext.log
( String ) |
Log the
specified message to the application object. It is valid to call this
method during application startup or shutdown. If called during
application startup or shutdown, this calls the log() method on the
same container context instance (ServletContext or PortletContext) as
the one used during a call to log() on the ExternalContext returned by
the FacesContext during an actual request. Servlet: This must be
performed by calling the jakarta.servlet.ServletContext method
log(String). |
true |
|
true |
| JSF:JAVADOC:1163 |
void |
jakarta.faces.context.ExternalContext.log
( String )
throws NullPointerException
|
if
message is null |
true |
|
true |
| JSF:JAVADOC:1164 |
void |
jakarta.faces.context.ExternalContext.log
( String ,
Throwable ) |
Log the
specified message and exception to the application object. It is valid
to call this method during application startup or shutdown. If called
during application startup or shutdown, this calls the log() method on
the same container context instance (ServletContext or PortletContext)
as the one used when calling log() on the ExternalContext returned by
the FacesContext during an actual request. Servlet: This must be
performed by calling the jakarta.servlet.ServletContext method
log(String,Throwable). |
true |
|
true |
| JSF:JAVADOC:1165 |
void |
jakarta.faces.context.ExternalContext.log
( String ,
Throwable )
throws NullPointerException
|
if
message or exception is null |
true |
|
true |
| JSF:JAVADOC:1166 |
void |
jakarta.faces.context.ExternalContext.redirect
( String ) |
Redirect a request to the specified URL, and cause the
responseComplete() method to be called on the FacesContext instance
for the current request. The implementation must determine if the
request is an Ajax request by obtaining a PartialViewContext instance
from the FacesContext and calling PartialViewContext#isAjaxRequest().
Servlet: For non Ajax requests, this must be accomplished by calling
the jakarta.servlet.http.HttpServletResponse method sendRedirect(). For
Ajax requests, the implementation must: Get a PartialResponseWriter
instance from the FacesContext. Call #setResponseContentType with
text/xml Call #setResponseCharacterEncoding with UTF-8 Call
#addResponseHeader with Cache-Control, no-cache Call
PartialResponseWriter#startDocument Call
PartialResponseWriter#redirect with the url argument. Call
PartialResponseWriter#endDocument |
true |
|
true |
| JSF:JAVADOC:1167 |
void |
jakarta.faces.context.ExternalContext.redirect
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1168 |
void |
jakarta.faces.context.ExternalContext.redirect
( String )
throws IllegalArgumentException
|
if the
specified url is relative |
true |
|
true |
| JSF:JAVADOC:1169 |
void |
jakarta.faces.context.ExternalContext.redirect
( String )
throws IllegalStateException
|
if, in a
portlet environment, the current response object is a RenderResponse
instead of an ActionResponse |
true |
|
true |
| JSF:JAVADOC:1170 |
void |
jakarta.faces.context.ExternalContext.redirect
( String )
throws IllegalStateException
|
if, in a
servlet environment, the current response has already been committed |
true |
|
true |
| JSF:JAVADOC:1171 |
void |
jakarta.faces.context.ExternalContext.responseFlushBuffer
|
Flushes
the buffered response content to the client. Servlet: This must be
performed by calling the jakarta.servlet.http.HttpServletResponse
flushBuffer method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1172 |
void |
jakarta.faces.context.ExternalContext.responseFlushBuffer
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1173 |
void |
jakarta.faces.context.ExternalContext.responseReset
|
Resets
the current response. Servlet: This must be performed by calling the
jakarta.servlet.http.HttpServletResponse reset method. The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1174 |
void |
jakarta.faces.context.ExternalContext.responseSendError
( int ,
String ) |
Sends
an HTTP status code with message. Servlet: This must be performed by
calling the jakarta.servlet.http.HttpServletResponse sendError method.
The default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1175 |
void |
jakarta.faces.context.ExternalContext.responseSendError
( int ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1176 |
void |
jakarta.faces.context.ExternalContext.setRequest
( Object ) |
Set the
environment-specific request to be returned by subsequent calls to
#getRequest. This may be used to install a wrapper for the request.
The default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1177 |
void |
jakarta.faces.context.ExternalContext.setRequestCharacterEncoding
( String ) |
Overrides the name of the character encoding used in the body of this
request. Calling this method after the request has been accessed will
have no no effect, unless a Reader or Stream has been obtained from
the request, in which case an IllegalStateException is thrown.
Servlet: This must call through to the jakarta.servlet.ServletRequest
method setCharacterEncoding(). The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1178 |
void |
jakarta.faces.context.ExternalContext.setRequestCharacterEncoding
( String )
throws UnsupportedEncodingException
|
if this
is not a valid encoding |
true |
|
true |
| JSF:JAVADOC:1179 |
void |
jakarta.faces.context.ExternalContext.setResponse
( Object ) |
Set the
environment-specific response to be returned by subsequent calls to
#getResponse. This may be used to install a wrapper for the response.
The default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1180 |
void |
jakarta.faces.context.ExternalContext.setResponseBufferSize
( int ) |
Set the
buffer size for the current response. Servlet: This must be performed
by calling the jakarta.servlet.http.HttpServletResponse setBufferSize
method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1181 |
void |
jakarta.faces.context.ExternalContext.setResponseCharacterEncoding
( String ) |
Sets
the character encoding (MIME charset) of the response being sent to
the client, for example, to UTF-8. Servlet: This must call through to
the jakarta.servlet.ServletResponse method setCharacterEncoding(). The
default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1182 |
void |
jakarta.faces.context.ExternalContext.setResponseContentLength
( int ) |
Set the
content length of the response. Servlet: This must be performed by
calling the jakarta.servlet.http.HttpServletResponse setContentLength
method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1183 |
void |
jakarta.faces.context.ExternalContext.setResponseContentType
( String ) |
Sets
the content type of the response being sent to the client, if the
response has not been committed yet. Servlet: This must call
setContentType() on the underlying jakarta.servlet.ServletResponse
instance. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1184 |
void |
jakarta.faces.context.ExternalContext.setResponseHeader
( String ,
String ) |
Set the
response header with the given name and value. Servlet:This must be
performed by calling the jakarta.servlet.http.HttpServletResponse
setHeader method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1185 |
void |
jakarta.faces.context.ExternalContext.setResponseStatus
( int ) |
Sets
the HTTP status code for the response. Servlet: This must be performed
by calling the jakarta.servlet.http.HttpServletResponse setStatus
method. The default implementation throws
UnsupportedOperationException and is provided for the sole purpose of
not breaking existing applications that extend this class. |
true |
|
true |
| JSF:JAVADOC:1186 |
ExternalContextFactory |
jakarta.faces.context.ExternalContextFactory.ExternalContextFactory
|
|
true |
|
true |
| JSF:JAVADOC:1187 |
ExternalContext |
jakarta.faces.context.ExternalContextFactory.getExternalContext
( Object ,
Object ,
Object ) |
Create
(if needed) and return an ExternalContext instance that is initialized
for the processing of the specified request and response objects, for
this web application. |
true |
|
true |
| JSF:JAVADOC:1188 |
ExternalContext |
jakarta.faces.context.ExternalContextFactory.getExternalContext
( Object ,
Object ,
Object )
throws FacesException
|
if a
ExternalContext cannot be constructed for the specified parameters |
true |
|
true |
| JSF:JAVADOC:1189 |
ExternalContext |
jakarta.faces.context.ExternalContextFactory.getExternalContext
( Object ,
Object ,
Object )
throws NullPointerException
|
if any
of the parameters are null |
true |
|
true |
| JSF:JAVADOC:1190 |
ExternalContextFactory |
jakarta.faces.context.ExternalContextFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:1191 |
void |
jakarta.faces.context.ExternalContextWrapper.addResponseCookie
( String ,
String ,
Map ) |
The
default behavior of this method is to call
ExternalContext#addResponseCookie(String, String, Map) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1192 |
void |
jakarta.faces.context.ExternalContextWrapper.addResponseHeader
( String ,
String ) |
The
default behavior of this method is to call
ExternalContext#addResponseHeader(String,String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1193 |
void |
jakarta.faces.context.ExternalContextWrapper.dispatch
( String ) |
The
default behavior of this method is to call
ExternalContext#dispatch(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1194 |
void |
jakarta.faces.context.ExternalContextWrapper.dispatch
( String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1195 |
String |
jakarta.faces.context.ExternalContextWrapper.encodeActionURL
( String ) |
The
default behavior of this method is to call
ExternalContext#encodeActionURL(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1196 |
String |
jakarta.faces.context.ExternalContextWrapper.encodeBookmarkableURL
( String ,
Map ) |
The
default behavior of this method is to call
jakarta.faces.context.ExternalContext#encodeBookmarkableURL(String,
java.util.Map) on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1197 |
String |
jakarta.faces.context.ExternalContextWrapper.encodeNamespace
( String ) |
The
default behavior of this method is to call
ExternalContext#encodeNamespace(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1198 |
String |
jakarta.faces.context.ExternalContextWrapper.encodePartialActionURL
( String ) |
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.
Servlet:Returns the same encoded URL as the #encodeActionURL(String
url) method. Portlet:Returns an encoded URL that, upon HTTP POST, will
invoke the RESOURCE_PHASE of the portlet lifecycle. |
true |
|
true |
| JSF:JAVADOC:1199 |
String |
jakarta.faces.context.ExternalContextWrapper.encodePartialActionURL
( String )
throws NullPointerException
|
if url
is null |
true |
|
true |
| JSF:JAVADOC:1200 |
String |
jakarta.faces.context.ExternalContextWrapper.encodeRedirectURL
( String ,
Map ) |
The
default behavior of this method is to call
jakarta.faces.context.ExternalContext#encodeRedirectURL(String,
java.util.Map) on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1201 |
String |
jakarta.faces.context.ExternalContextWrapper.encodeResourceURL
( String ) |
The
default behavior of this method is to call
ExternalContext#encodeResourceURL(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1202 |
ExternalContextWrapper |
jakarta.faces.context.ExternalContextWrapper.ExternalContextWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1203 |
Map |
jakarta.faces.context.ExternalContextWrapper.getApplicationMap
|
The
default behavior of this method is to call
ExternalContext#getApplicationMap on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1204 |
String |
jakarta.faces.context.ExternalContextWrapper.getAuthType
|
The
default behavior of this method is to call ExternalContext#getAuthType
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1205 |
Object |
jakarta.faces.context.ExternalContextWrapper.getContext
|
The
default behavior of this method is to call ExternalContext#getContext
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1206 |
String |
jakarta.faces.context.ExternalContextWrapper.getContextName
|
The
default behavior of this method is to call
ExternalContext#getContextName on the wrapped ExternalContext object.
|
true |
|
true |
| JSF:JAVADOC:1207 |
Flash |
jakarta.faces.context.ExternalContextWrapper.getFlash
|
The
default behavior of this method is to call ExternalContext#getFlash()
on the wrapped ExternalContext object.</p? |
true |
|
true |
| JSF:JAVADOC:1208 |
String |
jakarta.faces.context.ExternalContextWrapper.getInitParameter
( String ) |
The
default behavior of this method is to call
ExternalContext#getInitParameter(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1209 |
Map |
jakarta.faces.context.ExternalContextWrapper.getInitParameterMap
|
The
default behavior of this method is to call
ExternalContext#getInitParameterMap on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1210 |
String |
jakarta.faces.context.ExternalContextWrapper.getMimeType
( String ) |
The
default behavior of this method is to call
ExternalContext#getMimeType(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1211 |
String |
jakarta.faces.context.ExternalContextWrapper.getRealPath
( String ) |
The
default behavior of this method is to call
ExternalContext#getRealPath(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1212 |
String |
jakarta.faces.context.ExternalContextWrapper.getRemoteUser
|
The
default behavior of this method is to call
ExternalContext#getRemoteUser on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1213 |
Object |
jakarta.faces.context.ExternalContextWrapper.getRequest
|
The
default behavior of this method is to call ExternalContext#getRequest
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1214 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestCharacterEncoding
|
The
default behavior of this method is to call
ExternalContext#getRequestCharacterEncoding on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1215 |
int |
jakarta.faces.context.ExternalContextWrapper.getRequestContentLength
|
The
default behavior of this method is to call
ExternalContext#getRequestContentLength on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1216 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestContentType
|
The
default behavior of this method is to call
ExternalContext#getRequestContentType on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1217 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestContextPath
|
The
default behavior of this method is to call
ExternalContext#getRequestContextPath on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1218 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestCookieMap
|
The
default behavior of this method is to call
ExternalContext#getRequestCookieMap on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1219 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestHeaderMap
|
The
default behavior of this method is to call
ExternalContext#getRequestHeaderMap on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1220 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestHeaderValuesMap
|
The
default behavior of this method is to call
ExternalContext#getRequestHeaderValuesMap on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1221 |
Locale |
jakarta.faces.context.ExternalContextWrapper.getRequestLocale
|
The
default behavior of this method is to call
ExternalContext#getRequestLocale on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1222 |
Iterator |
jakarta.faces.context.ExternalContextWrapper.getRequestLocales
|
The
default behavior of this method is to call
ExternalContext#getRequestLocales on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1223 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestMap
|
The
default behavior of this method is to call
ExternalContext#getRequestMap on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1224 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestParameterMap
|
The
default behavior of this method is to call
ExternalContext#getRequestParameterMap on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1225 |
Iterator |
jakarta.faces.context.ExternalContextWrapper.getRequestParameterNames
|
The
default behavior of this method is to call
ExternalContext#getRequestParameterNames on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1226 |
Map |
jakarta.faces.context.ExternalContextWrapper.getRequestParameterValuesMap
|
The
default behavior of this method is to call
ExternalContext#getRequestParameterValuesMap on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1227 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestPathInfo
|
The
default behavior of this method is to call
ExternalContext#getRequestPathInfo on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1228 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestScheme
|
The
default behavior of this method is to call
ExternalContext#getRequestScheme on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1229 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestServerName
|
The
default behavior of this method is to call
ExternalContext#getRequestServerName on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1230 |
int |
jakarta.faces.context.ExternalContextWrapper.getRequestServerPort
|
The
default behavior of this method is to call
ExternalContext#getRequestServerPort on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1231 |
String |
jakarta.faces.context.ExternalContextWrapper.getRequestServletPath
|
The
default behavior of this method is to call
ExternalContext#getRequestServletPath on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1232 |
URL |
jakarta.faces.context.ExternalContextWrapper.getResource
( String ) |
The
default behavior of this method is to call
ExternalContext#getResource(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1233 |
URL |
jakarta.faces.context.ExternalContextWrapper.getResource
( String )
throws MalformedURLException
|
|
true |
|
true |
| JSF:JAVADOC:1234 |
InputStream |
jakarta.faces.context.ExternalContextWrapper.getResourceAsStream
( String ) |
The
default behavior of this method is to call
ExternalContext#getResourceAsStream(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1235 |
Set |
jakarta.faces.context.ExternalContextWrapper.getResourcePaths
( String ) |
The
default behavior of this method is to call
ExternalContext#getResourcePaths(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1236 |
Object |
jakarta.faces.context.ExternalContextWrapper.getResponse
|
The
default behavior of this method is to call ExternalContext#getResponse
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1237 |
int |
jakarta.faces.context.ExternalContextWrapper.getResponseBufferSize
|
The
default behavior of this method is to call
ExternalContext#getResponseBufferSize() on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1238 |
String |
jakarta.faces.context.ExternalContextWrapper.getResponseCharacterEncoding
|
The
default behavior of this method is to call
ExternalContext#getResponseCharacterEncoding on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1239 |
String |
jakarta.faces.context.ExternalContextWrapper.getResponseContentType
|
The
default behavior of this method is to call
ExternalContext#getResponseContentType on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1240 |
OutputStream |
jakarta.faces.context.ExternalContextWrapper.getResponseOutputStream
|
The
default behavior of this method is to call
ExternalContext#getResponseOutputStream on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1241 |
OutputStream |
jakarta.faces.context.ExternalContextWrapper.getResponseOutputStream
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1242 |
Writer |
jakarta.faces.context.ExternalContextWrapper.getResponseOutputWriter
|
The
default behavior of this method is to call
ExternalContext#getResponseOutputWriter on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1243 |
Writer |
jakarta.faces.context.ExternalContextWrapper.getResponseOutputWriter
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1244 |
Object |
jakarta.faces.context.ExternalContextWrapper.getSession
( boolean ) |
The
default behavior of this method is to call
ExternalContext#getSession(boolean) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1245 |
Map |
jakarta.faces.context.ExternalContextWrapper.getSessionMap
|
The
default behavior of this method is to call ExternalContext#getAuthType
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1246 |
Principal |
jakarta.faces.context.ExternalContextWrapper.getUserPrincipal
|
The
default behavior of this method is to call
ExternalContext#getUserPrincipal on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1247 |
ExternalContext |
jakarta.faces.context.ExternalContextWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1248 |
void |
jakarta.faces.context.ExternalContextWrapper.invalidateSession
|
The
default behavior of this method is to call
ExternalContext#invalidateSession on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1249 |
boolean |
jakarta.faces.context.ExternalContextWrapper.isResponseCommitted
|
The
default behavior of this method is to call
ExternalContext#isResponseCommitted() on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1250 |
boolean |
jakarta.faces.context.ExternalContextWrapper.isUserInRole
( String ) |
The
default behavior of this method is to call
ExternalContext#isUserInRole(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1251 |
void |
jakarta.faces.context.ExternalContextWrapper.log
( String ) |
The
default behavior of this method is to call ExternalContext#log(String)
on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1252 |
void |
jakarta.faces.context.ExternalContextWrapper.log
( String ,
Throwable ) |
The
default behavior of this method is to call ExternalContext#log(String,
Throwable) on the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1253 |
void |
jakarta.faces.context.ExternalContextWrapper.redirect
( String ) |
The
default behavior of this method is to call
ExternalContext#redirect(String) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1254 |
void |
jakarta.faces.context.ExternalContextWrapper.redirect
( String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1255 |
void |
jakarta.faces.context.ExternalContextWrapper.responseFlushBuffer
|
The
default behavior of this method is to call
jakarta.faces.context.ExternalContext#responseFlushBuffer() on the
wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1256 |
void |
jakarta.faces.context.ExternalContextWrapper.responseFlushBuffer
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1257 |
void |
jakarta.faces.context.ExternalContextWrapper.responseReset
|
The
default behavior of this method is to call
ExternalContext#responseReset() on the wrapped ExternalContext object.
|
true |
|
true |
| JSF:JAVADOC:1258 |
void |
jakarta.faces.context.ExternalContextWrapper.responseSendError
( int ,
String ) |
The
default behavior of this method is to call
ExternalContext#responseSendError(int,String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1259 |
void |
jakarta.faces.context.ExternalContextWrapper.responseSendError
( int ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1260 |
void |
jakarta.faces.context.ExternalContextWrapper.setRequest
( Object ) |
The
default behavior of this method is to call
ExternalContext#setRequest(Object) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1261 |
void |
jakarta.faces.context.ExternalContextWrapper.setRequestCharacterEncoding
( String ) |
The
default behavior of this method is to call
ExternalContext#setRequestCharacterEncoding(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1262 |
void |
jakarta.faces.context.ExternalContextWrapper.setRequestCharacterEncoding
( String )
throws UnsupportedEncodingException
|
|
true |
|
true |
| JSF:JAVADOC:1263 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponse
( Object ) |
The
default behavior of this method is to call
ExternalContext#setResponse(Object) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1264 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseBufferSize
( int ) |
The
default behavior of this method is to call
ExternalContext#setResponseBufferSize(int) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1265 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseCharacterEncoding
( String ) |
The
default behavior of this method is to call
ExternalContext#getResponseCharacterEncoding on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1266 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseContentLength
( int ) |
The
default behavior of this method is to call
jakarta.faces.context.ExternalContext#setResponseContentLength(int) on
the wrapped ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1267 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseContentType
( String ) |
The
default behavior of this method is to call
ExternalContext#setResponseContentType(String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1268 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseHeader
( String ,
String ) |
The
default behavior of this method is to call
ExternalContext#setResponseHeader(String,String) on the wrapped
ExternalContext object. |
true |
|
true |
| JSF:JAVADOC:1269 |
void |
jakarta.faces.context.ExternalContextWrapper.setResponseStatus
( int ) |
The
default behavior of this method is to call
ExternalContext#setResponseStatus(int) on the wrapped ExternalContext
object. |
true |
|
true |
| JSF:JAVADOC:1270 |
void |
jakarta.faces.context.FacesContext.addMessage
( String ,
FacesMessage ) |
Append
a jakarta.faces.application.FacesMessage to the set of messages
associated with the specified client identifier, if clientId is not
null. If clientId is null, this jakarta.faces.application.FacesMessage
is assumed to not be associated with any specific component instance.
|
true |
|
true |
| JSF:JAVADOC:1271 |
void |
jakarta.faces.context.FacesContext.addMessage
( String ,
FacesMessage )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1272 |
void |
jakarta.faces.context.FacesContext.addMessage
( String ,
FacesMessage )
throws NullPointerException
|
if
message is null |
true |
|
true |
| JSF:JAVADOC:1273 |
FacesContext |
jakarta.faces.context.FacesContext.FacesContext
|
|
true |
|
true |
| JSF:JAVADOC:1274 |
Application |
jakarta.faces.context.FacesContext.getApplication
|
Return
the Application instance associated with this web application. It is
valid to call this method during application startup or shutdown. If
called during application startup or shutdown, returns the correct
current jakarta.faces.application.Application instance. |
true |
|
true |
| JSF:JAVADOC:1275 |
Application |
jakarta.faces.context.FacesContext.getApplication
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1276 |
Map |
jakarta.faces.context.FacesContext.getAttributes
|
Return
a mutable Map representing the attributes associated wth this
FacesContext instance. This Map is useful to store attributes that you
want to go out of scope when the Faces lifecycle for the current
request ends, which is not always the same as the request ending,
especially in the case of Servlet filters that are invoked after the
Faces lifecycle for this request completes. Accessing this Map does
not cause any events to fire, as is the case with the other maps: for
request, session, and application scope. When #release() is invoked,
the attributes must be cleared. The Map returned by this method is not
associated with the request. If you would like to get or set request
attributes, see ExternalContext#getRequestMap. The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1277 |
Map |
jakarta.faces.context.FacesContext.getAttributes
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1278 |
Iterator |
jakarta.faces.context.FacesContext.getClientIdsWithMessages
|
Return
an Iterator over the client identifiers for which at least one
jakarta.faces.application.FacesMessage has been queued. If there are no
such client identifiers, an empty Iterator is returned. If any
messages have been queued that were not associated with any specific
client identifier, a null value will be included in the iterated
values. The elements in the Iterator must be returned in the order in
which they were added with #addMessage. |
true |
|
true |
| JSF:JAVADOC:1279 |
Iterator |
jakarta.faces.context.FacesContext.getClientIdsWithMessages
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1280 |
FacesContext |
jakarta.faces.context.FacesContext.getCurrentInstance
|
Return
the FacesContext instance for the request that is being processed by
the current thread. If called during application initialization or
shutdown, any method documented as "valid to call this method during
application startup or shutdown" must be supported during application
startup or shutdown time. The result of calling a method during
application startup or shutdown time that does not have this
designation is undefined. |
true |
|
true |
| JSF:JAVADOC:1281 |
PhaseId |
jakarta.faces.context.FacesContext.getCurrentPhaseId
|
Return
the value last set on this FacesContext instance when
#setCurrentPhaseId was called. |
true |
|
true |
| JSF:JAVADOC:1282 |
PhaseId |
jakarta.faces.context.FacesContext.getCurrentPhaseId
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1283 |
ELContext |
jakarta.faces.context.FacesContext.getELContext
|
Return
the ELContext instance for this FacesContext instance. This ELContext
instance has the same lifetime and scope as the FacesContext instance
with which it is associated, and may be created lazily the first time
this method is called for a given FacesContext instance. Upon creation
of the ELContext instance, the implementation must take the following
action: Call the ELContext#putContext method on the instance, passing
in FacesContext.class and the this reference for the FacesContext
instance itself. If the Collection returned by
jakarta.faces.application.Application#getELContextListeners is
non-empty, create an instance of jakarta.el.ELContextEvent and pass it
to each jakarta.el.ELContextListener instance in the Collection by
calling the jakarta.el.ELContextListener#contextCreated method. |
true |
|
true |
| JSF:JAVADOC:1284 |
ELContext |
jakarta.faces.context.FacesContext.getELContext
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1285 |
ExceptionHandler |
jakarta.faces.context.FacesContext.getExceptionHandler
|
Return
the ExceptionHandler for this request. |
true |
|
true |
| JSF:JAVADOC:1286 |
ExternalContext |
jakarta.faces.context.FacesContext.getExternalContext
|
Return
the ExternalContext instance for this FacesContext instance. It is
valid to call this method during application startup or shutdown. If
called during application startup or shutdown, this method returns an
ExternalContext instance with the special behaviors indicated in the
javadoc for that class. Methods document as being valid to call during
application startup or shutdown must be supported. |
true |
|
true |
| JSF:JAVADOC:1287 |
ExternalContext |
jakarta.faces.context.FacesContext.getExternalContext
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1288 |
Severity |
jakarta.faces.context.FacesContext.getMaximumSeverity
|
Return
the maximum severity level recorded on any
jakarta.faces.application.FacesMessages that has been queued, whether or
not they are associated with any specific UIComponent. If no such
messages have been queued, return null. |
true |
|
true |
| JSF:JAVADOC:1289 |
Severity |
jakarta.faces.context.FacesContext.getMaximumSeverity
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1290 |
List |
jakarta.faces.context.FacesContext.getMessageList
|
Like
#getMessages, but returns a List, enabling use from EL expressions.
The default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1291 |
List |
jakarta.faces.context.FacesContext.getMessageList
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1292 |
List |
jakarta.faces.context.FacesContext.getMessageList
( String ) |
Like
#getMessages(java.lang.String), but returns a List of messages for the
component with client id matching argument clientId. The default
implementation throws UnsupportedOperationException and is provided
for the sole purpose of not breaking existing applications that extend
this class. |
true |
|
true |
| JSF:JAVADOC:1293 |
List |
jakarta.faces.context.FacesContext.getMessageList
( String )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1294 |
Iterator |
jakarta.faces.context.FacesContext.getMessages
|
Return
an Iterator over the jakarta.faces.application.FacesMessages that have
been queued, whether or not they are associated with any specific
client identifier. If no such messages have been queued, return an
empty Iterator. The elements of the Iterator must be returned in the
order in which they were added with calls to #addMessage. |
true |
|
true |
| JSF:JAVADOC:1295 |
Iterator |
jakarta.faces.context.FacesContext.getMessages
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1296 |
Iterator |
jakarta.faces.context.FacesContext.getMessages
( String ) |
Return
an Iterator over the jakarta.faces.application.FacesMessages that have
been queued that are associated with the specified client identifier
(if clientId is not null), or over the
jakarta.faces.application.FacesMessages that have been queued that are
not associated with any specific client identifier (if clientId is
null). If no such messages have been queued, return an empty Iterator.
The elements of the Iterator must be returned in the order in which
they were added with calls to #addMessage. |
true |
|
true |
| JSF:JAVADOC:1297 |
Iterator |
jakarta.faces.context.FacesContext.getMessages
( String )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1298 |
PartialViewContext |
jakarta.faces.context.FacesContext.getPartialViewContext
|
Return
the PartialViewContext for this request. The PartialViewContext is
used to control the processing of specified components during the
execute portion of the request processing lifecycle (known as partial
processing) and the rendering of specified components (known as
partial rendering). This method must return a new PartialViewContext
if one does not already exist. |
true |
|
true |
| JSF:JAVADOC:1299 |
PartialViewContext |
jakarta.faces.context.FacesContext.getPartialViewContext
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1300 |
RenderKit |
jakarta.faces.context.FacesContext.getRenderKit
|
Return
the RenderKit instance for the render kit identifier specified on our
UIViewRoot, if there is one. If there is no current UIViewRoot, if the
UIViewRoot does not have a specified renderKitId, or if there is no
RenderKit for the specified identifier, return null instead. |
true |
|
true |
| JSF:JAVADOC:1301 |
RenderKit |
jakarta.faces.context.FacesContext.getRenderKit
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1302 |
boolean |
jakarta.faces.context.FacesContext.getRenderResponse
|
Return
true if the renderResponse() method has been called for the current
request. |
true |
|
true |
| JSF:JAVADOC:1303 |
boolean |
jakarta.faces.context.FacesContext.getRenderResponse
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1304 |
boolean |
jakarta.faces.context.FacesContext.getResponseComplete
|
Return
true if the responseComplete() method has been called for the current
request. |
true |
|
true |
| JSF:JAVADOC:1305 |
boolean |
jakarta.faces.context.FacesContext.getResponseComplete
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1306 |
ResponseStream |
jakarta.faces.context.FacesContext.getResponseStream
|
Return
the ResponseStream to which components should direct their binary
output. Within a given response, components can use either the
ResponseStream or the ResponseWriter, but not both. |
true |
|
true |
| JSF:JAVADOC:1307 |
ResponseStream |
jakarta.faces.context.FacesContext.getResponseStream
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1308 |
ResponseWriter |
jakarta.faces.context.FacesContext.getResponseWriter
|
Return
the ResponseWriter to which components should direct their
character-based output. Within a given response, components can use
either the ResponseStream or the ResponseWriter, but not both. |
true |
|
true |
| JSF:JAVADOC:1309 |
ResponseWriter |
jakarta.faces.context.FacesContext.getResponseWriter
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1310 |
UIViewRoot |
jakarta.faces.context.FacesContext.getViewRoot
|
Return
the root component that is associated with the this request. It is
valid to call this method during application startup or shutdown. If
called during application startup or shutdown, this method returns a
new UIViewRoot with its locale set to Locale.getDefault(). |
true |
|
true |
| JSF:JAVADOC:1311 |
UIViewRoot |
jakarta.faces.context.FacesContext.getViewRoot
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1312 |
boolean |
jakarta.faces.context.FacesContext.isPostback
|
This
utility method simply returns the result of
jakarta.faces.render.ResponseStateManager#isPostback(FacesContext). The
default implementation throws UnsupportedOperationException and is
provided for the sole purpose of not breaking existing applications
that extend this class. |
true |
|
true |
| JSF:JAVADOC:1313 |
boolean |
jakarta.faces.context.FacesContext.isPostback
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1314 |
boolean |
jakarta.faces.context.FacesContext.isProcessingEvents
|
Returns
a flag indicating whether or not the runtime should publish events
when asked to do so. |
true |
|
true |
| JSF:JAVADOC:1315 |
boolean |
jakarta.faces.context.FacesContext.isProjectStage
( ProjectStage ) |
Return
true if the current ProjectStage as returned by the Application
instance is equal to stage, otherwise return false |
true |
|
true |
| JSF:JAVADOC:1316 |
boolean |
jakarta.faces.context.FacesContext.isProjectStage
( ProjectStage )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1317 |
boolean |
jakarta.faces.context.FacesContext.isProjectStage
( ProjectStage )
throws NullPointerException
|
if stage
is null |
true |
|
true |
| JSF:JAVADOC:1318 |
boolean |
jakarta.faces.context.FacesContext.isValidationFailed
|
Return
true if the validationFailed() method has been called for the current
request. |
true |
|
true |
| JSF:JAVADOC:1319 |
boolean |
jakarta.faces.context.FacesContext.isValidationFailed
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1320 |
void |
jakarta.faces.context.FacesContext.release
|
Release
any resources associated with this FacesContext instance. Faces
implementations may choose to pool instances in the associated
FacesContextFactory to avoid repeated object creation and garbage
collection. After release() is called on a FacesContext instance
(until the FacesContext instance has been recycled by the
implementation for re-use), calling any other methods will cause an
IllegalStateException to be thrown. If a call was made to
#getAttributes during the processing for this request, the
implementation must call clear() on the Map returned from
getAttributes(), and then de-allocate the data-structure behind that
Map. The implementation must call #setCurrentInstance passing null to
remove the association between this thread and this dead FacesContext
instance. |
true |
|
true |
| JSF:JAVADOC:1321 |
void |
jakarta.faces.context.FacesContext.release
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1322 |
void |
jakarta.faces.context.FacesContext.renderResponse
|
Signal
the Jakarta Server faces implementation that, as soon as the current phase
of the request processing lifecycle has been completed, control should
be passed to the Render Response phase, bypassing any phases that have
not been executed yet. |
true |
|
true |
| JSF:JAVADOC:1323 |
void |
jakarta.faces.context.FacesContext.renderResponse
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1324 |
void |
jakarta.faces.context.FacesContext.responseComplete
|
Signal
the Jakarta Server Faces implementation that the HTTP response for this
request has already been generated (such as an HTTP redirect), and
that the request processing lifecycle should be terminated as soon as
the current phase is completed. |
true |
|
true |
| JSF:JAVADOC:1325 |
void |
jakarta.faces.context.FacesContext.responseComplete
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1326 |
void |
jakarta.faces.context.FacesContext.setCurrentPhaseId
( PhaseId ) |
The
implementation must call this method at the earliest possble point in
time after entering into a new phase in the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1327 |
void |
jakarta.faces.context.FacesContext.setCurrentPhaseId
( PhaseId )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1328 |
void |
jakarta.faces.context.FacesContext.setExceptionHandler
( ExceptionHandler ) |
Set the
ExceptionHandler for this request. |
true |
|
true |
| JSF:JAVADOC:1329 |
void |
jakarta.faces.context.FacesContext.setProcessingEvents
( boolean ) |
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. |
true |
|
true |
| JSF:JAVADOC:1330 |
void |
jakarta.faces.context.FacesContext.setResponseStream
( ResponseStream ) |
Set the
ResponseStream to which components should direct their binary output.
|
true |
|
true |
| JSF:JAVADOC:1331 |
void |
jakarta.faces.context.FacesContext.setResponseStream
( ResponseStream )
throws NullPointerException
|
if
responseStream is null |
true |
|
true |
| JSF:JAVADOC:1332 |
void |
jakarta.faces.context.FacesContext.setResponseStream
( ResponseStream )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1333 |
void |
jakarta.faces.context.FacesContext.setResponseWriter
( ResponseWriter ) |
Set the
ResponseWriter to which components should direct their character-based
output. |
true |
|
true |
| JSF:JAVADOC:1334 |
void |
jakarta.faces.context.FacesContext.setResponseWriter
( ResponseWriter )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1335 |
void |
jakarta.faces.context.FacesContext.setResponseWriter
( ResponseWriter )
throws NullPointerException
|
if
responseWriter is null |
true |
|
true |
| JSF:JAVADOC:1336 |
void |
jakarta.faces.context.FacesContext.setViewRoot
( UIViewRoot ) |
Set the
root component that is associated with this request. This method can
only be called by the application handler (or a class that the handler
calls), and only during the Invoke Application phase of the request
processing lifecycle. If the current UIViewRoot is non-null, and
calling equals() on the argument root, passing the current UIViewRoot
returns false, the clear method must be called on the Map returned
from UIViewRoot#getViewMap. |
true |
|
true |
| JSF:JAVADOC:1337 |
void |
jakarta.faces.context.FacesContext.setViewRoot
( UIViewRoot )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1338 |
void |
jakarta.faces.context.FacesContext.setViewRoot
( UIViewRoot )
throws NullPointerException
|
if root
is null |
true |
|
true |
| JSF:JAVADOC:1339 |
void |
jakarta.faces.context.FacesContext.validationFailed
|
Sets a
flag which indicates that a conversion or validation error occurred
while processing the inputs. Inputs consist of either page parameters
or form bindings. This flag can be read using #isValidationFailed. |
true |
|
true |
| JSF:JAVADOC:1340 |
void |
jakarta.faces.context.FacesContext.validationFailed
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1341 |
FacesContextFactory |
jakarta.faces.context.FacesContextFactory.FacesContextFactory
|
|
true |
|
true |
| JSF:JAVADOC:1342 |
FacesContext |
jakarta.faces.context.FacesContextFactory.getFacesContext
( Object ,
Object ,
Object ,
Lifecycle ) |
Create
(if needed) and return a FacesContext instance that is initialized for
the processing of the specified request and response objects,
utilizing the specified Lifecycle instance, for this web application.
The implementation of this method must ensure that calls to the
getCurrentInstance() method of FacesContext, from the same thread that
called this method, will return the same FacesContext instance until
the release() method is called on that instance. The implementation
must call ExternalContextFactory#getExternalContext to produce the
ExternalContext for the FacesContext instance. The default
implementation must call ExceptionHandlerFactory#getExceptionHandler
and make it so the return from that method is what gets returned from
a call to FacesContext#getExceptionHandler on the returned
FacesContext instance. |
true |
|
true |
| JSF:JAVADOC:1343 |
FacesContext |
jakarta.faces.context.FacesContextFactory.getFacesContext
( Object ,
Object ,
Object ,
Lifecycle )
throws FacesException
|
if a
FacesContext cannot be constructed for the specified parameters |
true |
|
true |
| JSF:JAVADOC:1344 |
FacesContext |
jakarta.faces.context.FacesContextFactory.getFacesContext
( Object ,
Object ,
Object ,
Lifecycle )
throws NullPointerException
|
if any
of the parameters are null |
true |
|
true |
| JSF:JAVADOC:1345 |
FacesContextFactory |
jakarta.faces.context.FacesContextFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:1346 |
void |
jakarta.faces.context.FacesContextWrapper.addMessage
( String ,
FacesMessage ) |
The
default behavior of this method is to call
FacesContext#addMessage(String, FacesMessage) on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1347 |
FacesContextWrapper |
jakarta.faces.context.FacesContextWrapper.FacesContextWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1348 |
Application |
jakarta.faces.context.FacesContextWrapper.getApplication
|
The
default behavior of this method is to call
FacesContext#getApplication() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1349 |
Map |
jakarta.faces.context.FacesContextWrapper.getAttributes
|
The
default behavior of this method is to call
FacesContext#getAttributes() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1350 |
Iterator |
jakarta.faces.context.FacesContextWrapper.getClientIdsWithMessages
|
The
default behavior of this method is to call
jakarta.faces.context.FacesContext#getClientIdsWithMessages() on the
wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1351 |
PhaseId |
jakarta.faces.context.FacesContextWrapper.getCurrentPhaseId
|
The
default behavior of this method is to call
FacesContext#getCurrentPhaseId() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1352 |
ELContext |
jakarta.faces.context.FacesContextWrapper.getELContext
|
The
default behavior of this method is to call FacesContext#getELContext()
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1353 |
ExceptionHandler |
jakarta.faces.context.FacesContextWrapper.getExceptionHandler
|
The
default behavior of this method is to call
FacesContext#getExceptionHandler() on the wrapped FacesContext object.
|
true |
|
true |
| JSF:JAVADOC:1354 |
ExternalContext |
jakarta.faces.context.FacesContextWrapper.getExternalContext
|
The
default behavior of this method is to call
FacesContext#getExternalContext() on the wrapped FacesContext object.
|
true |
|
true |
| JSF:JAVADOC:1355 |
Severity |
jakarta.faces.context.FacesContextWrapper.getMaximumSeverity
|
The
default behavior of this method is to call
FacesContext#getMaximumSeverity() on the wrapped FacesContext object.
|
true |
|
true |
| JSF:JAVADOC:1356 |
List |
jakarta.faces.context.FacesContextWrapper.getMessageList
|
The
default behavior of this method is to call
FacesContext#getMessageList() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1357 |
List |
jakarta.faces.context.FacesContextWrapper.getMessageList
( String ) |
The
default behavior of this method is to call
FacesContext#getMessageList(String) on the wrapped FacesContext
object. |
true |
|
true |
| JSF:JAVADOC:1358 |
Iterator |
jakarta.faces.context.FacesContextWrapper.getMessages
|
The
default behavior of this method is to call FacesContext#getMessages()
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1359 |
Iterator |
jakarta.faces.context.FacesContextWrapper.getMessages
( String ) |
The
default behavior of this method is to call
FacesContext#getMessages(String) on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1360 |
PartialViewContext |
jakarta.faces.context.FacesContextWrapper.getPartialViewContext
|
The
default behavior of this method is to call
FacesContext#getPartialViewContext() ()} on the wrapped FacesContext
object. |
true |
|
true |
| JSF:JAVADOC:1361 |
RenderKit |
jakarta.faces.context.FacesContextWrapper.getRenderKit
|
The
default behavior of this method is to call FacesContext#getRenderKit()
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1362 |
boolean |
jakarta.faces.context.FacesContextWrapper.getRenderResponse
|
The
default behavior of this method is to call
FacesContext#getRenderResponse() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1363 |
boolean |
jakarta.faces.context.FacesContextWrapper.getResponseComplete
|
The
default behavior of this method is to call
FacesContext#getResponseComplete() on the wrapped FacesContext object.
|
true |
|
true |
| JSF:JAVADOC:1364 |
ResponseStream |
jakarta.faces.context.FacesContextWrapper.getResponseStream
|
The
default behavior of this method is to call
FacesContext#getResponseStream() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1365 |
ResponseWriter |
jakarta.faces.context.FacesContextWrapper.getResponseWriter
|
The
default behavior of this method is to call
FacesContext#getResponseWriter() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1366 |
UIViewRoot |
jakarta.faces.context.FacesContextWrapper.getViewRoot
|
The
default behavior of this method is to call FacesContext#getViewRoot()
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1367 |
FacesContext |
jakarta.faces.context.FacesContextWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1368 |
boolean |
jakarta.faces.context.FacesContextWrapper.isPostback
|
The
default behavior of this method is to call FacesContext#isPostback()
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1369 |
boolean |
jakarta.faces.context.FacesContextWrapper.isProcessingEvents
|
The
default behavior of this method is to call
jakarta.faces.context.FacesContext#isProcessingEvents() on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1370 |
boolean |
jakarta.faces.context.FacesContextWrapper.isProjectStage
( ProjectStage ) |
The
default behavior of this method is to call
jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage)
on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1371 |
boolean |
jakarta.faces.context.FacesContextWrapper.isValidationFailed
|
The
default behavior of this method is to call
jakarta.faces.context.FacesContext#isValidationFailed on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1372 |
void |
jakarta.faces.context.FacesContextWrapper.release
|
The
default behavior of this method is to call FacesContext#release() on
the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1373 |
void |
jakarta.faces.context.FacesContextWrapper.renderResponse
|
The
default behavior of this method is to call
FacesContext#renderResponse() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1374 |
void |
jakarta.faces.context.FacesContextWrapper.responseComplete
|
The
default behavior of this method is to call
FacesContext#responseComplete() on the wrapped FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1375 |
void |
jakarta.faces.context.FacesContextWrapper.setCurrentPhaseId
( PhaseId ) |
The
default behavior of this method is to call
FacesContext#setCurrentPhaseId(PhaseId) on the wrapped FacesContext
object. |
true |
|
true |
| JSF:JAVADOC:1376 |
void |
jakarta.faces.context.FacesContextWrapper.setExceptionHandler
( ExceptionHandler ) |
The
default behavior of this method is to call
FacesContext#setExceptionHandler(ExceptionHandler) on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1377 |
void |
jakarta.faces.context.FacesContextWrapper.setProcessingEvents
( boolean ) |
The
default behavior of this method is to call
FacesContext#setProcessingEvents(boolean) on the wrapped FacesContext
object. |
true |
|
true |
| JSF:JAVADOC:1378 |
void |
jakarta.faces.context.FacesContextWrapper.setResponseStream
( ResponseStream ) |
The
default behavior of this method is to call
FacesContext#setResponseStream(ResponseStream) on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1379 |
void |
jakarta.faces.context.FacesContextWrapper.setResponseWriter
( ResponseWriter ) |
The
default behavior of this method is to call
FacesContext#setResponseWriter(ResponseWriter) on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1380 |
void |
jakarta.faces.context.FacesContextWrapper.setViewRoot
( UIViewRoot ) |
The
default behavior of this method is to call
FacesContext#setViewRoot(UIViewRoot) on the wrapped FacesContext
object. |
true |
|
true |
| JSF:JAVADOC:1381 |
void |
jakarta.faces.context.FacesContextWrapper.validationFailed
|
The
default behavior of this method is to call
jakarta.faces.context.FacesContext#validationFailed() on the wrapped
FacesContext object. |
true |
|
true |
| JSF:JAVADOC:1382 |
void |
jakarta.faces.context.Flash.doPostPhaseActions
( FacesContext ) |
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. |
true |
|
true |
| JSF:JAVADOC:1383 |
void |
jakarta.faces.context.Flash.doPrePhaseActions
( FacesContext ) |
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. |
true |
|
true |
| JSF:JAVADOC:1384 |
Flash |
jakarta.faces.context.Flash.Flash
|
|
true |
|
true |
| JSF:JAVADOC:1385 |
boolean |
jakarta.faces.context.Flash.isKeepMessages
|
Return
the value of this JavaBeans property for the flash for this session.
This value determines whether or not any
jakarta.faces.application.FacesMessage instances queued in the current
jakarta.faces.context.FacesContext must be preserved so they are
accessible on the next traversal of the lifecycle on this session,
regardless of the request being a redirect after post, or a normal
postback. Map accesses for the special key “keepMessages”
must return the value of this JavaBeans property. EL Usage Example
First page Next page Any messages present on the first page must be
displayed on this page. |
true |
|
true |
| JSF:JAVADOC:1386 |
boolean |
jakarta.faces.context.Flash.isRedirect
|
Return
the value of this property for the flash for this session. This must
be false unless: #setRedirect was called for the current lifecycle
traversal with true as the argument. The current lifecycle traversal
for this session is in the “execute” phase and the
previous traversal had #setRedirect called with true as the argument.
|
true |
|
true |
| JSF:JAVADOC:1387 |
void |
jakarta.faces.context.Flash.keep
( String ) |
Causes
a value stored with a previous call to #putNow, its EL 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. |
true |
|
true |
| JSF:JAVADOC:1388 |
void |
jakarta.faces.context.Flash.putNow
( String ,
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. This is simply an alias
for putting a value in the request map. EL Usage Example Value of
\#{flash.now.bar}, should be barValue. |
true |
|
true |
| JSF:JAVADOC:1389 |
void |
jakarta.faces.context.Flash.setKeepMessages
( boolean ) |
Setter
for keepMessages JavaBeans property. See #isKeepMessages. |
true |
|
true |
| JSF:JAVADOC:1390 |
void |
jakarta.faces.context.Flash.setRedirect
( boolean ) |
Setting
this property to true indicates that the next request on this session
will be a redirect. Recall that on a redirect, the server sends a
special response to the client instructing it to issue a new request
to a specific URI. The implementation must insure that reading the
value of this property on that request will return true. EL Usage
Example |
true |
|
true |
| JSF:JAVADOC:1391 |
void |
jakarta.faces.context.PartialResponseWriter.delete
( String ) |
Write a
delete operation. |
true |
|
true |
| JSF:JAVADOC:1392 |
void |
jakarta.faces.context.PartialResponseWriter.delete
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1393 |
void |
jakarta.faces.context.PartialResponseWriter.endDocument
|
Write
the end of a partial response. |
true |
|
true |
| JSF:JAVADOC:1394 |
void |
jakarta.faces.context.PartialResponseWriter.endDocument
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1395 |
void |
jakarta.faces.context.PartialResponseWriter.endError
|
Write
the end of an error. |
true |
|
true |
| JSF:JAVADOC:1396 |
void |
jakarta.faces.context.PartialResponseWriter.endError
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1397 |
void |
jakarta.faces.context.PartialResponseWriter.endEval
|
Write
the end of an eval operation. |
true |
|
true |
| JSF:JAVADOC:1398 |
void |
jakarta.faces.context.PartialResponseWriter.endEval
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1399 |
void |
jakarta.faces.context.PartialResponseWriter.endExtension
|
Write
the end of an extension operation. |
true |
|
true |
| JSF:JAVADOC:1400 |
void |
jakarta.faces.context.PartialResponseWriter.endExtension
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1401 |
void |
jakarta.faces.context.PartialResponseWriter.endInsert
|
Write
the end of an insert operation. |
true |
|
true |
| JSF:JAVADOC:1402 |
void |
jakarta.faces.context.PartialResponseWriter.endInsert
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1403 |
void |
jakarta.faces.context.PartialResponseWriter.endUpdate
|
Write
the end of an update operation. |
true |
|
true |
| JSF:JAVADOC:1404 |
void |
jakarta.faces.context.PartialResponseWriter.endUpdate
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1405 |
ResponseWriter |
jakarta.faces.context.PartialResponseWriter.getWrapped
|
Return
the wrapped ResponseWriter instance. |
true |
|
true |
| JSF:JAVADOC:1406 |
PartialResponseWriter |
jakarta.faces.context.PartialResponseWriter.PartialResponseWriter
( ResponseWriter ) |
Create
a PartialResponseWriter. |
true |
|
true |
| JSF:JAVADOC:1407 |
void |
jakarta.faces.context.PartialResponseWriter.redirect
( String ) |
Write a
redirect operation. |
true |
|
true |
| JSF:JAVADOC:1408 |
void |
jakarta.faces.context.PartialResponseWriter.redirect
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1409 |
void |
jakarta.faces.context.PartialResponseWriter.startDocument
|
Write
the start of a partial response. |
true |
|
true |
| JSF:JAVADOC:1410 |
void |
jakarta.faces.context.PartialResponseWriter.startDocument
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1411 |
void |
jakarta.faces.context.PartialResponseWriter.startError
( String ) |
Write
the start of an error. |
true |
|
true |
| JSF:JAVADOC:1412 |
void |
jakarta.faces.context.PartialResponseWriter.startError
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1413 |
void |
jakarta.faces.context.PartialResponseWriter.startEval
|
Write
the start of an eval operation. |
true |
|
true |
| JSF:JAVADOC:1414 |
void |
jakarta.faces.context.PartialResponseWriter.startEval
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1415 |
void |
jakarta.faces.context.PartialResponseWriter.startExtension
( Map ) |
Write
the start of an extension operation. |
true |
|
true |
| JSF:JAVADOC:1416 |
void |
jakarta.faces.context.PartialResponseWriter.startExtension
( Map )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1417 |
void |
jakarta.faces.context.PartialResponseWriter.startInsertAfter
( String ) |
Write
the start of an insert operation where the contents will be inserted
after the specified target node. |
true |
|
true |
| JSF:JAVADOC:1418 |
void |
jakarta.faces.context.PartialResponseWriter.startInsertAfter
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1419 |
void |
jakarta.faces.context.PartialResponseWriter.startInsertBefore
( String ) |
Write
the start of an insert operation where the contents will be inserted
before the specified target node. |
true |
|
true |
| JSF:JAVADOC:1420 |
void |
jakarta.faces.context.PartialResponseWriter.startInsertBefore
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1421 |
void |
jakarta.faces.context.PartialResponseWriter.startUpdate
( String ) |
Write
the start of an update operation. |
true |
|
true |
| JSF:JAVADOC:1422 |
void |
jakarta.faces.context.PartialResponseWriter.startUpdate
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1423 |
void |
jakarta.faces.context.PartialResponseWriter.updateAttributes
( String ,
Map ) |
Write
an attribute update operation. |
true |
|
true |
| JSF:JAVADOC:1424 |
void |
jakarta.faces.context.PartialResponseWriter.updateAttributes
( String ,
Map )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1425 |
Collection |
jakarta.faces.context.PartialViewContext.getExecuteIds
|
Return
a Collection of client identifiers from the current request with the
request parameter name #PARTIAL_EXECUTE_PARAM_NAME. If there is no
such request parameter, return an empty Collection. These client
identifiers are used to identify components that will be processed
during the execute phase of the request processing lifecycle. The
returned Collection is mutable. |
true |
|
true |
| JSF:JAVADOC:1426 |
Collection |
jakarta.faces.context.PartialViewContext.getExecuteIds
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1427 |
PartialResponseWriter |
jakarta.faces.context.PartialViewContext.getPartialResponseWriter
|
Return
the ResponseWriter to which components should direct their output for
partial view rendering. Within a given response, components can use
either the ResponseStream or the ResponseWriter, but not both. |
true |
|
true |
| JSF:JAVADOC:1428 |
PartialResponseWriter |
jakarta.faces.context.PartialViewContext.getPartialResponseWriter
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1429 |
Collection |
jakarta.faces.context.PartialViewContext.getRenderIds
|
Return
a Collection of client identifiers from the current request with the
request parameter name #PARTIAL_RENDER_PARAM_NAME. If there is no such
request parameter, return an empty Collection. These client
identifiers are used to identify components that will be processed
during the render phase of the request processing lifecycle. The
returned Collection is mutable. |
true |
|
true |
| JSF:JAVADOC:1430 |
Collection |
jakarta.faces.context.PartialViewContext.getRenderIds
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1431 |
boolean |
jakarta.faces.context.PartialViewContext.isAjaxRequest
|
Return
true if the request header Faces-Request is present with the value
partial/ajax. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1432 |
boolean |
jakarta.faces.context.PartialViewContext.isAjaxRequest
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1433 |
boolean |
jakarta.faces.context.PartialViewContext.isExecuteAll
|
Return
true if #isAjaxRequest returns true and #PARTIAL_EXECUTE_PARAM_NAME is
present in the current request with the value
#ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1434 |
boolean |
jakarta.faces.context.PartialViewContext.isExecuteAll
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1435 |
boolean |
jakarta.faces.context.PartialViewContext.isPartialRequest
|
Return
true #isAjaxRequest returns true or if the request header
Faces-Request is present with the value partial/process. Otherwise,
return false. |
true |
|
true |
| JSF:JAVADOC:1436 |
boolean |
jakarta.faces.context.PartialViewContext.isPartialRequest
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1437 |
boolean |
jakarta.faces.context.PartialViewContext.isRenderAll
|
Return
true if #isAjaxRequest returns true and #PARTIAL_RENDER_PARAM_NAME is
present in the current request with the value
#ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1438 |
boolean |
jakarta.faces.context.PartialViewContext.isRenderAll
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1439 |
PartialViewContext |
jakarta.faces.context.PartialViewContext.PartialViewContext
|
|
true |
|
true |
| JSF:JAVADOC:1440 |
void |
jakarta.faces.context.PartialViewContext.processPartial
( PhaseId ) |
Perform
lifecycle processing on components during the indicated phaseId. Only
those components with identifiers existing in the Collection returned
from #getExecuteIds and #getRenderIds will be processed. |
true |
|
true |
| JSF:JAVADOC:1441 |
void |
jakarta.faces.context.PartialViewContext.release
|
Release
any resources associated with this PartialViewContext instance. |
true |
|
true |
| JSF:JAVADOC:1442 |
void |
jakarta.faces.context.PartialViewContext.release
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1443 |
void |
jakarta.faces.context.PartialViewContext.setPartialRequest
( boolean ) |
Dynamically indicate that this is a partial request. |
true |
|
true |
| JSF:JAVADOC:1444 |
void |
jakarta.faces.context.PartialViewContext.setPartialRequest
( boolean )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1445 |
void |
jakarta.faces.context.PartialViewContext.setRenderAll
( boolean ) |
Indicate the entire view must be rendered if renderAll is true. |
true |
|
true |
| JSF:JAVADOC:1446 |
void |
jakarta.faces.context.PartialViewContext.setRenderAll
( boolean )
throws IllegalStateException
|
if this
method is called after this instance has been released |
true |
|
true |
| JSF:JAVADOC:1447 |
PartialViewContext |
jakarta.faces.context.PartialViewContextFactory.getPartialViewContext
( FacesContext ) |
Create
(if needed) and return a PartialViewContext instance that is
initialized using the current FacesContext instance. |
true |
|
true |
| JSF:JAVADOC:1448 |
PartialViewContextFactory |
jakarta.faces.context.PartialViewContextFactory.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1449 |
PartialViewContextFactory |
jakarta.faces.context.PartialViewContextFactory.PartialViewContextFactory
|
|
true |
|
true |
| JSF:JAVADOC:1450 |
Collection |
jakarta.faces.context.PartialViewContextWrapper.getExecuteIds
|
The
default behavior of this method is to call
PartialViewContext#getExecuteIds() on the wrapped PartialViewContext
object. |
true |
|
true |
| JSF:JAVADOC:1451 |
PartialResponseWriter |
jakarta.faces.context.PartialViewContextWrapper.getPartialResponseWriter
|
The
default behavior of this method is to call
PartialViewContext#getPartialResponseWriter() on the wrapped
PartialViewContext object. |
true |
|
true |
| JSF:JAVADOC:1452 |
Collection |
jakarta.faces.context.PartialViewContextWrapper.getRenderIds
|
The
default behavior of this method is to call
PartialViewContext#getRenderIds() on the wrapped PartialViewContext
object. |
true |
|
true |
| JSF:JAVADOC:1453 |
PartialViewContext |
jakarta.faces.context.PartialViewContextWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:1454 |
boolean |
jakarta.faces.context.PartialViewContextWrapper.isAjaxRequest
|
The
default behavior of this method is to call
PartialViewContext#isAjaxRequest() on the wrapped PartialViewContext
object. |
true |
|
true |
| JSF:JAVADOC:1455 |
boolean |
jakarta.faces.context.PartialViewContextWrapper.isExecuteAll
|
The
default behavior of this method is to call
PartialViewContext#isExecuteAll() on the wrapped PartialViewContext
object. |
true |
|
true |
| JSF:JAVADOC:1456 |
boolean |
jakarta.faces.context.PartialViewContextWrapper.isPartialRequest
|
The
default behavior of this method is to call
PartialViewContext#isPartialRequest() on the wrapped
PartialViewContext object. |
true |
|
true |
| JSF:JAVADOC:1457 |
boolean |
jakarta.faces.context.PartialViewContextWrapper.isRenderAll
|
The
default behavior of this method is to call
PartialViewContext#isRenderAll() on the wrapped PartialViewContext
object. |
true |
|
true |
| JSF:JAVADOC:1458 |
PartialViewContextWrapper |
jakarta.faces.context.PartialViewContextWrapper.PartialViewContextWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1459 |
void |
jakarta.faces.context.PartialViewContextWrapper.processPartial
( PhaseId ) |
The
default behavior of this method is to call
PartialViewContext#processPartial(PhaseId) on the wrapped
PartialViewContext object. |
true |
|
true |
| JSF:JAVADOC:1460 |
void |
jakarta.faces.context.PartialViewContextWrapper.release
|
The
default behavior of this method is to call
PartialViewContext#release() on the wrapped PartialViewContext object.
|
true |
|
true |
| JSF:JAVADOC:1461 |
void |
jakarta.faces.context.PartialViewContextWrapper.setRenderAll
( boolean ) |
The
default behavior of this method is to call
PartialViewContext#setRenderAll(boolean) on the wrapped
PartialViewContext object. |
true |
|
true |
| JSF:JAVADOC:1462 |
ResponseStream |
jakarta.faces.context.ResponseStream.ResponseStream
|
|
true |
|
true |
| JSF:JAVADOC:1463 |
ResponseWriter |
jakarta.faces.context.ResponseWriter.cloneWithWriter
( Writer ) |
Create
and return a new instance of this ResponseWriter, using the specified
Writer as the output destination. |
true |
|
true |
| JSF:JAVADOC:1464 |
void |
jakarta.faces.context.ResponseWriter.endCDATA
|
Close
an XML CDATA block. The default implementation of this method takes no
action when invoked. |
true |
|
true |
| JSF:JAVADOC:1465 |
void |
jakarta.faces.context.ResponseWriter.endCDATA
throws IOException
|
if
input/output error occures |
true |
|
true |
| JSF:JAVADOC:1466 |
void |
jakarta.faces.context.ResponseWriter.endDocument
|
Write
whatever text should end a response. If there is an open element that
has been created by a call to startElement(), that element will be
closed first. |
true |
|
true |
| JSF:JAVADOC:1467 |
void |
jakarta.faces.context.ResponseWriter.endDocument
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1468 |
void |
jakarta.faces.context.ResponseWriter.endElement
( String ) |
Write
the end of an element, after closing any open element created by a
call to startElement(). Elements must be closed in the inverse order
from which they were opened; it is an error to do otherwise. |
true |
|
true |
| JSF:JAVADOC:1469 |
void |
jakarta.faces.context.ResponseWriter.endElement
( String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1470 |
void |
jakarta.faces.context.ResponseWriter.endElement
( String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1471 |
void |
jakarta.faces.context.ResponseWriter.flush
|
Flush
any ouput buffered by the output method to the underlying Writer or
OutputStream. This method will not flush the underlying Writer or
OutputStream; it simply clears any values buffered by this
ResponseWriter. |
true |
|
true |
| JSF:JAVADOC:1472 |
void |
jakarta.faces.context.ResponseWriter.flush
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1473 |
String |
jakarta.faces.context.ResponseWriter.getCharacterEncoding
|
Return
the character encoding (such as "ISO-8859-1") for this ResponseWriter.
Please see the IANA for a list of character encodings. |
true |
|
true |
| JSF:JAVADOC:1474 |
String |
jakarta.faces.context.ResponseWriter.getContentType
|
Return
the content type (such as "text/html") for this ResponseWriter. Note:
this must not include the "charset=" suffix. |
true |
|
true |
| JSF:JAVADOC:1475 |
ResponseWriter |
jakarta.faces.context.ResponseWriter.ResponseWriter
|
|
true |
|
true |
| JSF:JAVADOC:1476 |
void |
jakarta.faces.context.ResponseWriter.startCDATA
|
Open an
XML CDATA block. Note that XML does not allow nested CDATA blocks,
though this method does not enforce that constraint. The default
implementation of this method takes no action when invoked. |
true |
|
true |
| JSF:JAVADOC:1477 |
void |
jakarta.faces.context.ResponseWriter.startCDATA
throws IOException
|
if
input/output error occures |
true |
|
true |
| JSF:JAVADOC:1478 |
void |
jakarta.faces.context.ResponseWriter.startDocument
|
Write
whatever text should begin a response. |
true |
|
true |
| JSF:JAVADOC:1479 |
void |
jakarta.faces.context.ResponseWriter.startDocument
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1480 |
void |
jakarta.faces.context.ResponseWriter.startElement
( String ,
UIComponent ) |
Write
the start of an element, up to and including the element name. Once
this method has been called, clients can call the writeAttribute() or
writeURIAttribute() methods to add attributes and corresponding
values. The starting element will be closed (that is, the trailing
'>' character added) on any subsequent call to startElement(),
writeComment(), writeText(), endElement(), endDocument(), close(),
flush(), or write(). |
true |
|
true |
| JSF:JAVADOC:1481 |
void |
jakarta.faces.context.ResponseWriter.startElement
( String ,
UIComponent )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1482 |
void |
jakarta.faces.context.ResponseWriter.startElement
( String ,
UIComponent )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1483 |
void |
jakarta.faces.context.ResponseWriter.writeAttribute
( String ,
Object ,
String ) |
Write
an attribute name and corresponding value, after converting that text
to a String (if necessary), and after performing any escaping
appropriate for the markup language being rendered. This method may
only be called after a call to startElement(), and before the opened
element has been closed. |
true |
|
true |
| JSF:JAVADOC:1484 |
void |
jakarta.faces.context.ResponseWriter.writeAttribute
( String ,
Object ,
String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1485 |
void |
jakarta.faces.context.ResponseWriter.writeAttribute
( String ,
Object ,
String )
throws IllegalStateException
|
if this
method is called when there is no currently open element |
true |
|
true |
| JSF:JAVADOC:1486 |
void |
jakarta.faces.context.ResponseWriter.writeAttribute
( String ,
Object ,
String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1487 |
void |
jakarta.faces.context.ResponseWriter.writeComment
( Object ) |
Write a
comment containing the specified text, after converting that text to a
String (if necessary), and after performing any escaping appropriate
for the markup language being rendered. If there is an open element
that has been created by a call to startElement(), that element will
be closed first. |
true |
|
true |
| JSF:JAVADOC:1488 |
void |
jakarta.faces.context.ResponseWriter.writeComment
( Object )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1489 |
void |
jakarta.faces.context.ResponseWriter.writeComment
( Object )
throws NullPointerException
|
if
comment is null |
true |
|
true |
| JSF:JAVADOC:1490 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
String ) |
Write
an object, after converting it to a String (if necessary), and after
performing any escaping appropriate for the markup language being
rendered. If there is an open element that has been created by a call
to startElement(), that element will be closed first. |
true |
|
true |
| JSF:JAVADOC:1491 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1492 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
String )
throws NullPointerException
|
if text
is null |
true |
|
true |
| JSF:JAVADOC:1493 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
UIComponent ,
String ) |
Write
an object, after converting it to a String (if necessary), and after
performing any escaping appropriate for the markup language being
rendered. This method is equivalent to
#writeText(java.lang.Object,java.lang.String) but adds a component
property to allow custom ResponseWriter implementations to associate a
component with an arbitrary portion of text. The default
implementation simply ignores the component argument and calls through
to #writeText(java.lang.Object,java.lang.String) |
true |
|
true |
| JSF:JAVADOC:1494 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
UIComponent ,
String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1495 |
void |
jakarta.faces.context.ResponseWriter.writeText
( Object ,
UIComponent ,
String )
throws NullPointerException
|
if text
is null |
true |
|
true |
| JSF:JAVADOC:1496 |
void |
jakarta.faces.context.ResponseWriter.writeText
( char[] ,
int ,
int ) |
Write
text from a character array, after any performing any escaping
appropriate for the markup language being rendered. If there is an
open element that has been created by a call to startElement(), that
element will be closed first. |
true |
|
true |
| JSF:JAVADOC:1497 |
void |
jakarta.faces.context.ResponseWriter.writeText
( char[] ,
int ,
int )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1498 |
void |
jakarta.faces.context.ResponseWriter.writeText
( char[] ,
int ,
int )
throws IndexOutOfBoundsException
|
if the
calculated starting or ending position is outside the bounds of the
character array |
true |
|
true |
| JSF:JAVADOC:1499 |
void |
jakarta.faces.context.ResponseWriter.writeText
( char[] ,
int ,
int )
throws NullPointerException
|
if text
is null |
true |
|
true |
| JSF:JAVADOC:1500 |
void |
jakarta.faces.context.ResponseWriter.writeURIAttribute
( String ,
Object ,
String ) |
Write a
URI attribute name and corresponding value, after converting that text
to a String (if necessary), and after performing any encoding
appropriate to the markup language being rendered. This method may
only be called after a call to startElement(), and before the opened
element has been closed. |
true |
|
true |
| JSF:JAVADOC:1501 |
void |
jakarta.faces.context.ResponseWriter.writeURIAttribute
( String ,
Object ,
String )
throws IOException
|
if an
input/output error occurs |
true |
|
true |
| JSF:JAVADOC:1502 |
void |
jakarta.faces.context.ResponseWriter.writeURIAttribute
( String ,
Object ,
String )
throws IllegalStateException
|
if this
method is called when there is no currently open element |
true |
|
true |
| JSF:JAVADOC:1503 |
void |
jakarta.faces.context.ResponseWriter.writeURIAttribute
( String ,
Object ,
String )
throws NullPointerException
|
if name
is null |
true |
|
true |
| JSF:JAVADOC:1504 |
ResponseWriter |
jakarta.faces.context.ResponseWriterWrapper.cloneWithWriter
( Writer ) |
The
default behavior of this method is to call
ResponseWriter#cloneWithWriter(java.io.Writer) on the wrapped
ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1505 |
void |
jakarta.faces.context.ResponseWriterWrapper.close
|
The
default behavior of this method is to call ResponseWriter#close() on
the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1506 |
void |
jakarta.faces.context.ResponseWriterWrapper.close
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1507 |
void |
jakarta.faces.context.ResponseWriterWrapper.endCDATA
|
The
default behavior of this method is to call ResponseWriter#endCDATA on
the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1508 |
void |
jakarta.faces.context.ResponseWriterWrapper.endCDATA
throws IOException
|
on any
read/write error |
true |
|
true |
| JSF:JAVADOC:1509 |
void |
jakarta.faces.context.ResponseWriterWrapper.endDocument
|
The
default behavior of this method is to call
ResponseWriter#endDocument() on the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1510 |
void |
jakarta.faces.context.ResponseWriterWrapper.endDocument
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1511 |
void |
jakarta.faces.context.ResponseWriterWrapper.endElement
( String ) |
The
default behavior of this method is to call
ResponseWriter#endElement(String) on the wrapped ResponseWriter
object. |
true |
|
true |
| JSF:JAVADOC:1512 |
void |
jakarta.faces.context.ResponseWriterWrapper.endElement
( String )
throws IOException
|
on any
read/write error |
true |
|
true |
| JSF:JAVADOC:1513 |
void |
jakarta.faces.context.ResponseWriterWrapper.flush
|
The
default behavior of this method is to call ResponseWriter#flush() on
the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1514 |
void |
jakarta.faces.context.ResponseWriterWrapper.flush
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1515 |
String |
jakarta.faces.context.ResponseWriterWrapper.getCharacterEncoding
|
The
default behavior of this method is to call
ResponseWriter#getCharacterEncoding() on the wrapped ResponseWriter
object. |
true |
|
true |
| JSF:JAVADOC:1516 |
String |
jakarta.faces.context.ResponseWriterWrapper.getContentType
|
The
default behavior of this method is to call
ResponseWriter#getContentType() on the wrapped ResponseWriter object.
|
true |
|
true |
| JSF:JAVADOC:1517 |
ResponseWriter |
jakarta.faces.context.ResponseWriterWrapper.getWrapped
|
Return
the instance that we are wrapping. As of version 2, this method is
public. |
true |
|
true |
| JSF:JAVADOC:1518 |
ResponseWriterWrapper |
jakarta.faces.context.ResponseWriterWrapper.ResponseWriterWrapper
|
|
true |
|
true |
| JSF:JAVADOC:1519 |
void |
jakarta.faces.context.ResponseWriterWrapper.startCDATA
|
The
default behavior of this method is to call ResponseWriter#startCDATA
on the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1520 |
void |
jakarta.faces.context.ResponseWriterWrapper.startCDATA
throws IOException
|
on any
read/write error |
true |
|
true |
| JSF:JAVADOC:1521 |
void |
jakarta.faces.context.ResponseWriterWrapper.startDocument
|
The
default behavior of this method is to call
ResponseWriter#startDocument() on the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1522 |
void |
jakarta.faces.context.ResponseWriterWrapper.startDocument
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1523 |
void |
jakarta.faces.context.ResponseWriterWrapper.startElement
( String ,
UIComponent ) |
The
default behavior of this method is to call
ResponseWriter#startElement(String, jakarta.faces.component.UIComponent)
on the wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1524 |
void |
jakarta.faces.context.ResponseWriterWrapper.startElement
( String ,
UIComponent )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1525 |
void |
jakarta.faces.context.ResponseWriterWrapper.write
( char[] ,
int ,
int ) |
The
default behavior of this method is to call
ResponseWriter#write(char[], int, int) on the wrapped ResponseWriter
object. |
true |
|
true |
| JSF:JAVADOC:1526 |
void |
jakarta.faces.context.ResponseWriterWrapper.write
( char[] ,
int ,
int )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1527 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeAttribute
( String ,
Object ,
String ) |
The
default behavior of this method is to call
ResponseWriter#writeAttribute(String, Object, String) on the wrapped
ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1528 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeAttribute
( String ,
Object ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1529 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeComment
( Object ) |
The
default behavior of this method is to call
ResponseWriter#writeComment(Object) on the wrapped ResponseWriter
object. |
true |
|
true |
| JSF:JAVADOC:1530 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeComment
( Object )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1531 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( Object ,
String ) |
The
default behavior of this method is to call
ResponseWriter#writeText(Object, String) on the wrapped ResponseWriter
object. |
true |
|
true |
| JSF:JAVADOC:1532 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( Object ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1533 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( Object ,
UIComponent ,
String ) |
The
default behavior of this method is to call
ResponseWriter#writeText(Object, UIComponent, String) on the wrapped
ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1534 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( Object ,
UIComponent ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1535 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( char[] ,
int ,
int ) |
The
default behavior of this method is to call
ResponseWriter#writeText(char[], int, int) on the wrapped
ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1536 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeText
( char[] ,
int ,
int )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1537 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeURIAttribute
( String ,
Object ,
String ) |
The
default behavior of this method is to call
ResponseWriter#writeURIAttribute(String, Object, String) on the
wrapped ResponseWriter object. |
true |
|
true |
| JSF:JAVADOC:1538 |
void |
jakarta.faces.context.ResponseWriterWrapper.writeURIAttribute
( String ,
Object ,
String )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:1539 |
BigDecimalConverter |
jakarta.faces.convert.BigDecimalConverter.BigDecimalConverter
|
|
true |
|
true |
| JSF:JAVADOC:1540 |
Object |
jakarta.faces.convert.BigDecimalConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1541 |
Object |
jakarta.faces.convert.BigDecimalConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1542 |
Object |
jakarta.faces.convert.BigDecimalConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1543 |
String |
jakarta.faces.convert.BigDecimalConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1544 |
String |
jakarta.faces.convert.BigDecimalConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1545 |
String |
jakarta.faces.convert.BigDecimalConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1546 |
BigIntegerConverter |
jakarta.faces.convert.BigIntegerConverter.BigIntegerConverter
|
|
true |
|
true |
| JSF:JAVADOC:1547 |
Object |
jakarta.faces.convert.BigIntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1548 |
Object |
jakarta.faces.convert.BigIntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1549 |
Object |
jakarta.faces.convert.BigIntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1550 |
String |
jakarta.faces.convert.BigIntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1551 |
String |
jakarta.faces.convert.BigIntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1552 |
String |
jakarta.faces.convert.BigIntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1553 |
BooleanConverter |
jakarta.faces.convert.BooleanConverter.BooleanConverter
|
|
true |
|
true |
| JSF:JAVADOC:1554 |
Object |
jakarta.faces.convert.BooleanConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1555 |
Object |
jakarta.faces.convert.BooleanConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1556 |
Object |
jakarta.faces.convert.BooleanConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1557 |
String |
jakarta.faces.convert.BooleanConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1558 |
String |
jakarta.faces.convert.BooleanConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1559 |
String |
jakarta.faces.convert.BooleanConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1560 |
ByteConverter |
jakarta.faces.convert.ByteConverter.ByteConverter
|
|
true |
|
true |
| JSF:JAVADOC:1561 |
Object |
jakarta.faces.convert.ByteConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1562 |
Object |
jakarta.faces.convert.ByteConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1563 |
Object |
jakarta.faces.convert.ByteConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1564 |
String |
jakarta.faces.convert.ByteConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1565 |
String |
jakarta.faces.convert.ByteConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1566 |
String |
jakarta.faces.convert.ByteConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1567 |
CharacterConverter |
jakarta.faces.convert.CharacterConverter.CharacterConverter
|
|
true |
|
true |
| JSF:JAVADOC:1568 |
Object |
jakarta.faces.convert.CharacterConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1569 |
Object |
jakarta.faces.convert.CharacterConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1570 |
Object |
jakarta.faces.convert.CharacterConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1571 |
String |
jakarta.faces.convert.CharacterConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1572 |
String |
jakarta.faces.convert.CharacterConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1573 |
String |
jakarta.faces.convert.CharacterConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1574 |
Object |
jakarta.faces.convert.Converter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1575 |
Object |
jakarta.faces.convert.Converter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1576 |
Object |
jakarta.faces.convert.Converter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1577 |
String |
jakarta.faces.convert.Converter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1578 |
String |
jakarta.faces.convert.Converter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1579 |
String |
jakarta.faces.convert.Converter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1580 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
|
Construct a new exception with no detail message or root cause. |
true |
|
true |
| JSF:JAVADOC:1581 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
|
true |
| JSF:JAVADOC:1582 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
|
true |
| JSF:JAVADOC:1583 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:1584 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
( FacesMessage ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
|
true |
| JSF:JAVADOC:1585 |
ConverterException |
jakarta.faces.convert.ConverterException.ConverterException
( FacesMessage ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:1586 |
FacesMessage |
jakarta.faces.convert.ConverterException.getFacesMessage
|
Returns
the FacesMessage associated with this exception; this will only be
available if the converter that thew this exception instance placed it
there. |
true |
|
true |
| JSF:JAVADOC:1587 |
void |
jakarta.faces.convert.DateTimeConverter.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:1588 |
DateTimeConverter |
jakarta.faces.convert.DateTimeConverter.DateTimeConverter
|
|
true |
|
true |
| JSF:JAVADOC:1589 |
Object |
jakarta.faces.convert.DateTimeConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1590 |
Object |
jakarta.faces.convert.DateTimeConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1591 |
Object |
jakarta.faces.convert.DateTimeConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1592 |
String |
jakarta.faces.convert.DateTimeConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1593 |
String |
jakarta.faces.convert.DateTimeConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1594 |
String |
jakarta.faces.convert.DateTimeConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1595 |
String |
jakarta.faces.convert.DateTimeConverter.getDateStyle
|
Return
the style to be used to format or parse dates. If not set, the default
value, default, is returned. |
true |
|
true |
| JSF:JAVADOC:1596 |
Locale |
jakarta.faces.convert.DateTimeConverter.getLocale
|
Return
the Locale to be used when parsing or formatting dates and times. If
not explicitly set, the Locale stored in the
jakarta.faces.component.UIViewRoot for the current request is returned.
|
true |
|
true |
| JSF:JAVADOC:1597 |
String |
jakarta.faces.convert.DateTimeConverter.getPattern
|
Return
the format pattern to be used when formatting and parsing dates and
times. |
true |
|
true |
| JSF:JAVADOC:1598 |
String |
jakarta.faces.convert.DateTimeConverter.getTimeStyle
|
Return
the style to be used to format or parse times. If not set, the default
value, default, is returned. |
true |
|
true |
| JSF:JAVADOC:1599 |
TimeZone |
jakarta.faces.convert.DateTimeConverter.getTimeZone
|
Return
the TimeZone used to interpret a time value. If not explicitly set,
the default time zone of GMT returned. |
true |
|
true |
| JSF:JAVADOC:1600 |
String |
jakarta.faces.convert.DateTimeConverter.getType
|
Return
the type of value to be formatted or parsed. If not explicitly set,
the default type, date is returned. |
true |
|
true |
| JSF:JAVADOC:1601 |
boolean |
jakarta.faces.convert.DateTimeConverter.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:1602 |
boolean |
jakarta.faces.convert.DateTimeConverter.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:1603 |
void |
jakarta.faces.convert.DateTimeConverter.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:1604 |
void |
jakarta.faces.convert.DateTimeConverter.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:1605 |
Object |
jakarta.faces.convert.DateTimeConverter.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:1606 |
void |
jakarta.faces.convert.DateTimeConverter.setDateStyle
( String ) |
Set the
style to be used to format or parse dates. Valid values are default,
short, medium, long, and full. An invalid value will cause a
ConverterException when getAsObject() or getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1607 |
void |
jakarta.faces.convert.DateTimeConverter.setLocale
( Locale ) |
Set the
Locale to be used when parsing or formatting dates and times. If set
to null, the Locale stored in the jakarta.faces.component.UIViewRoot for
the current request will be utilized. |
true |
|
true |
| JSF:JAVADOC:1608 |
void |
jakarta.faces.convert.DateTimeConverter.setPattern
( String ) |
Set the
format pattern to be used when formatting and parsing dates and times.
Valid values are those supported by java.text.SimpleDateFormat. An
invalid value will cause a ConverterException when getAsObject() or
getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1609 |
void |
jakarta.faces.convert.DateTimeConverter.setTimeStyle
( String ) |
Set the
style to be used to format or parse times. Valid values are default,
short, medium, long, and full. An invalid value will cause a
ConverterException when getAsObject() or getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1610 |
void |
jakarta.faces.convert.DateTimeConverter.setTimeZone
( TimeZone ) |
Set the
TimeZone used to interpret a time value. |
true |
|
true |
| JSF:JAVADOC:1611 |
void |
jakarta.faces.convert.DateTimeConverter.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:1612 |
void |
jakarta.faces.convert.DateTimeConverter.setType
( String ) |
Set the
type of value to be formatted or parsed. Valid values are both, date,
or time. An invalid value will cause a ConverterException when
getAsObject() or getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1613 |
DoubleConverter |
jakarta.faces.convert.DoubleConverter.DoubleConverter
|
|
true |
|
true |
| JSF:JAVADOC:1614 |
Object |
jakarta.faces.convert.DoubleConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1615 |
Object |
jakarta.faces.convert.DoubleConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1616 |
Object |
jakarta.faces.convert.DoubleConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1617 |
String |
jakarta.faces.convert.DoubleConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1618 |
String |
jakarta.faces.convert.DoubleConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1619 |
String |
jakarta.faces.convert.DoubleConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1620 |
void |
jakarta.faces.convert.EnumConverter.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:1621 |
EnumConverter |
jakarta.faces.convert.EnumConverter.EnumConverter
|
|
true |
|
true |
| JSF:JAVADOC:1622 |
EnumConverter |
jakarta.faces.convert.EnumConverter.EnumConverter
( Class ) |
|
true |
|
true |
| JSF:JAVADOC:1623 |
Object |
jakarta.faces.convert.EnumConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the value argument to one of the enum constants of the class provided
in our constructor. If no target class argument has been provided to
the constructor of this instance, throw a ConverterException
containing the #ENUM_NO_CLASS_ID message with proper parameters. If
the value argument is null or it has a length of zero, return null.
Otherwise, perform the equivalent of Enum.valueOf using target class
and value and return the Object. If the conversion fails, throw a
ConverterException containing the #ENUM_ID message with proper
parameters. |
true |
|
true |
| JSF:JAVADOC:1624 |
Object |
jakarta.faces.convert.EnumConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1625 |
Object |
jakarta.faces.convert.EnumConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1626 |
String |
jakarta.faces.convert.EnumConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the enum constant given by the value argument into a String. If no
target class argument has been provided to the constructor of this
instance, throw a ConverterException containing the #ENUM_NO_CLASS_ID
message with proper parameters. If the value argument is null, return
null. If the value is an instance of the provided target class, return
its string value by casting it to a java.lang.Enum and returning the
result of calling the name() method. Otherwise, throw a
ConverterException containing the #ENUM_ID message with proper
parameters. |
true |
|
true |
| JSF:JAVADOC:1627 |
String |
jakarta.faces.convert.EnumConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1628 |
String |
jakarta.faces.convert.EnumConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1629 |
boolean |
jakarta.faces.convert.EnumConverter.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:1630 |
boolean |
jakarta.faces.convert.EnumConverter.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:1631 |
void |
jakarta.faces.convert.EnumConverter.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:1632 |
void |
jakarta.faces.convert.EnumConverter.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:1633 |
Object |
jakarta.faces.convert.EnumConverter.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:1634 |
void |
jakarta.faces.convert.EnumConverter.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:1635 |
Class |
jakarta.faces.convert.FacesConverter.forClass
|
The
value of this annotation attribute is taken to be the
converter-for-class with which instances of this class of converter
can be instantiated by calling
jakarta.faces.application.Application#createConverter(java.lang.Class).
|
true |
|
true |
| JSF:JAVADOC:1636 |
String |
jakarta.faces.convert.FacesConverter.value
|
The
value of this annotation attribute is taken to be the converter-id
with which instances of this class of converter can be instantiated by
calling
jakarta.faces.application.Application#createConverter(java.lang.String).
|
true |
|
true |
| JSF:JAVADOC:1637 |
FloatConverter |
jakarta.faces.convert.FloatConverter.FloatConverter
|
|
true |
|
true |
| JSF:JAVADOC:1638 |
Object |
jakarta.faces.convert.FloatConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1639 |
Object |
jakarta.faces.convert.FloatConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1640 |
Object |
jakarta.faces.convert.FloatConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1641 |
String |
jakarta.faces.convert.FloatConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1642 |
String |
jakarta.faces.convert.FloatConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1643 |
String |
jakarta.faces.convert.FloatConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1644 |
Object |
jakarta.faces.convert.IntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1645 |
Object |
jakarta.faces.convert.IntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1646 |
Object |
jakarta.faces.convert.IntegerConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1647 |
String |
jakarta.faces.convert.IntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1648 |
String |
jakarta.faces.convert.IntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1649 |
String |
jakarta.faces.convert.IntegerConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1650 |
IntegerConverter |
jakarta.faces.convert.IntegerConverter.IntegerConverter
|
|
true |
|
true |
| JSF:JAVADOC:1651 |
Object |
jakarta.faces.convert.LongConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1652 |
Object |
jakarta.faces.convert.LongConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1653 |
Object |
jakarta.faces.convert.LongConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1654 |
String |
jakarta.faces.convert.LongConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1655 |
String |
jakarta.faces.convert.LongConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1656 |
String |
jakarta.faces.convert.LongConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1657 |
LongConverter |
jakarta.faces.convert.LongConverter.LongConverter
|
|
true |
|
true |
| JSF:JAVADOC:1658 |
void |
jakarta.faces.convert.NumberConverter.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:1659 |
Object |
jakarta.faces.convert.NumberConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1660 |
Object |
jakarta.faces.convert.NumberConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1661 |
Object |
jakarta.faces.convert.NumberConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1662 |
String |
jakarta.faces.convert.NumberConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1663 |
String |
jakarta.faces.convert.NumberConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1664 |
String |
jakarta.faces.convert.NumberConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1665 |
String |
jakarta.faces.convert.NumberConverter.getCurrencyCode
|
Return
the ISO 4217 currency code used by getAsString() with a type of
currency. If not set, the value used will be based on the formatting
Locale. |
true |
|
true |
| JSF:JAVADOC:1666 |
String |
jakarta.faces.convert.NumberConverter.getCurrencySymbol
|
Return
the currency symbol used by getAsString() with a type of currency. If
not set, the value used will be based on the formatting Locale. |
true |
|
true |
| JSF:JAVADOC:1667 |
Locale |
jakarta.faces.convert.NumberConverter.getLocale
|
Return
the Locale to be used when parsing numbers. If this value is null, the
Locale stored in the jakarta.faces.component.UIViewRoot for the current
request will be utilized. |
true |
|
true |
| JSF:JAVADOC:1668 |
int |
jakarta.faces.convert.NumberConverter.getMaxFractionDigits
|
Return
the maximum number of digits getAsString() should render in the
fraction portion of the result. |
true |
|
true |
| JSF:JAVADOC:1669 |
int |
jakarta.faces.convert.NumberConverter.getMaxIntegerDigits
|
Return
the maximum number of digits getAsString() should render in the
integer portion of the result. |
true |
|
true |
| JSF:JAVADOC:1670 |
int |
jakarta.faces.convert.NumberConverter.getMinFractionDigits
|
Return
the minimum number of digits getAsString() should render in the
fraction portion of the result. |
true |
|
true |
| JSF:JAVADOC:1671 |
int |
jakarta.faces.convert.NumberConverter.getMinIntegerDigits
|
Return
the minimum number of digits getAsString() should render in the
integer portion of the result. |
true |
|
true |
| JSF:JAVADOC:1672 |
String |
jakarta.faces.convert.NumberConverter.getPattern
|
Return
the format pattern to be used when formatting and parsing numbers. |
true |
|
true |
| JSF:JAVADOC:1673 |
String |
jakarta.faces.convert.NumberConverter.getType
|
Return
the number type to be used when formatting and parsing numbers. If not
modified, the default type is number. |
true |
|
true |
| JSF:JAVADOC:1674 |
boolean |
jakarta.faces.convert.NumberConverter.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:1675 |
boolean |
jakarta.faces.convert.NumberConverter.isGroupingUsed
|
Return
true if getAsString should include grouping separators if necessary.
If not modified, the default value is true. |
true |
|
true |
| JSF:JAVADOC:1676 |
boolean |
jakarta.faces.convert.NumberConverter.isIntegerOnly
|
Return
true if only the integer portion of the given value should be returned
from getAsObject(). If not modified, the default value is false. |
true |
|
true |
| JSF:JAVADOC:1677 |
boolean |
jakarta.faces.convert.NumberConverter.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:1678 |
void |
jakarta.faces.convert.NumberConverter.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:1679 |
NumberConverter |
jakarta.faces.convert.NumberConverter.NumberConverter
|
|
true |
|
true |
| JSF:JAVADOC:1680 |
void |
jakarta.faces.convert.NumberConverter.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:1681 |
Object |
jakarta.faces.convert.NumberConverter.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:1682 |
void |
jakarta.faces.convert.NumberConverter.setCurrencyCode
( String ) |
Set the
ISO 4217 currency code used by getAsString() with a type of currency.
|
true |
|
true |
| JSF:JAVADOC:1683 |
void |
jakarta.faces.convert.NumberConverter.setCurrencySymbol
( String ) |
Set the
currency symbol used by getAsString() with a type of currency. |
true |
|
true |
| JSF:JAVADOC:1684 |
void |
jakarta.faces.convert.NumberConverter.setGroupingUsed
( boolean ) |
Set the
flag indicating whether getAsString() should include grouping
separators if necessary. |
true |
|
true |
| JSF:JAVADOC:1685 |
void |
jakarta.faces.convert.NumberConverter.setIntegerOnly
( boolean ) |
Set to
true if only the integer portion of the given value should be returned
from getAsObject(). |
true |
|
true |
| JSF:JAVADOC:1686 |
void |
jakarta.faces.convert.NumberConverter.setLocale
( Locale ) |
Set the
Locale to be used when parsing numbers. If set to null, the Locale
stored in the jakarta.faces.component.UIViewRoot for the current request
will be utilized. |
true |
|
true |
| JSF:JAVADOC:1687 |
void |
jakarta.faces.convert.NumberConverter.setMaxFractionDigits
( int ) |
Set the
maximum number of digits getAsString() should render in the fraction
portion of the result. If not set, the number of digits depends on the
value being converted. |
true |
|
true |
| JSF:JAVADOC:1688 |
void |
jakarta.faces.convert.NumberConverter.setMaxIntegerDigits
( int ) |
Set the
maximum number of digits getAsString() should render in the integer
portion of the result. If not set, the number of digits depends on the
value being converted. |
true |
|
true |
| JSF:JAVADOC:1689 |
void |
jakarta.faces.convert.NumberConverter.setMinFractionDigits
( int ) |
Set the
minimum number of digits getAsString() should render in the fraction
portion of the result. If not set, the number of digits depends on the
value being converted. |
true |
|
true |
| JSF:JAVADOC:1690 |
void |
jakarta.faces.convert.NumberConverter.setMinIntegerDigits
( int ) |
Set the
minimum number of digits getAsString() should render in the integer
portion of the result. If not set, the number of digits depends on the
value being converted. |
true |
|
true |
| JSF:JAVADOC:1691 |
void |
jakarta.faces.convert.NumberConverter.setPattern
( String ) |
Set the
format pattern to be used when formatting and parsing numbers. Valid
values are those supported by java.text.DecimalFormat. An invalid
value will cause a ConverterException when getAsObject() or
getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1692 |
void |
jakarta.faces.convert.NumberConverter.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:1693 |
void |
jakarta.faces.convert.NumberConverter.setType
( String ) |
Set the
number type to be used when formatting and parsing numbers. Valid
values are currency, number, or percent. An invalid value will cause a
ConverterException when getAsObject() or getAsString() is called. |
true |
|
true |
| JSF:JAVADOC:1694 |
Object |
jakarta.faces.convert.ShortConverter.getAsObject
( FacesContext ,
UIComponent ,
String ) |
Convert
the specified string value, which is associated with the specified
UIComponent, into a model data object that is appropriate for being
stored during the Apply Request Values phase of the request processing
lifecycle. |
true |
|
true |
| JSF:JAVADOC:1695 |
Object |
jakarta.faces.convert.ShortConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1696 |
Object |
jakarta.faces.convert.ShortConverter.getAsObject
( FacesContext ,
UIComponent ,
String )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1697 |
String |
jakarta.faces.convert.ShortConverter.getAsString
( FacesContext ,
UIComponent ,
Object ) |
Convert
the specified model object value, which is associated with the
specified UIComponent, into a String that is suitable for being
included in the response generated during the Render Response phase of
the request processing lifeycle. |
true |
|
true |
| JSF:JAVADOC:1698 |
String |
jakarta.faces.convert.ShortConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if
conversion cannot be successfully performed |
true |
|
true |
| JSF:JAVADOC:1699 |
String |
jakarta.faces.convert.ShortConverter.getAsString
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:1700 |
ShortConverter |
jakarta.faces.convert.ShortConverter.ShortConverter
|
|
true |
|
true |
| JSF:JAVADOC:1701 |
ValueExpression |
jakarta.faces.el.CompositeComponentExpressionHolder.getExpression
( String ) |
|
true |
|
true |
| JSF:JAVADOC:1702 |
EvaluationException |
jakarta.faces.el.EvaluationException.EvaluationException
|
Construct a new exception with no detail message or root cause. |
true |
true |
true |
| JSF:JAVADOC:1703 |
EvaluationException |
jakarta.faces.el.EvaluationException.EvaluationException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
true |
true |
| JSF:JAVADOC:1704 |
EvaluationException |
jakarta.faces.el.EvaluationException.EvaluationException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
true |
true |
| JSF:JAVADOC:1705 |
EvaluationException |
jakarta.faces.el.EvaluationException.EvaluationException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
true |
true |
| JSF:JAVADOC:1706 |
String |
jakarta.faces.el.MethodBinding.getExpressionString
|
Return
the (possibly null) expression String, with leading and trailing
delimiters, from which this MethodBinding was built. The default
implementation returns null. |
true |
true |
true |
| JSF:JAVADOC:1707 |
Class |
jakarta.faces.el.MethodBinding.getType
( FacesContext ) |
Return
the Java class representing the return type from the method identified
by this method binding expression. |
true |
true |
true |
| JSF:JAVADOC:1708 |
Class |
jakarta.faces.el.MethodBinding.getType
( FacesContext )
throws MethodNotFoundException
|
if no
suitable method can be found |
true |
true |
true |
| JSF:JAVADOC:1709 |
Class |
jakarta.faces.el.MethodBinding.getType
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1710 |
Object |
jakarta.faces.el.MethodBinding.invoke
( FacesContext ,
Object[] ) |
Return
the return value (if any) resulting from a call to the method
identified by this method binding expression, passing it the specified
parameters, relative to the specified FacesContext. |
true |
true |
true |
| JSF:JAVADOC:1711 |
Object |
jakarta.faces.el.MethodBinding.invoke
( FacesContext ,
Object[] )
throws EvaluationException
|
if an
exception is thrown by the called method (the thrown exception must be
included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1712 |
Object |
jakarta.faces.el.MethodBinding.invoke
( FacesContext ,
Object[] )
throws MethodNotFoundException
|
if no
suitable method can be found |
true |
true |
true |
| JSF:JAVADOC:1713 |
Object |
jakarta.faces.el.MethodBinding.invoke
( FacesContext ,
Object[] )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1714 |
MethodBinding |
jakarta.faces.el.MethodBinding.MethodBinding
|
|
true |
true |
true |
| JSF:JAVADOC:1715 |
MethodNotFoundException |
jakarta.faces.el.MethodNotFoundException.MethodNotFoundException
|
Construct a new exception with no detail message or root cause. |
true |
true |
true |
| JSF:JAVADOC:1716 |
MethodNotFoundException |
jakarta.faces.el.MethodNotFoundException.MethodNotFoundException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
true |
true |
| JSF:JAVADOC:1717 |
MethodNotFoundException |
jakarta.faces.el.MethodNotFoundException.MethodNotFoundException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
true |
true |
| JSF:JAVADOC:1718 |
MethodNotFoundException |
jakarta.faces.el.MethodNotFoundException.MethodNotFoundException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
true |
true |
| JSF:JAVADOC:1719 |
PropertyNotFoundException |
jakarta.faces.el.PropertyNotFoundException.PropertyNotFoundException
|
Construct a new exception with no detail message or root cause. |
true |
true |
true |
| JSF:JAVADOC:1720 |
PropertyNotFoundException |
jakarta.faces.el.PropertyNotFoundException.PropertyNotFoundException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
true |
true |
| JSF:JAVADOC:1721 |
PropertyNotFoundException |
jakarta.faces.el.PropertyNotFoundException.PropertyNotFoundException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
true |
true |
| JSF:JAVADOC:1722 |
PropertyNotFoundException |
jakarta.faces.el.PropertyNotFoundException.PropertyNotFoundException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
true |
true |
| JSF:JAVADOC:1723 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
Object ) |
Return
the java.lang.Class representing the type of the specified property.
An instance of any Object of that type my be set as the value of that
property, as long as the property is not read-only. The actual value
of the property, if non-null, is guaranteed to be an instance of this
type, or an instance of a subclass of this type. This method is also
useful for discovering the type of Objects that may be set as the
value of the property. For a bean base object, the property is coerced
to a String and used as the property name. For all other base object
types (e.g., a Map), the property is used without any coercing. |
true |
true |
true |
| JSF:JAVADOC:1724 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
Object )
throws EvaluationException
|
if an
exception is thrown while testing the property (the thrown exception
must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1725 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
Object )
throws PropertyNotFoundException
|
if the
specified bean base object property does not exist or if base or
property is null |
true |
true |
true |
| JSF:JAVADOC:1726 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
int ) |
Return
the java.lang.Class representing the type of the specified index. |
true |
true |
true |
| JSF:JAVADOC:1727 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
int )
throws EvaluationException
|
if an
exception is thrown while testing the property (the thrown exception
must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1728 |
Class |
jakarta.faces.el.PropertyResolver.getType
( Object ,
int )
throws PropertyNotFoundException
|
if the
index is out of bounds or if base is null |
true |
true |
true |
| JSF:JAVADOC:1729 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
Object ) |
Return
the value of the specified property from the specified base object.
For a bean base object, the property is coerced to a String and used
as the property name. For all other base object types (e.g., a Map),
the property is used without any coercing. |
true |
true |
true |
| JSF:JAVADOC:1730 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
Object )
throws EvaluationException
|
if an
exception is thrown while getting the property value (the thrown
exception must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1731 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
Object )
throws PropertyNotFoundException
|
if the
specified property for a bean base object does not exist or is not
readable |
true |
true |
true |
| JSF:JAVADOC:1732 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
int ) |
Return
the value at the specified index of the specified base object. |
true |
true |
true |
| JSF:JAVADOC:1733 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
int )
throws EvaluationException
|
if an
exception is thrown while getting the property value (the thrown
exception must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1734 |
Object |
jakarta.faces.el.PropertyResolver.getValue
( Object ,
int )
throws PropertyNotFoundException
|
if the
index is out of bounds or if base is null |
true |
true |
true |
| JSF:JAVADOC:1735 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
Object ) |
Checks
if the specified property is read-only. For a bean base object, the
property is coerced to a String and used as the property name. For all
other base object types (e.g., a Map), the property is used without
any coercing. |
true |
true |
true |
| JSF:JAVADOC:1736 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
Object )
throws EvaluationException
|
if an
exception is thrown while testing the property (the thrown exception
must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1737 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
Object )
throws PropertyNotFoundException
|
if the
specified bean base object property does not exist or if base or
property is null |
true |
true |
true |
| JSF:JAVADOC:1738 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
int ) |
Checks
if the specified index is read-only. |
true |
true |
true |
| JSF:JAVADOC:1739 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
int )
throws EvaluationException
|
if an
exception is thrown while testing the property (the thrown exception
must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1740 |
boolean |
jakarta.faces.el.PropertyResolver.isReadOnly
( Object ,
int )
throws PropertyNotFoundException
|
if the
index is out of bounds or if base is null |
true |
true |
true |
| JSF:JAVADOC:1741 |
PropertyResolver |
jakarta.faces.el.PropertyResolver.PropertyResolver
|
|
true |
true |
true |
| JSF:JAVADOC:1742 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
Object ,
Object ) |
Set the
specified value of the specified property on the specified base
object. For a bean base object, the property is coerced to a String
and used as the property name. For all other base object types (e.g.,
a Map), the property is used without any coercing. |
true |
true |
true |
| JSF:JAVADOC:1743 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
Object ,
Object )
throws EvaluationException
|
if an
exception is thrown while setting the property value (the thrown
exception must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1744 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
Object ,
Object )
throws PropertyNotFoundException
|
if the
specified bean base object property does not exist or is not
writeable, or if base or name is null |
true |
true |
true |
| JSF:JAVADOC:1745 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
int ,
Object ) |
Set the
value at the specified index of the specified base object. |
true |
true |
true |
| JSF:JAVADOC:1746 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
int ,
Object )
throws EvaluationException
|
if an
exception is thrown while setting the property value (the thrown
exception must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1747 |
void |
jakarta.faces.el.PropertyResolver.setValue
( Object ,
int ,
Object )
throws PropertyNotFoundException
|
if the
index is out of bounds or if base is null |
true |
true |
true |
| JSF:JAVADOC:1748 |
ReferenceSyntaxException |
jakarta.faces.el.ReferenceSyntaxException.ReferenceSyntaxException
|
Construct a new exception with no detail message or root cause. |
true |
true |
true |
| JSF:JAVADOC:1749 |
ReferenceSyntaxException |
jakarta.faces.el.ReferenceSyntaxException.ReferenceSyntaxException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
true |
true |
| JSF:JAVADOC:1750 |
ReferenceSyntaxException |
jakarta.faces.el.ReferenceSyntaxException.ReferenceSyntaxException
( Throwable ) |
Construct a new exception with the specified root cause. The detail
message will be set to (cause == null ? null : cause.toString() |
true |
true |
true |
| JSF:JAVADOC:1751 |
ReferenceSyntaxException |
jakarta.faces.el.ReferenceSyntaxException.ReferenceSyntaxException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
true |
true |
| JSF:JAVADOC:1752 |
String |
jakarta.faces.el.ValueBinding.getExpressionString
|
Return
the (possibly null) expression String, including the delimiters, from
which this ValueBinding was built. |
true |
true |
true |
| JSF:JAVADOC:1753 |
Class |
jakarta.faces.el.ValueBinding.getType
( FacesContext ) |
Return
the type of the property represented by this ValueBinding, relative to
the specified FacesContext. |
true |
true |
true |
| JSF:JAVADOC:1754 |
Class |
jakarta.faces.el.ValueBinding.getType
( FacesContext )
throws EvaluationException
|
if an
exception is thrown while getting the description of the property (the
thrown exception must be included as the cause property of this
exception) |
true |
true |
true |
| JSF:JAVADOC:1755 |
Class |
jakarta.faces.el.ValueBinding.getType
( FacesContext )
throws PropertyNotFoundException
|
if a
specified property name does not exist |
true |
true |
true |
| JSF:JAVADOC:1756 |
Class |
jakarta.faces.el.ValueBinding.getType
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1757 |
Object |
jakarta.faces.el.ValueBinding.getValue
( FacesContext ) |
Return
the value of the property represented by this ValueBinding, relative
to the specified FacesContext. |
true |
true |
true |
| JSF:JAVADOC:1758 |
Object |
jakarta.faces.el.ValueBinding.getValue
( FacesContext )
throws EvaluationException
|
if an
exception is thrown while getting the value (the thrown exception must
be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1759 |
Object |
jakarta.faces.el.ValueBinding.getValue
( FacesContext )
throws PropertyNotFoundException
|
if a
specified property name does not exist, or is not readable |
true |
true |
true |
| JSF:JAVADOC:1760 |
Object |
jakarta.faces.el.ValueBinding.getValue
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1761 |
boolean |
jakarta.faces.el.ValueBinding.isReadOnly
( FacesContext ) |
Return
true if the specified property of the specified property is known to
be immutable; otherwise, return false. |
true |
true |
true |
| JSF:JAVADOC:1762 |
boolean |
jakarta.faces.el.ValueBinding.isReadOnly
( FacesContext )
throws EvaluationException
|
if an
exception is thrown while getting the description of the property (the
thrown exception must be included as the cause property of this
exception) |
true |
true |
true |
| JSF:JAVADOC:1763 |
boolean |
jakarta.faces.el.ValueBinding.isReadOnly
( FacesContext )
throws PropertyNotFoundException
|
if a
specified property name does not exist |
true |
true |
true |
| JSF:JAVADOC:1764 |
boolean |
jakarta.faces.el.ValueBinding.isReadOnly
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1765 |
void |
jakarta.faces.el.ValueBinding.setValue
( FacesContext ,
Object ) |
Set the
value of the property represented by this ValueBinding, relative to
the specified FacesContext. |
true |
true |
true |
| JSF:JAVADOC:1766 |
void |
jakarta.faces.el.ValueBinding.setValue
( FacesContext ,
Object )
throws EvaluationException
|
if an
exception is thrown while setting the value (the thrown exception must
be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1767 |
void |
jakarta.faces.el.ValueBinding.setValue
( FacesContext ,
Object )
throws PropertyNotFoundException
|
if a
specified property name does not exist, or is not writeable |
true |
true |
true |
| JSF:JAVADOC:1768 |
void |
jakarta.faces.el.ValueBinding.setValue
( FacesContext ,
Object )
throws NullPointerException
|
if
context is null |
true |
true |
true |
| JSF:JAVADOC:1769 |
ValueBinding |
jakarta.faces.el.ValueBinding.ValueBinding
|
|
true |
true |
true |
| JSF:JAVADOC:1770 |
Object |
jakarta.faces.el.VariableResolver.resolveVariable
( FacesContext ,
String ) |
Resolve
the specified variable name, and return the corresponding object, if
any; otherwise, return null. |
true |
true |
true |
| JSF:JAVADOC:1771 |
Object |
jakarta.faces.el.VariableResolver.resolveVariable
( FacesContext ,
String )
throws EvaluationException
|
if an
exception is thrown while resolving the variable name (the thrown
exception must be included as the cause property of this exception) |
true |
true |
true |
| JSF:JAVADOC:1772 |
Object |
jakarta.faces.el.VariableResolver.resolveVariable
( FacesContext ,
String )
throws NullPointerException
|
if
context or name is null |
true |
true |
true |
| JSF:JAVADOC:1773 |
VariableResolver |
jakarta.faces.el.VariableResolver.VariableResolver
|
|
true |
true |
true |
| JSF:JAVADOC:1774 |
AbortProcessingException |
jakarta.faces.event.AbortProcessingException.AbortProcessingException
|
Construct a new exception with no detail message or root cause. |
true |
|
true |
| JSF:JAVADOC:1775 |
AbortProcessingException |
jakarta.faces.event.AbortProcessingException.AbortProcessingException
( String ) |
Construct a new exception with the specified detail message and no
root cause. |
true |
|
true |
| JSF:JAVADOC:1776 |
AbortProcessingException |
jakarta.faces.event.AbortProcessingException.AbortProcessingException
( Throwable ) |
Construct a new exception with the specified root cause. |
true |
|
true |
| JSF:JAVADOC:1777 |
AbortProcessingException |
jakarta.faces.event.AbortProcessingException.AbortProcessingException
( String ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:1778 |
ActionEvent |
jakarta.faces.event.ActionEvent.ActionEvent
( UIComponent ) |
Construct a new event object from the specified source component and
action command. |
true |
|
true |
| JSF:JAVADOC:1779 |
boolean |
jakarta.faces.event.ActionEvent.isAppropriateListener
( FacesListener ) |
Return
true if this FacesListener is an instance of a listener class that
this event supports. Typically, this will be accomplished by an
"instanceof" check on the listener class. |
true |
|
true |
| JSF:JAVADOC:1780 |
void |
jakarta.faces.event.ActionEvent.processListener
( FacesListener ) |
Broadcast this FacesEvent to the specified FacesListener, by whatever
mechanism is appropriate. Typically, this will be accomplished by
calling an event processing method, and passing this FacesEvent as a
paramter. |
true |
|
true |
| JSF:JAVADOC:1781 |
void |
jakarta.faces.event.ActionEvent.processListener
( FacesListener )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1782 |
void |
jakarta.faces.event.ActionListener.processAction
( ActionEvent ) |
Invoked
when the action described by the specified ActionEvent occurs. |
true |
|
true |
| JSF:JAVADOC:1783 |
void |
jakarta.faces.event.ActionListener.processAction
( ActionEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1784 |
AjaxBehaviorEvent |
jakarta.faces.event.AjaxBehaviorEvent.AjaxBehaviorEvent
( UIComponent ,
Behavior ) |
Construct a new event object from the specified source component and
Ajax behavior. |
true |
|
true |
| JSF:JAVADOC:1785 |
boolean |
jakarta.faces.event.AjaxBehaviorEvent.isAppropriateListener
( FacesListener ) |
Return
true if this FacesListener is an instance of a the appropriate
listener class that this event supports. |
true |
|
true |
| JSF:JAVADOC:1786 |
void |
jakarta.faces.event.AjaxBehaviorEvent.processListener
( FacesListener ) |
Broadcast this event instance to the specified FacesListener, by
whatever mechanism is appropriate. Typically, this will be
accomplished by calling an event processing method, and passing this
instance as a parameter. |
true |
|
true |
| JSF:JAVADOC:1787 |
void |
jakarta.faces.event.AjaxBehaviorEvent.processListener
( FacesListener )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1788 |
void |
jakarta.faces.event.AjaxBehaviorListener.processAjaxBehavior
( AjaxBehaviorEvent ) |
|
true |
|
true |
| JSF:JAVADOC:1789 |
void |
jakarta.faces.event.AjaxBehaviorListener.processAjaxBehavior
( AjaxBehaviorEvent )
throws AbortProcessingException
|
if
lifecycle processing should cease for this request. |
true |
|
true |
| JSF:JAVADOC:1790 |
BehaviorEvent |
jakarta.faces.event.BehaviorEvent.BehaviorEvent
( UIComponent ,
Behavior ) |
Construct a new event object from the specified source component and
behavior. |
true |
|
true |
| JSF:JAVADOC:1791 |
Behavior |
jakarta.faces.event.BehaviorEvent.getBehavior
|
Return
the source Behavior that sent this event. |
true |
|
true |
| JSF:JAVADOC:1792 |
ComponentSystemEvent |
jakarta.faces.event.ComponentSystemEvent.ComponentSystemEvent
( UIComponent ) |
Pass
the argument component to the superclass constructor. |
true |
|
true |
| JSF:JAVADOC:1793 |
UIComponent |
jakarta.faces.event.ComponentSystemEvent.getComponent
|
the
source UIComponent that sent this event. |
true |
|
true |
| JSF:JAVADOC:1794 |
void |
jakarta.faces.event.ComponentSystemEventListener.processEvent
( ComponentSystemEvent ) |
When
called, the listener can assume that any guarantees given in the
javadoc for the specific SystemEvent subclass are true. |
true |
|
true |
| JSF:JAVADOC:1795 |
void |
jakarta.faces.event.ComponentSystemEventListener.processEvent
( ComponentSystemEvent )
throws AbortProcessingException
|
if
lifecycle processing should cease for this request. |
true |
|
true |
| JSF:JAVADOC:1796 |
ExceptionQueuedEvent |
jakarta.faces.event.ExceptionQueuedEvent.ExceptionQueuedEvent
( ExceptionQueuedEventContext ) |
Instantiate a new ExceptionQueuedEvent that indicates the argument
ExceptionQueuedEventContext occurred. |
true |
|
true |
| JSF:JAVADOC:1797 |
ExceptionQueuedEventContext |
jakarta.faces.event.ExceptionQueuedEvent.getContext
|
Return
the ExceptionQueuedEventContext for this event instance. |
true |
|
true |
| JSF:JAVADOC:1798 |
ExceptionQueuedEventContext |
jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext
( FacesContext ,
Throwable ) |
Instantiate a new ExceptionQueuedEventContext that indicates the
argument Throwable just occurred. |
true |
|
true |
| JSF:JAVADOC:1799 |
ExceptionQueuedEventContext |
jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext
( FacesContext ,
Throwable ,
UIComponent ) |
Instantiate a new ExceptionQueuedEventContext that indicates the
argument Throwable just occurred, relevant to the argument component.
|
true |
|
true |
| JSF:JAVADOC:1800 |
ExceptionQueuedEventContext |
jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext
( FacesContext ,
Throwable ,
UIComponent ,
PhaseId ) |
Instantiate a new ExceptionQueuedEventContext that indicates the
argument Throwable just occurred, relevant to the argument component,
during the lifecycle phase phaseId. |
true |
|
true |
| JSF:JAVADOC:1801 |
Map |
jakarta.faces.event.ExceptionQueuedEventContext.getAttributes
|
A Map
of attributes relevant to the context of this ExceptionQueuedEvent. |
true |
|
true |
| JSF:JAVADOC:1802 |
UIComponent |
jakarta.faces.event.ExceptionQueuedEventContext.getComponent
|
Return
the UIComponent which was being processed when the exception was
thrown. If none or not available, this will be null. |
true |
|
true |
| JSF:JAVADOC:1803 |
FacesContext |
jakarta.faces.event.ExceptionQueuedEventContext.getContext
|
|
true |
|
true |
| JSF:JAVADOC:1804 |
Throwable |
jakarta.faces.event.ExceptionQueuedEventContext.getException
|
Return
the exception property. |
true |
|
true |
| JSF:JAVADOC:1805 |
List |
jakarta.faces.event.ExceptionQueuedEventContext.getListenersForEventClass
( Class ) |
Return
a List that contains a single entry, the
jakarta.faces.context.ExceptionHandler for the current request. |
true |
|
true |
| JSF:JAVADOC:1806 |
PhaseId |
jakarta.faces.event.ExceptionQueuedEventContext.getPhaseId
|
Return
the PhaseId which was being processed when the exception was thrown.
If none or not available, this will be null. |
true |
|
true |
| JSF:JAVADOC:1807 |
boolean |
jakarta.faces.event.ExceptionQueuedEventContext.inAfterPhase
|
|
true |
|
true |
| JSF:JAVADOC:1808 |
boolean |
jakarta.faces.event.ExceptionQueuedEventContext.inBeforePhase
|
|
true |
|
true |
| JSF:JAVADOC:1809 |
FacesEvent |
jakarta.faces.event.FacesEvent.FacesEvent
( UIComponent ) |
Construct a new event object from the specified source component. |
true |
|
true |
| JSF:JAVADOC:1810 |
UIComponent |
jakarta.faces.event.FacesEvent.getComponent
|
Return
the source UIComponent that sent this event. |
true |
|
true |
| JSF:JAVADOC:1811 |
PhaseId |
jakarta.faces.event.FacesEvent.getPhaseId
|
Return
the identifier of the request processing phase during which this event
should be delivered. Legal values are the singleton instances defined
by the PhaseId class, including PhaseId.ANY_PHASE, which is the
default value. |
true |
|
true |
| JSF:JAVADOC:1812 |
boolean |
jakarta.faces.event.FacesEvent.isAppropriateListener
( FacesListener ) |
Return
true if this FacesListener is an instance of a listener class that
this event supports. Typically, this will be accomplished by an
"instanceof" check on the listener class. |
true |
|
true |
| JSF:JAVADOC:1813 |
void |
jakarta.faces.event.FacesEvent.processListener
( FacesListener ) |
Broadcast this FacesEvent to the specified FacesListener, by whatever
mechanism is appropriate. Typically, this will be accomplished by
calling an event processing method, and passing this FacesEvent as a
paramter. |
true |
|
true |
| JSF:JAVADOC:1814 |
void |
jakarta.faces.event.FacesEvent.processListener
( FacesListener )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1815 |
void |
jakarta.faces.event.FacesEvent.queue
|
Convenience method to queue this event for broadcast at the end of the
current request processing lifecycle phase. |
true |
|
true |
| JSF:JAVADOC:1816 |
void |
jakarta.faces.event.FacesEvent.queue
throws IllegalStateException
|
if the
source component for this event is not a descendant of a UIViewRoot |
true |
|
true |
| JSF:JAVADOC:1817 |
void |
jakarta.faces.event.FacesEvent.setPhaseId
( PhaseId ) |
Set the
PhaseId during which this event will be delivered. |
true |
|
true |
| JSF:JAVADOC:1818 |
void |
jakarta.faces.event.FacesEvent.setPhaseId
( PhaseId )
throws IllegalArgumentException
|
phaseId
is null. |
true |
|
true |
| JSF:JAVADOC:1819 |
Class |
jakarta.faces.event.ListenerFor.sourceClass
|
The
kind of object that emits events of the type given by the value of the
#systemEventClass attribute. It is valid to have EL Expressions in the
value of this attribute, as long as the expression resolves to an
instance of the expected type. |
true |
|
true |
| JSF:JAVADOC:1820 |
Class |
jakarta.faces.event.ListenerFor.systemEventClass
|
The
kind of system event for which this class will be installed as a
listener. The implementation only supports exact matches on the Class
and must not honor subclass relationships. It is valid to have EL
Expressions in the value of this attribute, as long as the expression
resolves to an instance of the expected type. |
true |
|
true |
| JSF:JAVADOC:1821 |
ListenerFor[] |
jakarta.faces.event.ListenersFor.value
|
|
true |
|
true |
| JSF:JAVADOC:1822 |
boolean |
jakarta.faces.event.MethodExpressionActionListener.isTransient
|
If
true, the Object implementing this interface must not participate in
state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:1823 |
MethodExpressionActionListener |
jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener
|
|
true |
|
true |
| JSF:JAVADOC:1824 |
MethodExpressionActionListener |
jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener
( MethodExpression ) |
Construct a ValueChangeListener that contains a MethodExpression. To
accomodate method expression targets that take no arguments instead of
taking an ActionEvent 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. The usage requirements for both
of these MethodExpression instances are described in #processAction. |
true |
|
true |
| JSF:JAVADOC:1825 |
MethodExpressionActionListener |
jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener
( MethodExpression ,
MethodExpression ) |
|
true |
|
true |
| JSF:JAVADOC:1826 |
void |
jakarta.faces.event.MethodExpressionActionListener.processAction
( ActionEvent ) |
Call
through to the MethodExpression passed in our constructor. First, try
to invoke the MethodExpression passed to the constructor of this
instance, passing the argument ActionEvent as the argument. If a
MethodNotFoundException is thrown, call to the zero argument
MethodExpression derived from the MethodExpression passed to the
constructor of this instance. If that fails for any reason, throw an
AbortProcessingException, including the cause of the failure. |
true |
|
true |
| JSF:JAVADOC:1827 |
void |
jakarta.faces.event.MethodExpressionActionListener.processAction
( ActionEvent )
throws AbortProcessingException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1828 |
void |
jakarta.faces.event.MethodExpressionActionListener.processAction
( ActionEvent )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1829 |
void |
jakarta.faces.event.MethodExpressionActionListener.restoreState
( FacesContext ,
Object ) |
Both
MethodExpression instances described in the constructor must be
restored. |
true |
|
true |
| JSF:JAVADOC:1830 |
Object |
jakarta.faces.event.MethodExpressionActionListener.saveState
( FacesContext ) |
Both
MethodExpression instances described in the constructor must be saved.
|
true |
|
true |
| JSF:JAVADOC:1831 |
void |
jakarta.faces.event.MethodExpressionActionListener.setTransient
( boolean ) |
Denotes
whether or not the Object implementing this interface must or must not
participate in state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:1832 |
boolean |
jakarta.faces.event.MethodExpressionValueChangeListener.isTransient
|
If
true, the Object implementing this interface must not participate in
state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:1833 |
MethodExpressionValueChangeListener |
jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener
|
|
true |
|
true |
| JSF:JAVADOC:1834 |
MethodExpressionValueChangeListener |
jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener
( MethodExpression ) |
Construct a ValueChangeListener that contains a MethodExpression.To
accomodate 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. The usage requirements for both
of these MethodExpression instances are described in
#processValueChange. |
true |
|
true |
| JSF:JAVADOC:1835 |
MethodExpressionValueChangeListener |
jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener
( MethodExpression ,
MethodExpression ) |
Construct a ValueChangeListener that contains a MethodExpression. |
true |
|
true |
| JSF:JAVADOC:1836 |
void |
jakarta.faces.event.MethodExpressionValueChangeListener.processValueChange
( ValueChangeEvent ) |
Call
through to the MethodExpression passed in our constructor. First, try
to invoke the MethodExpression passed to the constructor of this
instance, passing the argument ValueChangeEvent as the argument. If a
MethodNotFoundException is thrown, call to the zero argument
MethodExpression derived from the MethodExpression passed to the
constructor of this instance. If that fails for any reason, throw an
AbortProcessingException, including the cause of the failure. |
true |
|
true |
| JSF:JAVADOC:1837 |
void |
jakarta.faces.event.MethodExpressionValueChangeListener.processValueChange
( ValueChangeEvent )
throws AbortProcessingException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1838 |
void |
jakarta.faces.event.MethodExpressionValueChangeListener.processValueChange
( ValueChangeEvent )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:1839 |
void |
jakarta.faces.event.MethodExpressionValueChangeListener.restoreState
( FacesContext ,
Object ) |
Both
MethodExpression instances described in the constructor must be
restored. |
true |
|
true |
| JSF:JAVADOC:1840 |
Object |
jakarta.faces.event.MethodExpressionValueChangeListener.saveState
( FacesContext ) |
Both
MethodExpression instances described in the constructor must be saved.
|
true |
|
true |
| JSF:JAVADOC:1841 |
void |
jakarta.faces.event.MethodExpressionValueChangeListener.setTransient
( boolean ) |
Denotes
whether or not the Object implementing this interface must or must not
participate in state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:1842 |
String |
jakarta.faces.event.NamedEvent.shortName
|
The
value of this annotation attribute is taken to be the short name for
the jakarta.faces.event.ComponentSystemEvent. If the value of this
attribute is ommitted, the following algorithm must be used by the
code that processes this annotation to determine its value. Get the
unqualified class name (e.g., UserLoginEvent) Strip off the trailing
"Event", if present (e.g., UserLogin) Convert the first character to
lower-case (e.g., userLogin) Prepend the package name to the
lower-cased name. |
true |
|
true |
| JSF:JAVADOC:1843 |
FacesContext |
jakarta.faces.event.PhaseEvent.getFacesContext
|
Return
the FacesContext for the request being processed. |
true |
|
true |
| JSF:JAVADOC:1844 |
PhaseId |
jakarta.faces.event.PhaseEvent.getPhaseId
|
Return
the PhaseId representing the current request processing lifecycle
phase. |
true |
|
true |
| JSF:JAVADOC:1845 |
PhaseEvent |
jakarta.faces.event.PhaseEvent.PhaseEvent
( FacesContext ,
PhaseId ,
Lifecycle ) |
Construct a new event object from the specified parameters. The
specified Lifecycle will be the source of this event. |
true |
|
true |
| JSF:JAVADOC:1846 |
int |
jakarta.faces.event.PhaseId.compareTo
( Object ) |
Compare
this PhaseId instance to the specified one. Returns a negative
integer, zero, or a positive integer if this object is less than,
equal to, or greater than the specified object. |
true |
|
true |
| JSF:JAVADOC:1847 |
int |
jakarta.faces.event.PhaseId.getOrdinal
|
Return
the ordinal value of this PhaseId instance. |
true |
|
true |
| JSF:JAVADOC:1848 |
String |
jakarta.faces.event.PhaseId.toString
|
Return
a String representation of this PhaseId instance. |
true |
|
true |
| JSF:JAVADOC:1849 |
void |
jakarta.faces.event.PhaseListener.afterPhase
( PhaseEvent ) |
Handle
a notification that the processing for a particular phase has just
been completed. |
true |
|
true |
| JSF:JAVADOC:1850 |
void |
jakarta.faces.event.PhaseListener.beforePhase
( PhaseEvent ) |
Handle
a notification that the processing for a particular phase of the
request processing lifecycle is about to begin. |
true |
|
true |
| JSF:JAVADOC:1851 |
PhaseId |
jakarta.faces.event.PhaseListener.getPhaseId
|
Return
the identifier of the request processing phase during which this
listener is interested in processing PhaseEvent events. Legal values
are the singleton instances defined by the PhaseId class, including
PhaseId.ANY_PHASE to indicate an interest in being notified for all
standard phases. |
true |
|
true |
| JSF:JAVADOC:1852 |
boolean |
jakarta.faces.event.PostAddToViewEvent.isAppropriateListener
( FacesListener ) |
Returns
true if and only if the argument listener is an instance of
SystemEventListener. |
true |
|
true |
| JSF:JAVADOC:1853 |
PostAddToViewEvent |
jakarta.faces.event.PostAddToViewEvent.PostAddToViewEvent
( UIComponent ) |
Instantiate a new PostAddToViewEvent that indicates the argument
component was just added to the view. |
true |
|
true |
| JSF:JAVADOC:1854 |
PostAddToViewNonPDLEvent |
jakarta.faces.event.PostAddToViewNonPDLEvent.PostAddToViewNonPDLEvent
( UIComponent ) |
Instantiate a new PostAddToViewNonPDLEvent that indicates the argument
component was just added to the view. This constructor is only
intended to be called to represent events that happen outside of the
restore view phase. |
true |
|
true |
| JSF:JAVADOC:1855 |
Application |
jakarta.faces.event.PostConstructApplicationEvent.getApplication
|
The
source Application that sent this event. |
true |
|
true |
| JSF:JAVADOC:1856 |
PostConstructApplicationEvent |
jakarta.faces.event.PostConstructApplicationEvent.PostConstructApplicationEvent
( Application ) |
Constructs a new AppliationPostConstructEvent for this application. |
true |
|
true |
| JSF:JAVADOC:1857 |
ScopeContext |
jakarta.faces.event.PostConstructCustomScopeEvent.getContext
|
Return
the ScopeContext for this event. |
true |
|
true |
| JSF:JAVADOC:1858 |
PostConstructCustomScopeEvent |
jakarta.faces.event.PostConstructCustomScopeEvent.PostConstructCustomScopeEvent
( ScopeContext ) |
An
instance of this event indicates that the custom scope enclosed within
the argument scopeContext was just created. |
true |
|
true |
| JSF:JAVADOC:1859 |
PostConstructViewMapEvent |
jakarta.faces.event.PostConstructViewMapEvent.PostConstructViewMapEvent
( UIViewRoot ) |
Instantiate a new PostConstructViewMapEvent that indicates the
argument root was just associated with its view map. |
true |
|
true |
| JSF:JAVADOC:1860 |
PostRestoreStateEvent |
jakarta.faces.event.PostRestoreStateEvent.PostRestoreStateEvent
( UIComponent ) |
Instantiate a new PostRestoreStateEvent that indicates the argument
component just had its state restored. |
true |
|
true |
| JSF:JAVADOC:1861 |
void |
jakarta.faces.event.PostRestoreStateEvent.setComponent
( UIComponent ) |
|
true |
|
true |
| JSF:JAVADOC:1862 |
PostValidateEvent |
jakarta.faces.event.PostValidateEvent.PostValidateEvent
( UIComponent ) |
|
true |
|
true |
| JSF:JAVADOC:1863 |
Application |
jakarta.faces.event.PreDestroyApplicationEvent.getApplication
|
The
source Application that sent this event. |
true |
|
true |
| JSF:JAVADOC:1864 |
PreDestroyApplicationEvent |
jakarta.faces.event.PreDestroyApplicationEvent.PreDestroyApplicationEvent
( Application ) |
Constructs a new PreDestroyApplicationEvent for this application. |
true |
|
true |
| JSF:JAVADOC:1865 |
ScopeContext |
jakarta.faces.event.PreDestroyCustomScopeEvent.getContext
|
Return
the ScopeContext for this event. |
true |
|
true |
| JSF:JAVADOC:1866 |
PreDestroyCustomScopeEvent |
jakarta.faces.event.PreDestroyCustomScopeEvent.PreDestroyCustomScopeEvent
( ScopeContext ) |
An
instance of this event indicates that the custom scope enclosed within
the argument scopeContext is about to end. |
true |
|
true |
| JSF:JAVADOC:1867 |
PreDestroyViewMapEvent |
jakarta.faces.event.PreDestroyViewMapEvent.PreDestroyViewMapEvent
( UIViewRoot ) |
Instantiate a new ViewMapDestroydEvent that indicates the argument
root just had its associated view map destroyed. |
true |
|
true |
| JSF:JAVADOC:1868 |
boolean |
jakarta.faces.event.PreRemoveFromViewEvent.isAppropriateListener
( FacesListener ) |
Returns
true if and only if the argument listener is an instance of
SystemEventListener. |
true |
|
true |
| JSF:JAVADOC:1869 |
PreRemoveFromViewEvent |
jakarta.faces.event.PreRemoveFromViewEvent.PreRemoveFromViewEvent
( UIComponent ) |
Instantiate a new BeforeRemoveFromView that indicates the argument
component is about to be removed from the view. |
true |
|
true |
| JSF:JAVADOC:1870 |
PreRenderComponentEvent |
jakarta.faces.event.PreRenderComponentEvent.PreRenderComponentEvent
( UIComponent ) |
Instantiate a new PreRenderComponentEvent that indicates the argument
component is about to be rendered. |
true |
|
true |
| JSF:JAVADOC:1871 |
PreRenderViewEvent |
jakarta.faces.event.PreRenderViewEvent.PreRenderViewEvent
( UIViewRoot ) |
Instantiate a new PreRenderViewEvent that indicates the argument root
is about to be rendered. |
true |
|
true |
| JSF:JAVADOC:1872 |
PreValidateEvent |
jakarta.faces.event.PreValidateEvent.PreValidateEvent
( UIComponent ) |
|
true |
|
true |
| JSF:JAVADOC:1873 |
Map |
jakarta.faces.event.ScopeContext.getScope
|
Return
the scope itself, exposed as a Map. |
true |
|
true |
| JSF:JAVADOC:1874 |
String |
jakarta.faces.event.ScopeContext.getScopeName
|
Return
the name of this custom scope. |
true |
|
true |
| JSF:JAVADOC:1875 |
ScopeContext |
jakarta.faces.event.ScopeContext.ScopeContext
( String ,
Map ) |
Construct this structure with the supplied arguments. |
true |
|
true |
| JSF:JAVADOC:1876 |
boolean |
jakarta.faces.event.SystemEvent.isAppropriateListener
( FacesListener ) |
Return
true if this FacesListener is an instance of a the appropriate
listener class that this event supports. |
true |
|
true |
| JSF:JAVADOC:1877 |
void |
jakarta.faces.event.SystemEvent.processListener
( FacesListener ) |
Broadcast this event instance to the specified FacesListener, by
whatever mechanism is appropriate. Typically, this will be
accomplished by calling an event processing method, and passing this
instance as a paramter. |
true |
|
true |
| JSF:JAVADOC:1878 |
void |
jakarta.faces.event.SystemEvent.processListener
( FacesListener )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1879 |
SystemEvent |
jakarta.faces.event.SystemEvent.SystemEvent
( Object ) |
Pass
the argument source to the superclass constructor. |
true |
|
true |
| JSF:JAVADOC:1880 |
boolean |
jakarta.faces.event.SystemEventListener.isListenerForSource
( Object ) |
This
method must return true if and only if this listener instance is
interested in receiving events from the instance referenced by the
source parameter. |
true |
|
true |
| JSF:JAVADOC:1881 |
void |
jakarta.faces.event.SystemEventListener.processEvent
( SystemEvent ) |
When
called, the listener can assume that any guarantees given in the
javadoc for the specific SystemEvent subclass are true. |
true |
|
true |
| JSF:JAVADOC:1882 |
void |
jakarta.faces.event.SystemEventListener.processEvent
( SystemEvent )
throws AbortProcessingException
|
if
lifecycle processing should cease for this request. |
true |
|
true |
| JSF:JAVADOC:1883 |
List |
jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass
( Class ) |
Return
a List of SystemEventListener instances that have been installed into
the class implementing this interface. |
true |
|
true |
| JSF:JAVADOC:1884 |
Object |
jakarta.faces.event.ValueChangeEvent.getNewValue
|
Return
the current local value of the source UIComponent. |
true |
|
true |
| JSF:JAVADOC:1885 |
Object |
jakarta.faces.event.ValueChangeEvent.getOldValue
|
Return
the previous local value of the source UIComponent. |
true |
|
true |
| JSF:JAVADOC:1886 |
boolean |
jakarta.faces.event.ValueChangeEvent.isAppropriateListener
( FacesListener ) |
Return
true if this FacesListener is an instance of a listener class that
this event supports. Typically, this will be accomplished by an
"instanceof" check on the listener class. |
true |
|
true |
| JSF:JAVADOC:1887 |
void |
jakarta.faces.event.ValueChangeEvent.processListener
( FacesListener ) |
Broadcast this FacesEvent to the specified FacesListener, by whatever
mechanism is appropriate. Typically, this will be accomplished by
calling an event processing method, and passing this FacesEvent as a
paramter. |
true |
|
true |
| JSF:JAVADOC:1888 |
void |
jakarta.faces.event.ValueChangeEvent.processListener
( FacesListener )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1889 |
ValueChangeEvent |
jakarta.faces.event.ValueChangeEvent.ValueChangeEvent
( UIComponent ,
Object ,
Object ) |
Construct a new event object from the specified source component, old
value, and new value. The default PhaseId for this event is
PhaseId#ANY_PHASE. |
true |
|
true |
| JSF:JAVADOC:1890 |
void |
jakarta.faces.event.ValueChangeListener.processValueChange
( ValueChangeEvent ) |
Invoked
when the value change described by the specified ValueChangeEvent
occurs. |
true |
|
true |
| JSF:JAVADOC:1891 |
void |
jakarta.faces.event.ValueChangeListener.processValueChange
( ValueChangeEvent )
throws AbortProcessingException
|
Signal
the Jakarta Server Faces implementation that no further processing on the
current event should be performed |
true |
|
true |
| JSF:JAVADOC:1892 |
void |
jakarta.faces.lifecycle.Lifecycle.addPhaseListener
( PhaseListener ) |
Register a new PhaseListener instance that is interested in being
notified before and after the processing for standard phases of the
request processing lifecycle. |
true |
|
true |
| JSF:JAVADOC:1893 |
void |
jakarta.faces.lifecycle.Lifecycle.addPhaseListener
( PhaseListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:1894 |
void |
jakarta.faces.lifecycle.Lifecycle.execute
( FacesContext ) |
Execute
all of the phases of the request processing lifecycle, up to but not
including the Render Response phase, as described in the Jakarta Server
Faces Specification, in the specified order. The processing flow can
be affected (by the application, by components, or by event listeners)
by calls to the renderResponse() or responseComplete() methods of the
FacesContext instance associated with the current request. |
true |
|
true |
| JSF:JAVADOC:1895 |
void |
jakarta.faces.lifecycle.Lifecycle.execute
( FacesContext )
throws FacesException
|
if
thrown during the execution of the request processing lifecycle |
true |
|
true |
| JSF:JAVADOC:1896 |
void |
jakarta.faces.lifecycle.Lifecycle.execute
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:1897 |
PhaseListener[] |
jakarta.faces.lifecycle.Lifecycle.getPhaseListeners
|
Return
the set of registered PhaseListeners for this Lifecycle instance. If
there are no registered listeners, a zero-length array is returned. |
true |
|
true |
| JSF:JAVADOC:1898 |
Lifecycle |
jakarta.faces.lifecycle.Lifecycle.Lifecycle
|
|
true |
|
true |
| JSF:JAVADOC:1899 |
void |
jakarta.faces.lifecycle.Lifecycle.removePhaseListener
( PhaseListener ) |
Deregister an existing PhaseListener instance that is no longer
interested in being notified before and after the processing for
standard phases of the request processing lifecycle. If no such
listener instance has been registered, no action is taken. |
true |
|
true |
| JSF:JAVADOC:1900 |
void |
jakarta.faces.lifecycle.Lifecycle.removePhaseListener
( PhaseListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:1901 |
void |
jakarta.faces.lifecycle.Lifecycle.render
( FacesContext ) |
Execute
the Render Response phase of the request processing lifecycle, unless
the responseComplete() method has been called on the FacesContext
instance associated with the current request. |
true |
|
true |
| JSF:JAVADOC:1902 |
void |
jakarta.faces.lifecycle.Lifecycle.render
( FacesContext )
throws FacesException
|
if an
exception is thrown during the execution of the request processing
lifecycle |
true |
|
true |
| JSF:JAVADOC:1903 |
void |
jakarta.faces.lifecycle.Lifecycle.render
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:1904 |
void |
jakarta.faces.lifecycle.LifecycleFactory.addLifecycle
( String ,
Lifecycle ) |
Register a new Lifecycle instance, associated with the specified
lifecycleId, to be supported by this LifecycleFactory. This method may
be called at any time, and makes the corresponding Lifecycle instance
available throughout the remaining lifetime of this web application. |
true |
|
true |
| JSF:JAVADOC:1905 |
void |
jakarta.faces.lifecycle.LifecycleFactory.addLifecycle
( String ,
Lifecycle )
throws IllegalArgumentException
|
if a
Lifecycle with the specified lifecycleId has already been registered |
true |
|
true |
| JSF:JAVADOC:1906 |
void |
jakarta.faces.lifecycle.LifecycleFactory.addLifecycle
( String ,
Lifecycle )
throws NullPointerException
|
if
lifecycleId or lifecycle is null |
true |
|
true |
| JSF:JAVADOC:1907 |
Lifecycle |
jakarta.faces.lifecycle.LifecycleFactory.getLifecycle
( String ) |
Create
(if needed) and return a Lifecycle instance for the specified
lifecycle identifier. The set of available lifecycle identifiers is
available via the getLifecycleIds() method. Each call to
getLifecycle() for the same lifecycleId, from within the same web
application, must return the same Lifecycle instance. |
true |
|
true |
| JSF:JAVADOC:1908 |
Lifecycle |
jakarta.faces.lifecycle.LifecycleFactory.getLifecycle
( String )
throws IllegalArgumentException
|
if no
Lifecycle instance can be returned for the specified identifier |
true |
|
true |
| JSF:JAVADOC:1909 |
Lifecycle |
jakarta.faces.lifecycle.LifecycleFactory.getLifecycle
( String )
throws NullPointerException
|
if
lifecycleId is null |
true |
|
true |
| JSF:JAVADOC:1910 |
Iterator |
jakarta.faces.lifecycle.LifecycleFactory.getLifecycleIds
|
Return
an Iterator over the set of lifecycle identifiers supported by this
factory. This set must include the value specified by
LifecycleFactory.DEFAULT_LIFECYCLE. |
true |
|
true |
| JSF:JAVADOC:1911 |
LifecycleFactory |
jakarta.faces.lifecycle.LifecycleFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:1912 |
LifecycleFactory |
jakarta.faces.lifecycle.LifecycleFactory.LifecycleFactory
|
|
true |
|
true |
| JSF:JAVADOC:1913 |
ArrayDataModel |
jakarta.faces.model.ArrayDataModel.ArrayDataModel
|
Construct a new ArrayDataModel with no specified wrapped data. |
true |
|
true |
| JSF:JAVADOC:1914 |
ArrayDataModel |
jakarta.faces.model.ArrayDataModel.ArrayDataModel
( Object[] ) |
Construct a new ArrayDataModel wrapping the specified array. |
true |
|
true |
| JSF:JAVADOC:1915 |
int |
jakarta.faces.model.ArrayDataModel.getRowCount
|
If
there is wrappedData available, return the length of the array. If no
wrappedData is available, return -1. |
true |
|
true |
| JSF:JAVADOC:1916 |
int |
jakarta.faces.model.ArrayDataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:1917 |
Object |
jakarta.faces.model.ArrayDataModel.getRowData
|
If row
data is available, return the array element at the index specified by
rowIndex. If no wrapped data is available, return null. |
true |
|
true |
| JSF:JAVADOC:1918 |
Object |
jakarta.faces.model.ArrayDataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:1919 |
Object |
jakarta.faces.model.ArrayDataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:1920 |
int |
jakarta.faces.model.ArrayDataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1921 |
int |
jakarta.faces.model.ArrayDataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:1922 |
Object |
jakarta.faces.model.ArrayDataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:1923 |
boolean |
jakarta.faces.model.ArrayDataModel.isRowAvailable
|
Return
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. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1924 |
boolean |
jakarta.faces.model.ArrayDataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:1925 |
void |
jakarta.faces.model.ArrayDataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:1926 |
void |
jakarta.faces.model.ArrayDataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:1927 |
void |
jakarta.faces.model.ArrayDataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:1928 |
void |
jakarta.faces.model.ArrayDataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:1929 |
void |
jakarta.faces.model.ArrayDataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:1930 |
void |
jakarta.faces.model.DataModel.addDataModelListener
( DataModelListener ) |
Add a
new DataModelListener to the set interested in notifications from this
DataModel. |
true |
|
true |
| JSF:JAVADOC:1931 |
void |
jakarta.faces.model.DataModel.addDataModelListener
( DataModelListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:1932 |
DataModel |
jakarta.faces.model.DataModel.DataModel
|
|
true |
|
true |
| JSF:JAVADOC:1933 |
DataModelListener[] |
jakarta.faces.model.DataModel.getDataModelListeners
|
Return
the set of DataModelListeners interested in notifications from this
DataModel. If there are no such listeners, an empty array is returned.
|
true |
|
true |
| JSF:JAVADOC:1934 |
int |
jakarta.faces.model.DataModel.getRowCount
|
Return
the number of rows of data objects represented by this DataModel. If
the number of rows is unknown, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1935 |
int |
jakarta.faces.model.DataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:1936 |
Object |
jakarta.faces.model.DataModel.getRowData
|
Return
an object representing the data for the currenty selected row index.
If no wrappedData is available, return null. |
true |
|
true |
| JSF:JAVADOC:1937 |
Object |
jakarta.faces.model.DataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:1938 |
Object |
jakarta.faces.model.DataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:1939 |
int |
jakarta.faces.model.DataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1940 |
int |
jakarta.faces.model.DataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:1941 |
Object |
jakarta.faces.model.DataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:1942 |
boolean |
jakarta.faces.model.DataModel.isRowAvailable
|
Return
a flag indicating whether there is rowData available at the current
rowIndex. If no wrappedData is available, return false. |
true |
|
true |
| JSF:JAVADOC:1943 |
boolean |
jakarta.faces.model.DataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:1944 |
Iterator |
jakarta.faces.model.DataModel.iterator
|
Return
a read-only Iterator over the row data for this model. |
true |
|
true |
| JSF:JAVADOC:1945 |
void |
jakarta.faces.model.DataModel.removeDataModelListener
( DataModelListener ) |
Remove
an existing DataModelListener from the set interested in notifications
from this DataModel. |
true |
|
true |
| JSF:JAVADOC:1946 |
void |
jakarta.faces.model.DataModel.removeDataModelListener
( DataModelListener )
throws NullPointerException
|
if
listener is null |
true |
|
true |
| JSF:JAVADOC:1947 |
void |
jakarta.faces.model.DataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:1948 |
void |
jakarta.faces.model.DataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:1949 |
void |
jakarta.faces.model.DataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:1950 |
void |
jakarta.faces.model.DataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:1951 |
void |
jakarta.faces.model.DataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:1952 |
DataModelEvent |
jakarta.faces.model.DataModelEvent.DataModelEvent
( DataModel ,
int ,
Object ) |
Construct an event object that is associated with the specified row
index and associated data. |
true |
|
true |
| JSF:JAVADOC:1953 |
DataModel |
jakarta.faces.model.DataModelEvent.getDataModel
|
Return
the DataModel that fired this event. |
true |
|
true |
| JSF:JAVADOC:1954 |
Object |
jakarta.faces.model.DataModelEvent.getRowData
|
Return
the object representing the data for the specified row index, or null
for no associated row data. |
true |
|
true |
| JSF:JAVADOC:1955 |
int |
jakarta.faces.model.DataModelEvent.getRowIndex
|
Return
the row index for this event, or -1 for no specific row. |
true |
|
true |
| JSF:JAVADOC:1956 |
void |
jakarta.faces.model.DataModelListener.rowSelected
( DataModelEvent ) |
Notification that a particular row index, with the associated row
data, has been selected for processing. |
true |
|
true |
| JSF:JAVADOC:1957 |
int |
jakarta.faces.model.ListDataModel.getRowCount
|
If
there is wrappedData available, return the length of the list. If no
wrappedData is available, return -1. |
true |
|
true |
| JSF:JAVADOC:1958 |
int |
jakarta.faces.model.ListDataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:1959 |
Object |
jakarta.faces.model.ListDataModel.getRowData
|
If row
data is available, return the array element at the index specified by
rowIndex. If no wrapped data is available, return null. |
true |
|
true |
| JSF:JAVADOC:1960 |
Object |
jakarta.faces.model.ListDataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:1961 |
Object |
jakarta.faces.model.ListDataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:1962 |
int |
jakarta.faces.model.ListDataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1963 |
int |
jakarta.faces.model.ListDataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:1964 |
Object |
jakarta.faces.model.ListDataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:1965 |
boolean |
jakarta.faces.model.ListDataModel.isRowAvailable
|
Return
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. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1966 |
boolean |
jakarta.faces.model.ListDataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:1967 |
ListDataModel |
jakarta.faces.model.ListDataModel.ListDataModel
|
Construct a new ListDataModel with no specified wrapped data. |
true |
|
true |
| JSF:JAVADOC:1968 |
ListDataModel |
jakarta.faces.model.ListDataModel.ListDataModel
( List ) |
Construct a new ListDataModel wrapping the specified list. |
true |
|
true |
| JSF:JAVADOC:1969 |
void |
jakarta.faces.model.ListDataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:1970 |
void |
jakarta.faces.model.ListDataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:1971 |
void |
jakarta.faces.model.ListDataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:1972 |
void |
jakarta.faces.model.ListDataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:1973 |
void |
jakarta.faces.model.ListDataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:1974 |
int |
jakarta.faces.model.ResultDataModel.getRowCount
|
If
there is wrappedData available, return the length of the array
returned by calling getRows() on the underlying Result. If no
wrappedData is available, return -1. |
true |
|
true |
| JSF:JAVADOC:1975 |
int |
jakarta.faces.model.ResultDataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:1976 |
SortedMap |
jakarta.faces.model.ResultDataModel.getRowData
|
If row
data is available, return the SortedMap array element at the index
specified by rowIndex of the array returned by calling getRows() on
the underlying Result. If no wrapped data is available, return null.
Note that, if a non-null Map is returned by this method, it will
contain the values of the columns for the current row, keyed by column
name. Column name comparisons must be performed in a case-insensitive
manner. |
true |
|
true |
| JSF:JAVADOC:1977 |
SortedMap |
jakarta.faces.model.ResultDataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:1978 |
SortedMap |
jakarta.faces.model.ResultDataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:1979 |
int |
jakarta.faces.model.ResultDataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1980 |
int |
jakarta.faces.model.ResultDataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:1981 |
Object |
jakarta.faces.model.ResultDataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:1982 |
boolean |
jakarta.faces.model.ResultDataModel.isRowAvailable
|
Return
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.
Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:1983 |
boolean |
jakarta.faces.model.ResultDataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:1984 |
ResultDataModel |
jakarta.faces.model.ResultDataModel.ResultDataModel
|
Construct a new ResultDataModel with no specified wrapped data. |
true |
|
true |
| JSF:JAVADOC:1985 |
ResultDataModel |
jakarta.faces.model.ResultDataModel.ResultDataModel
( Result ) |
Construct a new ResultDataModel wrapping the specified Result. |
true |
|
true |
| JSF:JAVADOC:1986 |
void |
jakarta.faces.model.ResultDataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:1987 |
void |
jakarta.faces.model.ResultDataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:1988 |
void |
jakarta.faces.model.ResultDataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:1989 |
void |
jakarta.faces.model.ResultDataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:1990 |
void |
jakarta.faces.model.ResultDataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:1991 |
int |
jakarta.faces.model.ResultSetDataModel.getRowCount
|
Return
-1, since 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. |
true |
|
true |
| JSF:JAVADOC:1992 |
int |
jakarta.faces.model.ResultSetDataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:1993 |
Map |
jakarta.faces.model.ResultSetDataModel.getRowData
|
If row
data is available, return a Map representing the values of the columns
for the row specified by rowIndex, keyed by the corresponding column
names. If no wrapped data is available, return null. If a non-null Map
is returned, its behavior must correspond to the contract for a
mutable Map as described in the JavaDocs for AbstractMap, with the
following exceptions and specialized behavior: The Map, and any
supporting objects it returns, must perform all column name
comparisons in a case-insensitive manner. This case-insensitivity must
be implemented using a case-insensitive Comparator, such as
String.CASE_INSENSITIVE_ORDER. The following methods must throw
UnsupportedOperationException: clear(), remove(). The entrySet()
method must return a Set that has the following behavior: Throw
UnsupportedOperationException for any attempt to add or remove entries
from the Set, either directly or indirectly through an Iterator
returned by the Set. Updates to the value of an entry in this set must
write through to the corresponding column value in the underlying
ResultSet. The keySet() method must return a Set that throws
UnsupportedOperationException on any attempt to add or remove keys,
either directly or through an Iterator returned by the Set. The put()
method must throw IllegalArgumentException if a key value for which
containsKey() returns false is specified. However, if a key already
present in the Map is specified, the specified value must write
through to the corresponding column value in the underlying ResultSet.
The values() method must return a Collection that throws
UnsupportedOperationException on any attempt to add or remove values,
either directly or through an Iterator returned by the Collection. |
true |
|
true |
| JSF:JAVADOC:1994 |
Map |
jakarta.faces.model.ResultSetDataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:1995 |
Map |
jakarta.faces.model.ResultSetDataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:1996 |
int |
jakarta.faces.model.ResultSetDataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:1997 |
int |
jakarta.faces.model.ResultSetDataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:1998 |
Object |
jakarta.faces.model.ResultSetDataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:1999 |
boolean |
jakarta.faces.model.ResultSetDataModel.isRowAvailable
|
Return
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. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:2000 |
boolean |
jakarta.faces.model.ResultSetDataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:2001 |
ResultSetDataModel |
jakarta.faces.model.ResultSetDataModel.ResultSetDataModel
|
Construct a new ResultSetDataModel with no specified wrapped data. |
true |
|
true |
| JSF:JAVADOC:2002 |
ResultSetDataModel |
jakarta.faces.model.ResultSetDataModel.ResultSetDataModel
( ResultSet ) |
Construct a new ResultSetDataModel wrapping the specified ResultSet. |
true |
|
true |
| JSF:JAVADOC:2003 |
void |
jakarta.faces.model.ResultSetDataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:2004 |
void |
jakarta.faces.model.ResultSetDataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:2005 |
void |
jakarta.faces.model.ResultSetDataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:2006 |
void |
jakarta.faces.model.ResultSetDataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:2007 |
void |
jakarta.faces.model.ResultSetDataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:2008 |
int |
jakarta.faces.model.ScalarDataModel.getRowCount
|
If
there is wrappedData available, return 1. If no wrappedData is
available, return -1. |
true |
|
true |
| JSF:JAVADOC:2009 |
int |
jakarta.faces.model.ScalarDataModel.getRowCount
throws FacesException
|
if an
error occurs getting the row count |
true |
|
true |
| JSF:JAVADOC:2010 |
Object |
jakarta.faces.model.ScalarDataModel.getRowData
|
If
wrapped data is available, return the wrapped data instance.
Otherwise, return null. |
true |
|
true |
| JSF:JAVADOC:2011 |
Object |
jakarta.faces.model.ScalarDataModel.getRowData
throws FacesException
|
if an
error occurs getting the row data |
true |
|
true |
| JSF:JAVADOC:2012 |
Object |
jakarta.faces.model.ScalarDataModel.getRowData
throws IllegalArgumentException
|
if now
row data is available at the currently specified row index |
true |
|
true |
| JSF:JAVADOC:2013 |
int |
jakarta.faces.model.ScalarDataModel.getRowIndex
|
Return
the zero-relative index of the currently selected row. If we are not
currently positioned on a row, or no wrappedData is available, return
-1. |
true |
|
true |
| JSF:JAVADOC:2014 |
int |
jakarta.faces.model.ScalarDataModel.getRowIndex
throws FacesException
|
if an
error occurs getting the row index |
true |
|
true |
| JSF:JAVADOC:2015 |
Object |
jakarta.faces.model.ScalarDataModel.getWrappedData
|
Return
the object representing the data wrapped by this DataModel, if any. |
true |
|
true |
| JSF:JAVADOC:2016 |
boolean |
jakarta.faces.model.ScalarDataModel.isRowAvailable
|
Return
true if there is wrappedData available, and the current value of
rowIndex is zero. Otherwise, return false. |
true |
|
true |
| JSF:JAVADOC:2017 |
boolean |
jakarta.faces.model.ScalarDataModel.isRowAvailable
throws FacesException
|
if an
error occurs getting the row availability |
true |
|
true |
| JSF:JAVADOC:2018 |
ScalarDataModel |
jakarta.faces.model.ScalarDataModel.ScalarDataModel
|
Construct a new ScalarDataModel with no specified wrapped data. |
true |
|
true |
| JSF:JAVADOC:2019 |
ScalarDataModel |
jakarta.faces.model.ScalarDataModel.ScalarDataModel
( Object ) |
Construct a new ScalarDataModel wrapping the specified scalar object.
|
true |
|
true |
| JSF:JAVADOC:2020 |
void |
jakarta.faces.model.ScalarDataModel.setRowIndex
( int ) |
Set the
zero-relative index of the currently selected row, or -1 to indicate
that we are not positioned on a row. It is possible to set the row
index at a value for which the underlying data collection does not
contain any row data. Therefore, callers may use the isRowAvailable()
method to detect whether row data will be available for use by the
getRowData() method. If there is no wrappedData available when this
method is called, the specified rowIndex is stored (and may be
retrieved by a subsequent call to getRowData()), but no event is sent.
Otherwise, if the currently selected row index is changed by this
call, a DataModelEvent will be sent to the rowSelected() method of all
registered DataModelListeners. |
true |
|
true |
| JSF:JAVADOC:2021 |
void |
jakarta.faces.model.ScalarDataModel.setRowIndex
( int )
throws FacesException
|
if an
error occurs setting the row index |
true |
|
true |
| JSF:JAVADOC:2022 |
void |
jakarta.faces.model.ScalarDataModel.setRowIndex
( int )
throws IllegalArgumentException
|
if
rowIndex is less than -1 |
true |
|
true |
| JSF:JAVADOC:2023 |
void |
jakarta.faces.model.ScalarDataModel.setWrappedData
( Object ) |
Set the
object representing the data collection wrapped by this DataModel. If
the specified data is null, detach this DataModel from any previously
wrapped data collection instead. If data is non-null, the currently
selected row index must be set to zero, and a DataModelEvent must be
sent to the rowSelected() method of all registered DataModelListeners
indicating that this row is now selected. |
true |
|
true |
| JSF:JAVADOC:2024 |
void |
jakarta.faces.model.ScalarDataModel.setWrappedData
( Object )
throws ClassCastException
|
if data
is not of the appropriate type for this DataModel implementation |
true |
|
true |
| JSF:JAVADOC:2025 |
String |
jakarta.faces.model.SelectItem.getDescription
|
Return
a description of this item, for use in development tools. |
true |
|
true |
| JSF:JAVADOC:2026 |
String |
jakarta.faces.model.SelectItem.getLabel
|
Return
the label of this item, to be rendered visibly for the user. |
true |
|
true |
| JSF:JAVADOC:2027 |
Object |
jakarta.faces.model.SelectItem.getValue
|
Return
the value of this item, to be delivered to the model if this item is
selected by the user. |
true |
|
true |
| JSF:JAVADOC:2028 |
boolean |
jakarta.faces.model.SelectItem.isDisabled
|
Return
the disabled flag for this item, which should modify the rendered
output to make this item unavailable for selection by the user if set
to true. |
true |
|
true |
| JSF:JAVADOC:2029 |
boolean |
jakarta.faces.model.SelectItem.isEscape
|
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. |
true |
|
true |
| JSF:JAVADOC:2030 |
boolean |
jakarta.faces.model.SelectItem.isNoSelectionOption
|
Return
the value of the noSelectionOption property. If the value of this
property is true, the system interprets the option represented by this
SelectItem instance as representing a "no selection" option. See
UISelectOne#validateValue and UISelectMany#validateValue for usage. |
true |
|
true |
| JSF:JAVADOC:2031 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
|
Construct a SelectItem with no initialized property values. |
true |
|
true |
| JSF:JAVADOC:2032 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ) |
Construct a SelectItem with the specified value. The label property
will be set to the value (converted to a String, if necessary), the
description property will be set to null, the disabled property will
be set to false, and the escape property will be set to ( true. |
true |
|
true |
| JSF:JAVADOC:2033 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ,
String ) |
Construct a SelectItem with the specified value and label. The
description property will be set to null, the disabled property will
be set to false, and the escape property will be set to true. |
true |
|
true |
| JSF:JAVADOC:2034 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ,
String ,
String ) |
Construct a SelectItem instance with the specified value, label and
description. This disabled property will be set to false, and the
escape property will be set to true. |
true |
|
true |
| JSF:JAVADOC:2035 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ,
String ,
String ,
boolean ) |
Construct a SelectItem instance with the specified property values.
The escape property will be set to true. |
true |
|
true |
| JSF:JAVADOC:2036 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ,
String ,
String ,
boolean ,
boolean ) |
Construct a SelectItem instance with the specified property values. |
true |
|
true |
| JSF:JAVADOC:2037 |
SelectItem |
jakarta.faces.model.SelectItem.SelectItem
( Object ,
String ,
String ,
boolean ,
boolean ,
boolean ) |
Construct a SelectItem instance with the specified property values. |
true |
|
true |
| JSF:JAVADOC:2038 |
void |
jakarta.faces.model.SelectItem.setDescription
( String ) |
Set the
description of this item, for use in development tools. |
true |
|
true |
| JSF:JAVADOC:2039 |
void |
jakarta.faces.model.SelectItem.setDisabled
( boolean ) |
Set the
disabled flag for this item, which should modify the rendered output
to make this item unavailable for selection by the user if set to
true. |
true |
|
true |
| JSF:JAVADOC:2040 |
void |
jakarta.faces.model.SelectItem.setEscape
( boolean ) |
Set the
value of the escape property. See #isEscape. |
true |
|
true |
| JSF:JAVADOC:2041 |
void |
jakarta.faces.model.SelectItem.setLabel
( String ) |
Set the
label of this item, to be rendered visibly for the user. |
true |
|
true |
| JSF:JAVADOC:2042 |
void |
jakarta.faces.model.SelectItem.setNoSelectionOption
( boolean ) |
Set the
value of the noSelectionOption property. |
true |
|
true |
| JSF:JAVADOC:2043 |
void |
jakarta.faces.model.SelectItem.setValue
( Object ) |
Set the
value of this item, to be delivered to the model if this item is
selected by this user. |
true |
|
true |
| JSF:JAVADOC:2044 |
SelectItem[] |
jakarta.faces.model.SelectItemGroup.getSelectItems
|
Return
the set of subordinate SelectItems for this group. |
true |
|
true |
| JSF:JAVADOC:2045 |
SelectItemGroup |
jakarta.faces.model.SelectItemGroup.SelectItemGroup
|
Construct a SelectItemGroup with no initialized property values. |
true |
|
true |
| JSF:JAVADOC:2046 |
SelectItemGroup |
jakarta.faces.model.SelectItemGroup.SelectItemGroup
( String ) |
Construct a SelectItemGroup with the specified label and no associated
selectItems. The value property will be set to a zero-length String,
the description property will be set to null, and the disabled
property will be set to false. |
true |
|
true |
| JSF:JAVADOC:2047 |
SelectItemGroup |
jakarta.faces.model.SelectItemGroup.SelectItemGroup
( String ,
String ,
boolean ,
SelectItem[] ) |
Construct a SelectItemGroup with the specified properties. The value
property will be set to a zero-length String. |
true |
|
true |
| JSF:JAVADOC:2048 |
void |
jakarta.faces.model.SelectItemGroup.setSelectItems
( SelectItem[] ) |
Set the
set of subordinate SelectItems for this group. |
true |
|
true |
| JSF:JAVADOC:2049 |
void |
jakarta.faces.model.SelectItemGroup.setSelectItems
( SelectItem[] )
throws NullPointerException
|
if
selectItems is null |
true |
|
true |
| JSF:JAVADOC:2050 |
ClientBehaviorRenderer |
jakarta.faces.render.ClientBehaviorRenderer.ClientBehaviorRenderer
|
|
true |
|
true |
| JSF:JAVADOC:2051 |
void |
jakarta.faces.render.ClientBehaviorRenderer.decode
( FacesContext ,
UIComponent ,
ClientBehavior ) |
Decode
any new state of this ClientBehavior from the request contained in the
specified FacesContext. During decoding, events may be enqueued for
later processing (by event listeners who have registered an interest),
by calling queueEvent(). |
true |
|
true |
| JSF:JAVADOC:2052 |
void |
jakarta.faces.render.ClientBehaviorRenderer.decode
( FacesContext ,
UIComponent ,
ClientBehavior )
throws NullPointerException
|
if
context, component behavior is null |
true |
|
true |
| JSF:JAVADOC:2053 |
String |
jakarta.faces.render.ClientBehaviorRenderer.getScript
( ClientBehaviorContext ,
ClientBehavior ) |
Return
the script that implements this ClientBehavior's client-side logic.
The default implementation returns null.
ClientBehaviorRenderer.getScript() implementations are allowed to
return null to indicate that no script is required for this particular
getScript() call. For example, a ClientBehaviorRenderer implementation
may return null if the associated ClientBehavior is disabled. |
true |
|
true |
| JSF:JAVADOC:2054 |
String |
jakarta.faces.render.FacesBehaviorRenderer.rendererType
|
|
true |
|
true |
| JSF:JAVADOC:2055 |
String |
jakarta.faces.render.FacesBehaviorRenderer.renderKitId
|
The
value of this annotation attribute is taken to be the render-kit-id in
which an instance of this class of Renderer must be installed. |
true |
|
true |
| JSF:JAVADOC:2056 |
String |
jakarta.faces.render.FacesRenderer.componentFamily
|
The
value of this annotation attribute is taken to be the component-family
which, in combination with #rendererType can be used to obtain a
reference to an instance of this Renderer by calling
jakarta.faces.render.RenderKit#getRenderer(java.lang.String,
java.lang.String). |
true |
|
true |
| JSF:JAVADOC:2057 |
String |
jakarta.faces.render.FacesRenderer.rendererType
|
The
value of this annotation attribute is taken to be the renderer-type
which, in combination with #componentFamily can be used to obtain a
reference to an instance of this Renderer by calling
jakarta.faces.render.RenderKit#getRenderer(java.lang.String,
java.lang.String). |
true |
|
true |
| JSF:JAVADOC:2058 |
String |
jakarta.faces.render.FacesRenderer.renderKitId
|
The
value of this annotation attribute is taken to be the render-kit-id in
which an instance of this class of Renderer must be installed. |
true |
|
true |
| JSF:JAVADOC:2059 |
String |
jakarta.faces.render.Renderer.convertClientId
( FacesContext ,
String ) |
Convert
the component generated client id to a form suitable for transmission
to the client. The default implementation returns the argument
clientId unchanged. |
true |
|
true |
| JSF:JAVADOC:2060 |
String |
jakarta.faces.render.Renderer.convertClientId
( FacesContext ,
String )
throws NullPointerException
|
if
context or clientId is null |
true |
|
true |
| JSF:JAVADOC:2061 |
void |
jakarta.faces.render.Renderer.decode
( FacesContext ,
UIComponent ) |
Decode
any new state of the specified UIComponent from the request contained
in the specified FacesContext, and store that state on the
UIComponent. During decoding, events may be enqueued for later
processing (by event listeners that have registered an interest), by
calling queueEvent() on the associated UIComponent. |
true |
|
true |
| JSF:JAVADOC:2062 |
void |
jakarta.faces.render.Renderer.decode
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2063 |
void |
jakarta.faces.render.Renderer.encodeBegin
( FacesContext ,
UIComponent ) |
Render
the beginning specified UIComponent to the output stream or writer
associated with the response we are creating. If the conversion
attempted in a previous call to getConvertedValue() for this component
failed, the state information saved during execution of decode()
should be used to reproduce the incorrect input. |
true |
|
true |
| JSF:JAVADOC:2064 |
void |
jakarta.faces.render.Renderer.encodeBegin
( FacesContext ,
UIComponent )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:2065 |
void |
jakarta.faces.render.Renderer.encodeBegin
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2066 |
void |
jakarta.faces.render.Renderer.encodeChildren
( FacesContext ,
UIComponent ) |
Render
the child components of this UIComponent, following the rules
described for encodeBegin() to acquire the appropriate value to be
rendered. This method will only be called if the rendersChildren
property of this component is true. |
true |
|
true |
| JSF:JAVADOC:2067 |
void |
jakarta.faces.render.Renderer.encodeChildren
( FacesContext ,
UIComponent )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:2068 |
void |
jakarta.faces.render.Renderer.encodeChildren
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2069 |
void |
jakarta.faces.render.Renderer.encodeEnd
( FacesContext ,
UIComponent ) |
Render
the ending of the current state of the specified UIComponent,
following the rules described for encodeBegin() to acquire the
appropriate value to be rendered. |
true |
|
true |
| JSF:JAVADOC:2070 |
void |
jakarta.faces.render.Renderer.encodeEnd
( FacesContext ,
UIComponent )
throws IOException
|
if an
input/output error occurs while rendering |
true |
|
true |
| JSF:JAVADOC:2071 |
void |
jakarta.faces.render.Renderer.encodeEnd
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2072 |
Object |
jakarta.faces.render.Renderer.getConvertedValue
( FacesContext ,
UIComponent ,
Object ) |
Attempt
to convert previously stored state information into an object of the
type required for this component (optionally using the registered
jakarta.faces.convert.Converter for this component, if there is one). If
conversion is successful, the new value should be returned from this
method; if not, a ConverterException should be thrown. |
true |
|
true |
| JSF:JAVADOC:2073 |
Object |
jakarta.faces.render.Renderer.getConvertedValue
( FacesContext ,
UIComponent ,
Object )
throws ConverterException
|
if the
submitted value cannot be converted successfully. |
true |
|
true |
| JSF:JAVADOC:2074 |
Object |
jakarta.faces.render.Renderer.getConvertedValue
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2075 |
boolean |
jakarta.faces.render.Renderer.getRendersChildren
|
Return
a flag indicating whether this Renderer is responsible for rendering
the children the component it is asked to render. The default
implementation returns false. |
true |
|
true |
| JSF:JAVADOC:2076 |
Renderer |
jakarta.faces.render.Renderer.Renderer
|
|
true |
|
true |
| JSF:JAVADOC:2077 |
void |
jakarta.faces.render.RenderKit.addClientBehaviorRenderer
( String ,
ClientBehaviorRenderer ) |
Register the specified 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. |
true |
|
true |
| JSF:JAVADOC:2078 |
void |
jakarta.faces.render.RenderKit.addClientBehaviorRenderer
( String ,
ClientBehaviorRenderer )
throws NullPointerException
|
if type
or renderer is null |
true |
|
true |
| JSF:JAVADOC:2079 |
void |
jakarta.faces.render.RenderKit.addRenderer
( String ,
String ,
Renderer ) |
Register the specified Renderer instance, associated with the
specified component family and rendererType, to the set of Renderers
registered with this RenderKit, replacing any previously registered
Renderer for this combination of identifiers. |
true |
|
true |
| JSF:JAVADOC:2080 |
void |
jakarta.faces.render.RenderKit.addRenderer
( String ,
String ,
Renderer )
throws NullPointerException
|
if
family or rendererType or renderer is null |
true |
|
true |
| JSF:JAVADOC:2081 |
ResponseStream |
jakarta.faces.render.RenderKit.createResponseStream
( OutputStream ) |
Use the
provided OutputStream to create a new ResponseStream instance. |
true |
|
true |
| JSF:JAVADOC:2082 |
ResponseWriter |
jakarta.faces.render.RenderKit.createResponseWriter
( Writer ,
String ,
String ) |
Use the
provided Writer to create a new ResponseWriter instance for the
specified (optional) content type, and character encoding.
Implementors are advised to consult the getCharacterEncoding() method
of class jakarta.servlet.ServletResponse to get the required value for
the characterEncoding for this method. Since the Writer for this
response will already have been obtained (due to it ultimately being
passed to this method), we know that the character encoding cannot
change during the rendering of the response. |
true |
|
true |
| JSF:JAVADOC:2083 |
ResponseWriter |
jakarta.faces.render.RenderKit.createResponseWriter
( Writer ,
String ,
String )
throws IllegalArgumentException
|
if no
matching content type can be found in contentTypeList, no appropriate
content type can be found with the implementation dependent best fit
algorithm, or no matching character encoding can be found for the
argument characterEncoding. |
true |
|
true |
| JSF:JAVADOC:2084 |
ClientBehaviorRenderer |
jakarta.faces.render.RenderKit.getClientBehaviorRenderer
( String ) |
Return
the ClientBehaviorRenderer instance most recently registered for the
specified type, if any; otherwise, return null. |
true |
|
true |
| JSF:JAVADOC:2085 |
ClientBehaviorRenderer |
jakarta.faces.render.RenderKit.getClientBehaviorRenderer
( String )
throws NullPointerException
|
if type
is null |
true |
|
true |
| JSF:JAVADOC:2086 |
Iterator |
jakarta.faces.render.RenderKit.getClientBehaviorRendererTypes
|
Return
an Iterator over the ClientBehaviorRenderer types. |
true |
|
true |
| JSF:JAVADOC:2087 |
Iterator |
jakarta.faces.render.RenderKit.getComponentFamilies
|
Return
an Iterator over the component-family entries supported by this
RenderKit instance. The default implementation of this method returns
an empty Iterator |
true |
|
true |
| JSF:JAVADOC:2088 |
Renderer |
jakarta.faces.render.RenderKit.getRenderer
( String ,
String ) |
Return
the Renderer instance most recently registered for the specified
component family and rendererType, if any; otherwise, return null. |
true |
|
true |
| JSF:JAVADOC:2089 |
Renderer |
jakarta.faces.render.RenderKit.getRenderer
( String ,
String )
throws NullPointerException
|
if
family or rendererType is null |
true |
|
true |
| JSF:JAVADOC:2090 |
Iterator |
jakarta.faces.render.RenderKit.getRendererTypes
( String ) |
Return
an Iterator over the renderer-type entries for the given
component-family. If the specified componentFamily is not known to
this RenderKit implementation, return an empty Iterator The default
implementation of this method returns an empty Iterator |
true |
|
true |
| JSF:JAVADOC:2091 |
ResponseStateManager |
jakarta.faces.render.RenderKit.getResponseStateManager
|
Return
an instance of ResponseStateManager to handle rendering technology
specific state management decisions. |
true |
|
true |
| JSF:JAVADOC:2092 |
RenderKit |
jakarta.faces.render.RenderKit.RenderKit
|
|
true |
|
true |
| JSF:JAVADOC:2093 |
void |
jakarta.faces.render.RenderKitFactory.addRenderKit
( String ,
RenderKit ) |
Register the specified RenderKit instance, associated with the
specified renderKitId, to be supported by this RenderKitFactory,
replacing any previously registered RenderKit for this identifier. |
true |
|
true |
| JSF:JAVADOC:2094 |
void |
jakarta.faces.render.RenderKitFactory.addRenderKit
( String ,
RenderKit )
throws NullPointerException
|
if
renderKitId or renderKit is null |
true |
|
true |
| JSF:JAVADOC:2095 |
RenderKit |
jakarta.faces.render.RenderKitFactory.getRenderKit
( FacesContext ,
String ) |
Return
a RenderKit instance for the specified render kit identifier, possibly
customized based on dynamic characteristics of the specified
FacesContext, if non-null. If there is no registered RenderKit for the
specified identifier, return null. The set of available render kit
identifiers is available via the getRenderKitIds() method. |
true |
|
true |
| JSF:JAVADOC:2096 |
RenderKit |
jakarta.faces.render.RenderKitFactory.getRenderKit
( FacesContext ,
String )
throws IllegalArgumentException
|
if no
RenderKit instance can be returned for the specified identifier |
true |
|
true |
| JSF:JAVADOC:2097 |
RenderKit |
jakarta.faces.render.RenderKitFactory.getRenderKit
( FacesContext ,
String )
throws NullPointerException
|
if
renderKitId is null |
true |
|
true |
| JSF:JAVADOC:2098 |
Iterator |
jakarta.faces.render.RenderKitFactory.getRenderKitIds
|
Return
an Iterator over the set of render kit identifiers registered with
this factory. This set must include the value specified by
RenderKitFactory.HTML_BASIC_RENDER_KIT. |
true |
|
true |
| JSF:JAVADOC:2099 |
RenderKitFactory |
jakarta.faces.render.RenderKitFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:2100 |
RenderKitFactory |
jakarta.faces.render.RenderKitFactory.RenderKitFactory
|
|
true |
|
true |
| JSF:JAVADOC:2101 |
void |
jakarta.faces.render.RenderKitWrapper.addClientBehaviorRenderer
( String ,
ClientBehaviorRenderer ) |
The
default behavior of this method is to call
RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer) on
the wrapped RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2102 |
void |
jakarta.faces.render.RenderKitWrapper.addRenderer
( String ,
String ,
Renderer ) |
The
default behavior of this method is to call
RenderKit#addRenderer(String, String, Renderer) on the wrapped
RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2103 |
ResponseStream |
jakarta.faces.render.RenderKitWrapper.createResponseStream
( OutputStream ) |
The
default behavior of this method is to call
RenderKit#createResponseStream(java.io.OutputStream) on the wrapped
RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2104 |
ResponseWriter |
jakarta.faces.render.RenderKitWrapper.createResponseWriter
( Writer ,
String ,
String ) |
The
default behavior of this method is to call
RenderKit#createResponseWriter(java.io.Writer, String, String) on the
wrapped RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2105 |
ClientBehaviorRenderer |
jakarta.faces.render.RenderKitWrapper.getClientBehaviorRenderer
( String ) |
The
default behavior of this method is to call
RenderKit#getClientBehaviorRenderer(String) on the wrapped RenderKit
object. |
true |
|
true |
| JSF:JAVADOC:2106 |
Iterator |
jakarta.faces.render.RenderKitWrapper.getClientBehaviorRendererTypes
|
The
default behavior of this method is to call
jakarta.faces.render.RenderKit#getClientBehaviorRendererTypes() on the
wrapped RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2107 |
Iterator |
jakarta.faces.render.RenderKitWrapper.getComponentFamilies
|
The
default behavior of this method is to call
jakarta.faces.render.RenderKit#getComponentFamilies() on the wrapped
RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2108 |
Renderer |
jakarta.faces.render.RenderKitWrapper.getRenderer
( String ,
String ) |
The
default behavior of this method is to call
RenderKit#getRenderer(String, String) on the wrapped RenderKit object.
|
true |
|
true |
| JSF:JAVADOC:2109 |
Iterator |
jakarta.faces.render.RenderKitWrapper.getRendererTypes
( String ) |
The
default behavior of this method is to call
RenderKit#getRendererTypes(String) on the wrapped RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2110 |
ResponseStateManager |
jakarta.faces.render.RenderKitWrapper.getResponseStateManager
|
The
default behavior of this method is to call
jakarta.faces.render.RenderKit#getResponseStateManager() on the wrapped
RenderKit object. |
true |
|
true |
| JSF:JAVADOC:2111 |
RenderKit |
jakarta.faces.render.RenderKitWrapper.getWrapped
|
A class
that implements this interface uses this method to return an instance
of the class being wrapped. |
true |
|
true |
| JSF:JAVADOC:2112 |
RenderKitWrapper |
jakarta.faces.render.RenderKitWrapper.RenderKitWrapper
|
|
true |
|
true |
| JSF:JAVADOC:2113 |
Object |
jakarta.faces.render.ResponseStateManager.getComponentStateToRestore
( FacesContext ) |
The
implementation must inspect the current request and return the
component state Object passed to it on a previous invocation of
writeState(). |
true |
true |
true |
| JSF:JAVADOC:2114 |
Object |
jakarta.faces.render.ResponseStateManager.getState
( FacesContext ,
String ) |
The
implementation must inspect the current request and return an Object
representing the tree structure and component state passed in to a
previous invocation of
#writeState(jakarta.faces.context.FacesContext,java.lang.Object). For
backwards compatability with existing ResponseStateManager
implementations, the default implementation of this method calls
#getTreeStructureToRestore and #getComponentStateToRestore and creates
and returns a two element Object array with element zero containing
the structure property and element one containing the state property
of the SerializedView. |
true |
|
true |
| JSF:JAVADOC:2115 |
Object |
jakarta.faces.render.ResponseStateManager.getTreeStructureToRestore
( FacesContext ,
String ) |
The
implementation must inspect the current request and return the tree
structure Object passed to it on a previous invocation of
writeState(). |
true |
true |
true |
| JSF:JAVADOC:2116 |
String |
jakarta.faces.render.ResponseStateManager.getViewState
( FacesContext ,
Object ) |
Return
the specified state as a String without any markup related to the
rendering technology supported by this ResponseStateManager. |
true |
|
false |
| JSF:JAVADOC:2117 |
boolean |
jakarta.faces.render.ResponseStateManager.isPostback
( FacesContext ) |
Return
true if the current request is a postback. This method is leveraged
from the Restore View Phase to determine if
jakarta.faces.application.ViewHandler#restoreView or
jakarta.faces.application.ViewHandler#createView should be called. The
default implementation must return true if this ResponseStateManager
instance wrote out state on a previous request to which this request
is a postback, false otherwise. The implementation if this method for
the Standard HTML RenderKit must consult the
jakarta.faces.context.ExternalContext's requestParameterMap and return
true if and only if there is a key equal to the value of the symbolic
constant #VIEW_STATE_PARAM. For backwards compatability with
implementations of ResponseStateManager prior to JSF 1.2, a default
implementation is provided that consults the
jakarta.faces.context.ExternalContext's requestParameterMap and return
true if its size is greater than 0. |
true |
|
true |
| JSF:JAVADOC:2118 |
ResponseStateManager |
jakarta.faces.render.ResponseStateManager.ResponseStateManager
|
|
true |
|
true |
| JSF:JAVADOC:2119 |
void |
jakarta.faces.render.ResponseStateManager.writeState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2120 |
void |
jakarta.faces.render.ResponseStateManager.writeState
( FacesContext ,
Object )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2121 |
void |
jakarta.faces.render.ResponseStateManager.writeState
( FacesContext ,
SerializedView ) |
Take
the argument state and write it into the output using the current
ResponseWriter, which must be correctly positioned already. If the
jakarta.faces.application.StateManager.SerializedView is to be written
out to hidden fields, the implementation must take care to make all
necessary character replacements to make the Strings suitable for
inclusion as an HTTP request paramater. If the state saving method for
this application is
jakarta.faces.application.StateManager#STATE_SAVING_METHOD_CLIENT, the
implementation may encrypt the state to be saved to the client. We
recommend that the state be unreadable by the client, and also be
tamper evident. The reference implementation follows these
recommendations. |
true |
true |
true |
| JSF:JAVADOC:2122 |
void |
jakarta.faces.render.ResponseStateManager.writeState
( FacesContext ,
SerializedView )
throws IOException
|
|
true |
true |
true |
| JSF:JAVADOC:2123 |
BeanValidator |
jakarta.faces.validator.BeanValidator.BeanValidator
|
|
true |
|
true |
| JSF:JAVADOC:2124 |
void |
jakarta.faces.validator.BeanValidator.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:2125 |
String |
jakarta.faces.validator.BeanValidator.getValidationGroups
|
Return
the validation groups passed to the Validation API when checking
constraints. If the validationGroupsArray attribute is omitted or
empty, the validation groups will be inherited from the branch
defaults, or if there are no branch defaults, the
jakarta.validation.groups.Default group will be used. |
true |
|
true |
| JSF:JAVADOC:2126 |
boolean |
jakarta.faces.validator.BeanValidator.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:2127 |
boolean |
jakarta.faces.validator.BeanValidator.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:2128 |
void |
jakarta.faces.validator.BeanValidator.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:2129 |
void |
jakarta.faces.validator.BeanValidator.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2130 |
Object |
jakarta.faces.validator.BeanValidator.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:2131 |
void |
jakarta.faces.validator.BeanValidator.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:2132 |
void |
jakarta.faces.validator.BeanValidator.setValidationGroups
( String ) |
A
comma-separated list of validation groups which are used to filter
which validations get checked by this validator. If the
validationGroupsArray attribute is omitted or is empty, the validation
groups will be inherited from the branch defaults or, if there are no
branch defaults, the jakarta.validation.groups.Default group will be
used. |
true |
|
true |
| JSF:JAVADOC:2133 |
void |
jakarta.faces.validator.BeanValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Verify
that the value is valid according to the Bean Validation constraints.
Obtain a ValidatorFactory instance by calling
jakarta.validation.Validation#buildDefaultValidatorFactory. Let
validationGroupsArray be a Class [] representing validator groups set
on the component by the tag handler for this validator. The first
search component terminates the search for the validation groups
value. If no such value is found use the class name of
jakarta.validation.groups.Default as the value of the validation groups.
Let valueExpression be the return from calling
UIComponent#getValueExpression on the argument component, passing the
literal string “value” (without the quotes) as an
argument. If this application is running in an environment with a
Unified EL Implementation for Java EE6 or later, obtain the
ValueReference from valueExpression and let valueBaseClase be the
return from calling ValueReference.getBase() and valueProperty be the
return from calling ValueReference.getProperty(). If an earlier
version of the Unified EL is present, use the appropriate methods to
inspect valueExpression and derive values for valueBaseClass and
valueProperty. If no ValueReference can be obtained, take no action
and return. If ValueReference.getBase() return null, take no action
and return. Obtain the ValidatorContext from the ValidatorFactory.
Decorate the MessageInterpolator returned from
ValidatorFactory#getMessageInterpolator with one that leverages the
Locale returned from jakarta.faces.component.UIViewRoot#getLocale, and
store it in the ValidatorContext using
ValidatorContext#messageInterpolator. Obtain the
jakarta.validation.Validator instance from the validatorContext. Obtain
a jakarta.validation.BeanDescriptor from the jakarta.validation.Validator.
If hasConstraints() on the BeanDescriptor returns false, take no
action and return. Otherwise proceed. Call
jakarta.validation.Validator#validateValue, passing valueBaseClass,
valueProperty, the value argument, and validatorGroupsArray as
arguments. If the returned Set<ConstraintViolation> is
non-empty, for each element in the Set, create a FacesMessage where
the summary and detail are the return from calling
ConstraintViolation#getMessage. Capture all such FacesMessage
instances into a Collection and pass them to
ValidatorException#ValidatorException(java.util.Collection), throwing
the new exception. |
true |
|
true |
| JSF:JAVADOC:2134 |
void |
jakarta.faces.validator.BeanValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:2135 |
void |
jakarta.faces.validator.DoubleRangeValidator.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:2136 |
DoubleRangeValidator |
jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator
|
Construct a Validator with no preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2137 |
DoubleRangeValidator |
jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator
( double ) |
Construct a Validator with the specified preconfigured limit. |
true |
|
true |
| JSF:JAVADOC:2138 |
DoubleRangeValidator |
jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator
( double ,
double ) |
Construct a Validator with the specified preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2139 |
boolean |
jakarta.faces.validator.DoubleRangeValidator.equals
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:2140 |
double |
jakarta.faces.validator.DoubleRangeValidator.getMaximum
|
Return
the maximum value to be enforced by this Validator or Double.MAX_VALUE
if it has not been set. |
true |
|
true |
| JSF:JAVADOC:2141 |
double |
jakarta.faces.validator.DoubleRangeValidator.getMinimum
|
Return
the minimum value to be enforced by this Validator, or
Double.MIN_VALUE if it has not been set. |
true |
|
true |
| JSF:JAVADOC:2142 |
int |
jakarta.faces.validator.DoubleRangeValidator.hashCode
|
|
true |
|
true |
| JSF:JAVADOC:2143 |
boolean |
jakarta.faces.validator.DoubleRangeValidator.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:2144 |
boolean |
jakarta.faces.validator.DoubleRangeValidator.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:2145 |
void |
jakarta.faces.validator.DoubleRangeValidator.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:2146 |
void |
jakarta.faces.validator.DoubleRangeValidator.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2147 |
Object |
jakarta.faces.validator.DoubleRangeValidator.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:2148 |
void |
jakarta.faces.validator.DoubleRangeValidator.setMaximum
( double ) |
Set the
maximum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2149 |
void |
jakarta.faces.validator.DoubleRangeValidator.setMinimum
( double ) |
Set the
minimum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2150 |
void |
jakarta.faces.validator.DoubleRangeValidator.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:2151 |
void |
jakarta.faces.validator.DoubleRangeValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Perform
the correctness checks implemented by this Validator against the
specified UIComponent. If any violations are found, a
ValidatorException will be thrown containing the
jakarta.faces.application.FacesMessage describing the failure. For a
validator to be fully compliant with Version 2 and later of the
specification, it must not fail validation on null or empty values
unless it is specifically intended to address null or empty values. An
application-wide is provided to allow validators designed for JSF 1.2
to work with JSF 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
must be set to false to enable this backwards compatibility behavior.
|
true |
|
true |
| JSF:JAVADOC:2152 |
void |
jakarta.faces.validator.DoubleRangeValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
if
validation fails |
true |
|
true |
| JSF:JAVADOC:2153 |
void |
jakarta.faces.validator.DoubleRangeValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2154 |
boolean |
jakarta.faces.validator.FacesValidator.isDefault
|
If
true, the validator id for this annotation is added to the list of
default validators by a call to
jakarta.faces.application.Application#addDefaultValidatorId. |
true |
|
true |
| JSF:JAVADOC:2155 |
String |
jakarta.faces.validator.FacesValidator.value
|
The
value of this annotation attribute is taken to be the validator-id
with which instances of this class of component can be instantiated by
calling
jakarta.faces.application.Application#createValidator(java.lang.String).
|
true |
|
true |
| JSF:JAVADOC:2156 |
void |
jakarta.faces.validator.LengthValidator.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:2157 |
boolean |
jakarta.faces.validator.LengthValidator.equals
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:2158 |
int |
jakarta.faces.validator.LengthValidator.getMaximum
|
Return
the maximum length to be enforced by this Validator, or 0 if the
maximum has not been set. |
true |
|
true |
| JSF:JAVADOC:2159 |
int |
jakarta.faces.validator.LengthValidator.getMinimum
|
Return
the minimum length to be enforced by this Validator, or 0 if the
minimum has not been set. |
true |
|
true |
| JSF:JAVADOC:2160 |
int |
jakarta.faces.validator.LengthValidator.hashCode
|
|
true |
|
true |
| JSF:JAVADOC:2161 |
boolean |
jakarta.faces.validator.LengthValidator.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:2162 |
boolean |
jakarta.faces.validator.LengthValidator.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:2163 |
LengthValidator |
jakarta.faces.validator.LengthValidator.LengthValidator
|
Construct a Validator with no preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2164 |
LengthValidator |
jakarta.faces.validator.LengthValidator.LengthValidator
( int ) |
Construct a Validator with the specified preconfigured limit. |
true |
|
true |
| JSF:JAVADOC:2165 |
LengthValidator |
jakarta.faces.validator.LengthValidator.LengthValidator
( int ,
int ) |
Construct a Validator with the specified preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2166 |
void |
jakarta.faces.validator.LengthValidator.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:2167 |
void |
jakarta.faces.validator.LengthValidator.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2168 |
Object |
jakarta.faces.validator.LengthValidator.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:2169 |
void |
jakarta.faces.validator.LengthValidator.setMaximum
( int ) |
Set the
maximum length to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2170 |
void |
jakarta.faces.validator.LengthValidator.setMinimum
( int ) |
Set the
minimum length to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2171 |
void |
jakarta.faces.validator.LengthValidator.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:2172 |
void |
jakarta.faces.validator.LengthValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Perform
the correctness checks implemented by this Validator against the
specified UIComponent. If any violations are found, a
ValidatorException will be thrown containing the
jakarta.faces.application.FacesMessage describing the failure. For a
validator to be fully compliant with Version 2 and later of the
specification, it must not fail validation on null or empty values
unless it is specifically intended to address null or empty values. An
application-wide is provided to allow validators designed for JSF 1.2
to work with JSF 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
must be set to false to enable this backwards compatibility behavior.
|
true |
|
true |
| JSF:JAVADOC:2173 |
void |
jakarta.faces.validator.LengthValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
if
validation fails |
true |
|
true |
| JSF:JAVADOC:2174 |
void |
jakarta.faces.validator.LengthValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2175 |
void |
jakarta.faces.validator.LongRangeValidator.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:2176 |
boolean |
jakarta.faces.validator.LongRangeValidator.equals
( Object ) |
|
true |
|
true |
| JSF:JAVADOC:2177 |
long |
jakarta.faces.validator.LongRangeValidator.getMaximum
|
Return
the maximum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2178 |
long |
jakarta.faces.validator.LongRangeValidator.getMinimum
|
Return
the minimum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2179 |
int |
jakarta.faces.validator.LongRangeValidator.hashCode
|
|
true |
|
true |
| JSF:JAVADOC:2180 |
boolean |
jakarta.faces.validator.LongRangeValidator.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:2181 |
boolean |
jakarta.faces.validator.LongRangeValidator.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:2182 |
LongRangeValidator |
jakarta.faces.validator.LongRangeValidator.LongRangeValidator
|
Construct a Validator with no preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2183 |
LongRangeValidator |
jakarta.faces.validator.LongRangeValidator.LongRangeValidator
( long ) |
Construct a Validator with the specified preconfigured limit. |
true |
|
true |
| JSF:JAVADOC:2184 |
LongRangeValidator |
jakarta.faces.validator.LongRangeValidator.LongRangeValidator
( long ,
long ) |
Construct a Validator with the specified preconfigured limits. |
true |
|
true |
| JSF:JAVADOC:2185 |
void |
jakarta.faces.validator.LongRangeValidator.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:2186 |
void |
jakarta.faces.validator.LongRangeValidator.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2187 |
Object |
jakarta.faces.validator.LongRangeValidator.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:2188 |
void |
jakarta.faces.validator.LongRangeValidator.setMaximum
( long ) |
Set the
maximum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2189 |
void |
jakarta.faces.validator.LongRangeValidator.setMinimum
( long ) |
Set the
minimum value to be enforced by this Validator. |
true |
|
true |
| JSF:JAVADOC:2190 |
void |
jakarta.faces.validator.LongRangeValidator.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:2191 |
void |
jakarta.faces.validator.LongRangeValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Perform
the correctness checks implemented by this Validator against the
specified UIComponent. If any violations are found, a
ValidatorException will be thrown containing the
jakarta.faces.application.FacesMessage describing the failure. For a
validator to be fully compliant with Version 2 and later of the
specification, it must not fail validation on null or empty values
unless it is specifically intended to address null or empty values. An
application-wide is provided to allow validators designed for JSF 1.2
to work with JSF 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
must be set to false to enable this backwards compatibility behavior.
|
true |
|
true |
| JSF:JAVADOC:2192 |
void |
jakarta.faces.validator.LongRangeValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
if
validation fails |
true |
|
true |
| JSF:JAVADOC:2193 |
void |
jakarta.faces.validator.LongRangeValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2194 |
boolean |
jakarta.faces.validator.MethodExpressionValidator.isTransient
|
If
true, the Object implementing this interface must not participate in
state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:2195 |
MethodExpressionValidator |
jakarta.faces.validator.MethodExpressionValidator.MethodExpressionValidator
|
|
true |
|
true |
| JSF:JAVADOC:2196 |
MethodExpressionValidator |
jakarta.faces.validator.MethodExpressionValidator.MethodExpressionValidator
( MethodExpression ) |
Construct a Validator that contains a MethodExpression. |
true |
|
true |
| JSF:JAVADOC:2197 |
void |
jakarta.faces.validator.MethodExpressionValidator.restoreState
( FacesContext ,
Object ) |
Perform
any processing required to restore the state from the entries in the
state Object. If the class that implements this interface has
references to instances that also implement StateHolder (such as a
UIComponent with event handlers, validators, etc.) this method must
call the #restoreState method on all those instances as well. |
true |
|
true |
| JSF:JAVADOC:2198 |
void |
jakarta.faces.validator.MethodExpressionValidator.restoreState
( FacesContext ,
Object )
throws NullPointerException
|
if
either context or state are null |
true |
|
true |
| JSF:JAVADOC:2199 |
Object |
jakarta.faces.validator.MethodExpressionValidator.saveState
( FacesContext ) |
Gets
the state of the instance as a Serializable Object. If the class that
implements this interface has references to instances that implement
StateHolder (such as a UIComponent with event handlers, validators,
etc.) this method must call the #saveState method on all those
instances as well. This method must not save the state of children and
facets. That is done via the jakarta.faces.application.StateManager This
method must not alter the state of the implementing object. In other
words, after executing this code: Object state =
component.saveState(facesContext); component should be the same as
before executing it. The return from this method must be Serializable
|
true |
|
true |
| JSF:JAVADOC:2200 |
Object |
jakarta.faces.validator.MethodExpressionValidator.saveState
( FacesContext )
throws NullPointerException
|
if
context is null |
true |
|
true |
| JSF:JAVADOC:2201 |
void |
jakarta.faces.validator.MethodExpressionValidator.setTransient
( boolean ) |
Denotes
whether or not the Object implementing this interface must or must not
participate in state saving or restoring. |
true |
|
true |
| JSF:JAVADOC:2202 |
void |
jakarta.faces.validator.MethodExpressionValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Perform
the correctness checks implemented by this Validator against the
specified UIComponent. If any violations are found, a
ValidatorException will be thrown containing the
jakarta.faces.application.FacesMessage describing the failure. For a
validator to be fully compliant with Version 2 and later of the
specification, it must not fail validation on null or empty values
unless it is specifically intended to address null or empty values. An
application-wide is provided to allow validators designed for JSF 1.2
to work with JSF 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
must be set to false to enable this backwards compatibility behavior.
|
true |
|
true |
| JSF:JAVADOC:2203 |
void |
jakarta.faces.validator.MethodExpressionValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
if
validation fails |
true |
|
true |
| JSF:JAVADOC:2204 |
void |
jakarta.faces.validator.MethodExpressionValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2205 |
void |
jakarta.faces.validator.RegexValidator.clearInitialState
|
Reset
the PartialStateHolder to a non-delta tracking state. |
true |
|
true |
| JSF:JAVADOC:2206 |
String |
jakarta.faces.validator.RegexValidator.getPattern
|
Return
the ValueExpression that yields the regular expression pattern when
evaluated. |
true |
|
true |
| JSF:JAVADOC:2207 |
boolean |
jakarta.faces.validator.RegexValidator.initialStateMarked
|
Return
true if delta state changes are being tracked, otherwise false |
true |
|
true |
| JSF:JAVADOC:2208 |
boolean |
jakarta.faces.validator.RegexValidator.isTransient
|
|
true |
|
true |
| JSF:JAVADOC:2209 |
void |
jakarta.faces.validator.RegexValidator.markInitialState
|
The
runtime must ensure that the #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. The implementor of the
interface must ensure that #initialStateMarked returns true from the
time markInitialState() is called until #clearInitialState is called,
after which time initialStateMarked() must return false. Also, during
the time that the instance returns true from initialStateMarked(), the
implementation must return only the state that has changed in its
implementation of StateHolder#saveState. |
true |
|
true |
| JSF:JAVADOC:2210 |
RegexValidator |
jakarta.faces.validator.RegexValidator.RegexValidator
|
|
true |
|
true |
| JSF:JAVADOC:2211 |
void |
jakarta.faces.validator.RegexValidator.restoreState
( FacesContext ,
Object ) |
|
true |
|
true |
| JSF:JAVADOC:2212 |
Object |
jakarta.faces.validator.RegexValidator.saveState
( FacesContext ) |
|
true |
|
true |
| JSF:JAVADOC:2213 |
void |
jakarta.faces.validator.RegexValidator.setPattern
( String ) |
The
Regular Expression property to validate against. |
true |
|
true |
| JSF:JAVADOC:2214 |
void |
jakarta.faces.validator.RegexValidator.setTransient
( boolean ) |
|
true |
|
true |
| JSF:JAVADOC:2215 |
void |
jakarta.faces.validator.RegexValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Validate a String against a regular expression pattern. The full regex
pattern must be matched in order to pass the validation. |
true |
|
true |
| JSF:JAVADOC:2216 |
void |
jakarta.faces.validator.RegexValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:2217 |
void |
jakarta.faces.validator.RegexValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:2218 |
RequiredValidator |
jakarta.faces.validator.RequiredValidator.RequiredValidator
|
|
true |
|
true |
| JSF:JAVADOC:2219 |
void |
jakarta.faces.validator.RequiredValidator.validate
( FacesContext ,
UIComponent ,
Object ) |
Verify
that the converted object value is not null. |
true |
|
true |
| JSF:JAVADOC:2220 |
void |
jakarta.faces.validator.RequiredValidator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
{@inheritDoc} |
true |
|
true |
| JSF:JAVADOC:2221 |
void |
jakarta.faces.validator.Validator.validate
( FacesContext ,
UIComponent ,
Object ) |
Perform
the correctness checks implemented by this Validator against the
specified UIComponent. If any violations are found, a
ValidatorException will be thrown containing the
jakarta.faces.application.FacesMessage describing the failure. For a
validator to be fully compliant with Version 2 and later of the
specification, it must not fail validation on null or empty values
unless it is specifically intended to address null or empty values. An
application-wide is provided to allow validators designed for JSF 1.2
to work with JSF 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS
must be set to false to enable this backwards compatibility behavior.
|
true |
|
true |
| JSF:JAVADOC:2222 |
void |
jakarta.faces.validator.Validator.validate
( FacesContext ,
UIComponent ,
Object )
throws ValidatorException
|
if
validation fails |
true |
|
true |
| JSF:JAVADOC:2223 |
void |
jakarta.faces.validator.Validator.validate
( FacesContext ,
UIComponent ,
Object )
throws NullPointerException
|
if
context or component is null |
true |
|
true |
| JSF:JAVADOC:2224 |
FacesMessage |
jakarta.faces.validator.ValidatorException.getFacesMessage
|
Returns
the FacesMessage associated with the exception. If this instance was
created with a constructor that takes Collection, this method returns
the first message in the Collection |
true |
|
true |
| JSF:JAVADOC:2225 |
Collection |
jakarta.faces.validator.ValidatorException.getFacesMessages
|
If this
instance was created with a constructor that takes Collection, this
method returns the passed collection, otherwise this method returns
null. |
true |
|
true |
| JSF:JAVADOC:2226 |
ValidatorException |
jakarta.faces.validator.ValidatorException.ValidatorException
( FacesMessage ) |
Construct a new exception with the specified message and no root
cause. |
true |
|
true |
| JSF:JAVADOC:2227 |
ValidatorException |
jakarta.faces.validator.ValidatorException.ValidatorException
( Collection ) |
Allow
this one exception to contain multiple messages. |
true |
|
true |
| JSF:JAVADOC:2228 |
ValidatorException |
jakarta.faces.validator.ValidatorException.ValidatorException
( FacesMessage ,
Throwable ) |
Construct a new exception with the specified detail message and root
cause. |
true |
|
true |
| JSF:JAVADOC:2229 |
ValidatorException |
jakarta.faces.validator.ValidatorException.ValidatorException
( Collection ,
Throwable ) |
Allow
this one exception to contain multiple messages, while passing on the
root cause to the superclass |
true |
|
true |
| JSF:JAVADOC:2230 |
void |
jakarta.faces.view.AttachedObjectHandler.applyAttachedObject
( FacesContext ,
UIComponent ) |
Take
the argument parent and apply this attached object to it. The action
taken varies with class that implements one of the subinterfaces of
this interface. |
true |
|
true |
| JSF:JAVADOC:2231 |
String |
jakarta.faces.view.AttachedObjectHandler.getFor
|
Return
the value of the "for" attribute specified by the page author on the
tag for this AttachedObjectHandler. |
true |
|
true |
| JSF:JAVADOC:2232 |
String |
jakarta.faces.view.AttachedObjectTarget.getName
|
Returns
the name by which this attached object target is exposed to the page
author. |
true |
|
true |
| JSF:JAVADOC:2233 |
List |
jakarta.faces.view.AttachedObjectTarget.getTargets
( UIComponent ) |
Returns
the List that this AttachedObjectTarget exposes. Each attached object
exposed by the composite component author may point at multiple
UIComponent instances within the composite component. This method is
used by the
jakarta.faces.view.ViewDeclarationLanguage#retargetAttachedObjects
method to take the appropriate action on the attached object. |
true |
|
true |
| JSF:JAVADOC:2234 |
String |
jakarta.faces.view.BehaviorHolderAttachedObjectHandler.getEventName
|
Return
the client event name to which this behavior applies. |
true |
|
true |
| JSF:JAVADOC:2235 |
boolean |
jakarta.faces.view.BehaviorHolderAttachedObjectTarget.isDefaultEvent
|
|
true |
|
true |
| JSF:JAVADOC:2236 |
int |
jakarta.faces.view.Location.getColumn
|
Return
the estimated character column. |
true |
|
true |
| JSF:JAVADOC:2237 |
int |
jakarta.faces.view.Location.getLine
|
Return
the line number in the page for this location. |
true |
|
true |
| JSF:JAVADOC:2238 |
String |
jakarta.faces.view.Location.getPath
|
Return
the file path to the page represented by this location. |
true |
|
true |
| JSF:JAVADOC:2239 |
Location |
jakarta.faces.view.Location.Location
( String ,
int ,
int ) |
|
true |
|
true |
| JSF:JAVADOC:2240 |
String |
jakarta.faces.view.Location.toString
|
|
true |
|
true |
| JSF:JAVADOC:2241 |
UIViewRoot |
jakarta.faces.view.StateManagementStrategy.restoreView
( FacesContext ,
String ,
String ) |
Restore
the state of the view with information in the request. The default
implementation must perform the following algorithm or its semantic
equivalent. Build the view from the markup. For all components in the
view that do not have an explicitly assigned id in the markup, the
values of those ids must be the same as on an initial request for this
view. This view will not contain any components programmatically added
during the previous lifecycle run, and it will contain components that
were programmatically deleted on the previous lifecycle run. Both of
these cases must be handled. Call
jakarta.faces.render.ResponseStateManager#getState to obtain the data
structure returned from the previous call to #saveView. Visit the tree
using jakarta.faces.component.UIComponent#visitTree. For each node, call
jakarta.faces.component.UIComponent#restoreState, passing the state
saved corresponding to the current client id. Ensure that any
programmatically deleted components are removed. Ensure any
programmatically added components are added. The implementation must
ensure that the jakarta.faces.component.UIComponent#restoreState method
is called for each node in the tree, except for those that were
programmatically deleted on the previous run through the lifecycle. |
true |
|
true |
| JSF:JAVADOC:2242 |
Object |
jakarta.faces.view.StateManagementStrategy.saveView
( FacesContext ) |
Return
the state of the current view in an Object that implements
Serializable. The default implementation must perform the following
algorithm or its semantic equivalent. If the UIViewRoot of the current
view is marked transient, return null immediately. Traverse the view
and verify that each of the client ids are unique. Throw
IllegalStateException if more than one client id are the same. Visit
the tree using jakarta.faces.component.UIComponent#visitTree. For each
node, call jakarta.faces.component.UIComponent#saveState, saving the
returned Object in a way such that it can be restored given only its
client id. Special care must be taken to handle the case of components
that were added or deleted programmatically during this lifecycle
traversal, rather than by the VDL. The implementation must ensure that
the jakarta.faces.component.UIComponent#saveState method is called for
each node in the tree. The data structure used to save the state
obtained by executing the above algorithm must be Serializable, and
all of the elements within the data structure must also be
Serializable. |
true |
|
true |
| JSF:JAVADOC:2243 |
StateManagementStrategy |
jakarta.faces.view.StateManagementStrategy.StateManagementStrategy
|
|
true |
|
true |
| JSF:JAVADOC:2244 |
void |
jakarta.faces.view.ViewDeclarationLanguage.buildView
( FacesContext ,
UIViewRoot ) |
Take
any actions specific to this VDL implementation to cause the argument
UIViewRoot which must have been created via a call to #createView, to
be populated with children. The Facelets implementation must insure
that markup comprising the view must be executed, with the
jakarta.faces.component.UIComponent instances in the view being
encountered in the same depth-first order as in other lifecycle
methods defined on UIComponent, and added to the view (but not
rendered) during the traversal. The runtime must guarantee that the
view must be fully populated before any of the following happen. The
jakarta.faces.event.PhaseListener#afterPhase method of any
PhaseListeners attached to the application is called The
jakarta.faces.component.UIViewRoot phase listener installed via
jakarta.faces.component.UIViewRoot#setAfterPhaseListener or
jakarta.faces.component.UIViewRoot#addPhaseListener are called. The
implementation must take no action if the argument root already has
non-metadata children. See section JSF.7.6.2.3 for the view metadata
specification. |
true |
|
true |
| JSF:JAVADOC:2245 |
void |
jakarta.faces.view.ViewDeclarationLanguage.buildView
( FacesContext ,
UIViewRoot )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2246 |
UIViewRoot |
jakarta.faces.view.ViewDeclarationLanguage.createView
( FacesContext ,
String ) |
Create
a UIViewRoot from the VDL contained in the artifact referenced by the
argument viewId. See section JSF.7.6.2 for the specification of the
default implementation. |
true |
|
true |
| JSF:JAVADOC:2247 |
UIViewRoot |
jakarta.faces.view.ViewDeclarationLanguage.createView
( FacesContext ,
String )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:2248 |
BeanInfo |
jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata
( FacesContext ,
Resource ) |
Return
a reference to the component metadata for the composite component
represented by the argument componentResource, or null if the metadata
cannot be found. See section JSF.7.6.2 for the specification of the
default implementation. JSP implementations must throw
UnsupportedOperationException. |
true |
|
true |
| JSF:JAVADOC:2249 |
BeanInfo |
jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata
( FacesContext ,
Resource )
throws NullPointerException
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:2250 |
BeanInfo |
jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata
( FacesContext ,
Resource )
throws FacesException
|
if there
is an error in obtaining the metadata |
true |
|
true |
| JSF:JAVADOC:2251 |
BeanInfo |
jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata
( FacesContext ,
Resource )
throws UnsupportedOperationException
|
if this
is a JSP VDL implementation. |
true |
|
true |
| JSF:JAVADOC:2252 |
Resource |
jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource
( FacesContext ,
Resource ) |
Take
implementation specific action to discover a Resource given the
argument componentResource. See section JSF.7.6.2 for the
specification of the default implementation. JSP implementations must
throw UnsupportedOperationException. |
true |
|
true |
| JSF:JAVADOC:2253 |
Resource |
jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource
( FacesContext ,
Resource )
throws NullPointerException
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:2254 |
Resource |
jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource
( FacesContext ,
Resource )
throws FacesException
|
if there
is an error in obtaining the script component resource |
true |
|
true |
| JSF:JAVADOC:2255 |
Resource |
jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource
( FacesContext ,
Resource )
throws UnsupportedOperationException
|
if this
is a JSP VDL implementation. |
true |
|
true |
| JSF:JAVADOC:2256 |
StateManagementStrategy |
jakarta.faces.view.ViewDeclarationLanguage.getStateManagementStrategy
( FacesContext ,
String ) |
For
implementations that want to control the implementation of state
saving and restoring, the StateManagementStrategy allows them to do
so. Returning null indicates that the implementation wishes the
runtime to handle the state saving and restoring. Implementations that
provide the VDL for Facelets for JSF 2.0 and later must return
non-null from this method. |
true |
|
true |
| JSF:JAVADOC:2257 |
ViewMetadata |
jakarta.faces.view.ViewDeclarationLanguage.getViewMetadata
( FacesContext ,
String ) |
Return
a reference to the view metadata for the view represented by the
argument viewId, or null if the metadata cannot be found. See section
JSF.7.6.2 for the specification of the default implementation.
Facelets for JSF 2 implementation must return non-null. JSP
implementations must return null. |
true |
|
true |
| JSF:JAVADOC:2258 |
ViewMetadata |
jakarta.faces.view.ViewDeclarationLanguage.getViewMetadata
( FacesContext ,
String )
throws NullPointerException
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:2259 |
ViewMetadata |
jakarta.faces.view.ViewDeclarationLanguage.getViewMetadata
( FacesContext ,
String )
throws FacesException
|
if there
is an error in obtaining the metadata |
true |
|
true |
| JSF:JAVADOC:2260 |
void |
jakarta.faces.view.ViewDeclarationLanguage.renderView
( FacesContext ,
UIViewRoot ) |
Render
a view rooted at argumentview. See section JSF.7.6.2 for the
specification of the default implementation. |
true |
|
true |
| JSF:JAVADOC:2261 |
void |
jakarta.faces.view.ViewDeclarationLanguage.renderView
( FacesContext ,
UIViewRoot )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2262 |
void |
jakarta.faces.view.ViewDeclarationLanguage.renderView
( FacesContext ,
UIViewRoot )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:2263 |
UIViewRoot |
jakarta.faces.view.ViewDeclarationLanguage.restoreView
( FacesContext ,
String ) |
Restore
a UIViewRoot from a previously created view. See section JSF.7.6.2 for
the specification of the default implementation. |
true |
|
true |
| JSF:JAVADOC:2264 |
UIViewRoot |
jakarta.faces.view.ViewDeclarationLanguage.restoreView
( FacesContext ,
String )
throws NullPointerException
|
if any
of the arguments are null |
true |
|
true |
| JSF:JAVADOC:2265 |
void |
jakarta.faces.view.ViewDeclarationLanguage.retargetAttachedObjects
( FacesContext ,
UIComponent ,
List ) |
Assuming the component metadata for argument topLevelComponent has
been made available by an earlier call to
ViewDeclarationLanguage#getComponentMetadata, 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. This method must be called
by the ViewDeclarationLanguage implementation when creating the
UIComponent tree when a composite component usage is encountered. An
algorithm semantically equivalent to the following must be
implemented. Obtain the metadata for the composite component.
Currently this entails getting the value of the
UIComponent#BEANINFO_KEY component attribute, which will be an
instance of BeanInfo. If the metadata cannot be found, log an error
message and return. Get the BeanDescriptor from the BeanInfo. Get the
value of the AttachedObjectTarget#ATTACHED_OBJECT_TARGETS_KEY from the
BeanDescriptor's getValue() method. This will be a
List<AttachedObjectTarget>. Let this be targetList. For each
curHandler entry in the argument handlers Let forAttributeValue be the
return from AttachedObjectHandler#getFor. For each curTarget entry in
targetList, the first of the following items that causes a match will
take this action: For each UIComponent in the list returned from
curTarget.getTargets(), call curHandler.applyAttachedObject(), passing
the FacesContext and the UIComponent. and cause this inner loop to
terminate. If curHandler is an instance of
ActionSource2AttachedObjectHandler and curTarget is an instance of
ActionSource2AttachedObjectTarget, and curTarget.getName() is equal to
curTargetName, consider it a match. If curHandler is an instance of
EditableValueHolderAttachedObjectHandler and curTarget is an instance
of EditableValueHolderAttachedObjectTarget, and curTarget.getName() is
equal to curTargetName, consider it a match. If curHandler is an
instance of ValueHolderAttachedObjectHandler and curTarget is an
instance of ValueHolderAttachedObjectTarget, and curTarget.getName()
is equal to curTargetName, consider it a match. If curHandler is an
instance of BehaviorHolderAttachedObjectHandler and curTarget is an
instance of BehaviorHolderAttachedObjectTarget, and either of the
following conditions are true, curHandler.getEventName() is not null
and is equal to curTargetName. curHandler.getEventName() is null and
curTarget.isDefaultEvent() is true. consider it a match. The
implementation must support retargeting attached objects from the top
level compsite component to targets that are composite and
non-composite components. An implementation is provided that will
throw UnsupportedOperationException. A Faces implementation compliant
with version 2.0 and beyond of the specification must override this
method. |
true |
|
true |
| JSF:JAVADOC:2266 |
void |
jakarta.faces.view.ViewDeclarationLanguage.retargetAttachedObjects
( FacesContext ,
UIComponent ,
List )
throws NullPointerException
|
if any
of the arguments are null. |
true |
|
true |
| JSF:JAVADOC:2267 |
void |
jakarta.faces.view.ViewDeclarationLanguage.retargetMethodExpressions
( FacesContext ,
UIComponent ) |
Assuming the component metadata for argument topLevelComponent has
been made available by an earlier call to
ViewDeclarationLanguage#getComponentMetadata, leverage the component
metadata for the purpose of re-targeting any method expressions from
the top level component to the appropriate inner component. For each
attribute that is a MethodExpression (as indicated by the presence of
a "method-signature" attribute and the absence of a "type" attribute),
the following action must be taken: Get the value of the targets
attribute. If the value is a ValueExpression evaluate it. If there is
no targets attribute, let the name of the metadata element be the
evaluated value of the targets attribute. Interpret targets as a space
(not tab) separated list of ids. For each entry in the list: Find the
inner component of the topLevelComponent with the id equal to the
current list entry. For discussion, this component is called target.
If not found, log and error and continue to the next attribute. For
discussion the declared name of the attribute is called name. In the
attributes map of the topLevelComponent, look up the entry under the
key name. Assume the result is a ValueExpression. For discussion, this
is attributeValueExpression. If not found, log an error and continue
to the next attribute. If name is equal to the string "action", or
"actionListener" without the quotes, assume target is an
jakarta.faces.component.ActionSource2. If name is equal to the string
"validator", or "valueChangeListener" without the quotes, assume
target is an jakarta.faces.component.EditableValueHolder. Call
getExpressionString() on the attributeValueExpression and use that
string to create a MethodExpression of the appropriate signature for
name. If name is not equal to any of the previously listed strings,
call getExpressionString() on the attributeValueExpression and use
that string to create a MethodExpression where the signature is
created based on the value of the "method-signature" attribute of the
tag. Let the resultant MethodExpression be called
attributeMethodExpression for discussion. If name is equal to the
string "action" without the quotes, call
jakarta.faces.component.ActionSource2#setActionExpression on target,
passing attributeMethodExpression. If name is equal to the string
"actionListener" without the quotes, call
jakarta.faces.component.ActionSource#addActionListener on target,
passing attributeMethodExpression wrapped in a
jakarta.faces.event.MethodExpressionActionListener. If name is equal to
the string "validator" without the quotes, call
jakarta.faces.component.EditableValueHolder#addValidator on target,
passing attributeMethodExpression wrapped in a
jakarta.faces.validator.MethodExpressionValidator. If name is equal to
the string "valueChangeListener" without the quotes, call
jakarta.faces.component.EditableValueHolder#addValueChangeListener on
target, passing attributeMethodExpression wrapped in a
jakarta.faces.event.MethodExpressionValueChangeListener. Otherwise,
assume that the MethodExpression should be placed in the components
attribute set. The runtme must create the MethodExpression instance
based on the value of the "method-signature" attribute. An
implementation is provided that will throw
UnsupportedOperationException. A Faces implementation compliant with
version 2.0 and beyond of the specification must override this method.
|
true |
|
true |
| JSF:JAVADOC:2268 |
void |
jakarta.faces.view.ViewDeclarationLanguage.retargetMethodExpressions
( FacesContext ,
UIComponent )
throws NullPointerException
|
if
context or topLevelComponent is null. |
true |
|
true |
| JSF:JAVADOC:2269 |
ViewDeclarationLanguage |
jakarta.faces.view.ViewDeclarationLanguage.ViewDeclarationLanguage
|
|
true |
|
true |
| JSF:JAVADOC:2270 |
ViewDeclarationLanguage |
jakarta.faces.view.ViewDeclarationLanguageFactory.getViewDeclarationLanguage
( String ) |
Return
the ViewDeclarationLanguage instance suitable for handling the VDL
contained in the page referenced by the argument viewId. The default
implementation must return a valid ViewDeclarationLanguage instance
for views written in either JSP or Facelets for JSF 2. |
true |
|
true |
| JSF:JAVADOC:2271 |
ViewDeclarationLanguage |
jakarta.faces.view.ViewDeclarationLanguageFactory.getViewDeclarationLanguage
( String )
throws NullPointerException
|
if
viewId is null. |
true |
|
true |
| JSF:JAVADOC:2272 |
ViewDeclarationLanguageFactory |
jakarta.faces.view.ViewDeclarationLanguageFactory.getWrapped
|
If this
factory has been decorated, the implementation doing the decorating
may override this method to provide access to the implementation being
wrapped. A default implementation is provided that returns null. |
true |
|
true |
| JSF:JAVADOC:2273 |
ViewDeclarationLanguageFactory |
jakarta.faces.view.ViewDeclarationLanguageFactory.ViewDeclarationLanguageFactory
|
|
true |
|
true |
| JSF:JAVADOC:2274 |
UIViewRoot |
jakarta.faces.view.ViewMetadata.createMetadataView
( FacesContext ) |
Creates
a new UIViewRoot containing only view parameter metadata. The
processing of building this UIViewRoot with metadata should not cause
any events to be published to the application. The implementation must
call FacesContext#setProcessingEvents passing false as the argument,
at the beginning of the method, and pass true to the same method at
the end. The implementation must ensure that this happens regardless
of ant exceptions that may be thrown. |
true |
|
true |
| JSF:JAVADOC:2275 |
String |
jakarta.faces.view.ViewMetadata.getViewId
|
|
true |
|
true |
| JSF:JAVADOC:2276 |
Collection |
jakarta.faces.view.ViewMetadata.getViewParameters
( UIViewRoot ) |
Utility
method to extract view metadata from the provided UIViewRoot. |
true |
|
true |
| JSF:JAVADOC:2277 |
ViewMetadata |
jakarta.faces.view.ViewMetadata.ViewMetadata
|
|
true |
|
true |
| JSF:JAVADOC:2278 |
String |
jakarta.faces.view.facelets.AttributeHandler.getAttributeName
( FaceletContext ) |
Returns
the resolved literal String value of the attribute name after
evaluating EL. |
true |
|
true |
| JSF:JAVADOC:2279 |
String |
jakarta.faces.view.facelets.BehaviorConfig.getBehaviorId
|
Return
the value of the behavior-id. |
true |
|
true |
| JSF:JAVADOC:2280 |
BehaviorHandler |
jakarta.faces.view.facelets.BehaviorHandler.BehaviorHandler
( BehaviorConfig ) |
|
true |
|
true |
| JSF:JAVADOC:2281 |
String |
jakarta.faces.view.facelets.BehaviorHandler.getBehaviorId
|
|
true |
|
true |
| JSF:JAVADOC:2282 |
TagAttribute |
jakarta.faces.view.facelets.BehaviorHandler.getEvent
|
|
true |
|
true |
| JSF:JAVADOC:2283 |
String |
jakarta.faces.view.facelets.BehaviorHandler.getEventName
|
Return
the client event name to which this behavior applies. |
true |
|
true |
| JSF:JAVADOC:2284 |
String |
jakarta.faces.view.facelets.ComponentConfig.getComponentType
|
ComponentType to pass to the Application. Cannot be null. |
true |
|
true |
| JSF:JAVADOC:2285 |
String |
jakarta.faces.view.facelets.ComponentConfig.getRendererType
|
RendererType to set on created UIComponent instances. |
true |
|
true |
| JSF:JAVADOC:2286 |
ComponentHandler |
jakarta.faces.view.facelets.ComponentHandler.ComponentHandler
( ComponentConfig ) |
Leverage the TagHandlerDelegateFactory provided by the implementation
to create an instance of TagHandlerDelegate designed for use with
ComponentHandler. |
true |
|
true |
| JSF:JAVADOC:2287 |
ComponentConfig |
jakarta.faces.view.facelets.ComponentHandler.getComponentConfig
|
|
true |
|
true |
| JSF:JAVADOC:2288 |
boolean |
jakarta.faces.view.facelets.ComponentHandler.isNew
( UIComponent ) |
Determine if the passed component is not null and if it's new to the
tree. This operation can be used for determining if attributes should
be wired to the component. |
true |
|
true |
| JSF:JAVADOC:2289 |
void |
jakarta.faces.view.facelets.ComponentHandler.onComponentCreated
( FaceletContext ,
UIComponent ,
UIComponent ) |
This
method is guaranteed to be called after the component has been created
but before it has been populated with children. |
true |
|
true |
| JSF:JAVADOC:2290 |
void |
jakarta.faces.view.facelets.ComponentHandler.onComponentPopulated
( FaceletContext ,
UIComponent ,
UIComponent ) |
This
method is guaranteed to be called after the component has been
populated with children. |
true |
|
true |
| JSF:JAVADOC:2291 |
void |
jakarta.faces.view.facelets.CompositeFaceletHandler.apply
( FaceletContext ,
UIComponent ) |
Calls
apply on any child handlers. |
true |
|
true |
| JSF:JAVADOC:2292 |
void |
jakarta.faces.view.facelets.CompositeFaceletHandler.apply
( FaceletContext ,
UIComponent )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2293 |
CompositeFaceletHandler |
jakarta.faces.view.facelets.CompositeFaceletHandler.CompositeFaceletHandler
( FaceletHandler[] ) |
|
true |
|
true |
| JSF:JAVADOC:2294 |
FaceletHandler[] |
jakarta.faces.view.facelets.CompositeFaceletHandler.getHandlers
|
Returns
the array of child handlers contained by this handler. |
true |
|
true |
| JSF:JAVADOC:2295 |
String |
jakarta.faces.view.facelets.ConverterConfig.getConverterId
|
Return
the converter id to be used in instantiating this converter |
true |
|
true |
| JSF:JAVADOC:2296 |
ConverterHandler |
jakarta.faces.view.facelets.ConverterHandler.ConverterHandler
( ConverterConfig ) |
|
true |
|
true |
| JSF:JAVADOC:2297 |
String |
jakarta.faces.view.facelets.ConverterHandler.getConverterId
( FaceletContext ) |
|
true |
|
true |
| JSF:JAVADOC:2298 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.apply
( FaceletContext ,
UIComponent ) |
The
default implementation simply calls through to
TagHandlerDelegate#apply. |
true |
|
true |
| JSF:JAVADOC:2299 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.apply
( FaceletContext ,
UIComponent )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2300 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler
( FaceletContext ,
UIComponent ) |
|
true |
|
true |
| JSF:JAVADOC:2301 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler
( FaceletContext ,
UIComponent )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2302 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler
( FaceletContext ,
UIComponent )
throws FacesException
|
|
true |
|
true |
| JSF:JAVADOC:2303 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler
( FaceletContext ,
UIComponent )
throws ELException
|
|
true |
|
true |
| JSF:JAVADOC:2304 |
DelegatingMetaTagHandler |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.DelegatingMetaTagHandler
( TagConfig ) |
|
true |
|
true |
| JSF:JAVADOC:2305 |
TagAttribute |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.getBinding
|
|
true |
|
true |
| JSF:JAVADOC:2306 |
Tag |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTag
|
|
true |
|
true |
| JSF:JAVADOC:2307 |
TagAttribute |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagAttribute
( String ) |
|
true |
|
true |
| JSF:JAVADOC:2308 |
String |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagId
|
|
true |
|
true |
| JSF:JAVADOC:2309 |
boolean |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.isDisabled
( FaceletContext ) |
|
true |
|
true |
| JSF:JAVADOC:2310 |
void |
jakarta.faces.view.facelets.DelegatingMetaTagHandler.setAttributes
( FaceletContext ,
Object ) |
Invoking/extending this method will cause the results of the created
MetaRuleset to auto-wire state to the passed instance. |
true |
|
true |
| JSF:JAVADOC:2311 |
FaceletContext |
jakarta.faces.view.facelets.FaceletContext.FaceletContext
|
|
true |
|
true |
| JSF:JAVADOC:2312 |
String |
jakarta.faces.view.facelets.FaceletContext.generateUniqueId
( String ) |
Generate a unique ID for the passed String |
true |
|
true |
| JSF:JAVADOC:2313 |
Object |
jakarta.faces.view.facelets.FaceletContext.getAttribute
( String ) |
Return
an attribute set by a previous call to #setAttribute. Support method
which is backed by the current VariableMapper |
true |
|
true |
| JSF:JAVADOC:2314 |
ExpressionFactory |
jakarta.faces.view.facelets.FaceletContext.getExpressionFactory
|
The
ExpressionFactory to use within the Facelet this context is executing
upon. Must not be null. |
true |
|
true |
| JSF:JAVADOC:2315 |
FacesContext |
jakarta.faces.view.facelets.FaceletContext.getFacesContext
|
The
current FacesContext bound to this "request". Must not be null. |
true |
|
true |
| JSF:JAVADOC:2316 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
String ) |
Include
another Facelet defined at some path, relative to the executing
context, not the current Facelet (same as include directive in JSP) |
true |
|
true |
| JSF:JAVADOC:2317 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
String )
throws IOException
|
if
unable to load relativePath |
true |
|
true |
| JSF:JAVADOC:2318 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
String )
throws FaceletException
|
if
unable to parse the markup loaded from relativePath |
true |
|
true |
| JSF:JAVADOC:2319 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
String )
throws FacesException
|
if
unable to create child UIComponent instances |
true |
|
true |
| JSF:JAVADOC:2320 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
String )
throws ELException
|
if any
of the expressions in the markup loaded from relativePath fail |
true |
|
true |
| JSF:JAVADOC:2321 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
URL ) |
Include
another Facelet defined at some path, absolute to this ClassLoader/OS
|
true |
|
true |
| JSF:JAVADOC:2322 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
URL )
throws IOException
|
if
unable to load relativePath |
true |
|
true |
| JSF:JAVADOC:2323 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
URL )
throws FaceletException
|
if
unable to parse the markup loaded from relativePath |
true |
|
true |
| JSF:JAVADOC:2324 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
URL )
throws FacesException
|
if
unable to create child UIComponent instances |
true |
|
true |
| JSF:JAVADOC:2325 |
void |
jakarta.faces.view.facelets.FaceletContext.includeFacelet
( UIComponent ,
URL )
throws ELException
|
if any
of the expressions in the markup loaded from relativePath fail |
true |
|
true |
| JSF:JAVADOC:2326 |
void |
jakarta.faces.view.facelets.FaceletContext.setAttribute
( String ,
Object ) |
Support
method which is backed by the current VariableMapper. |
true |
|
true |
| JSF:JAVADOC:2327 |
void |
jakarta.faces.view.facelets.FaceletContext.setFunctionMapper
( FunctionMapper ) |
Set the
FunctionMapper to use in EL evaluation/creation. |
true |
|
true |
| JSF:JAVADOC:2328 |
void |
jakarta.faces.view.facelets.FaceletContext.setVariableMapper
( VariableMapper ) |
Set the
VariableMapper to use in EL evaluation/creation. |
true |
|
true |
| JSF:JAVADOC:2329 |
FaceletException |
jakarta.faces.view.facelets.FaceletException.FaceletException
|
Create
an empty FaceletException. |
true |
|
true |
| JSF:JAVADOC:2330 |
FaceletException |
jakarta.faces.view.facelets.FaceletException.FaceletException
( String ) |
Create
a FaceletException with argument message as the message. |
true |
|
true |
| JSF:JAVADOC:2331 |
FaceletException |
jakarta.faces.view.facelets.FaceletException.FaceletException
( Throwable ) |
Wrap
argument cause within this FaceletException instance. |
true |
|
true |
| JSF:JAVADOC:2332 |
FaceletException |
jakarta.faces.view.facelets.FaceletException.FaceletException
( String ,
Throwable ) |
Wrap
argument cause in a FaceletException instance, with a message given by
the argument message. |
true |
|
true |
| JSF:JAVADOC:2333 |
void |
jakarta.faces.view.facelets.FaceletHandler.apply
( FaceletContext ,
UIComponent ) |
Process
changes on a particular UIComponent |
true |
|
true |
| JSF:JAVADOC:2334 |
void |
jakarta.faces.view.facelets.FaceletHandler.apply
( FaceletContext ,
UIComponent )
throws IOException
|
if
unable to load relativePath |
true |
|
true |
| JSF:JAVADOC:2335 |
void |
jakarta.faces.view.facelets.FaceletHandler.apply
( FaceletContext ,
UIComponent )
throws FaceletException
|
if
unable to parse the markup loaded from relativePath |
true |
|
true |
| JSF:JAVADOC:2336 |
void |
jakarta.faces.view.facelets.FaceletHandler.apply
( FaceletContext ,
UIComponent )
throws FacesException
|
if
unable to create child UIComponent instances |
true |
|
true |
| JSF:JAVADOC:2337 |
void |
jakarta.faces.view.facelets.FaceletHandler.apply
( FaceletContext ,
UIComponent )
throws ELException
|
if any
of the expressions in the markup loaded from relativePath fail |
true |
|
true |
| JSF:JAVADOC:2338 |
void |
jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.applyAttachedObject
( FacesContext ,
UIComponent ) |
Take
the necessary actions to apply the attached object represented by the
tag for the concrete subclass of this class to the argument parent. |
true |
|
true |
| JSF:JAVADOC:2339 |
FaceletsAttachedObjectHandler |
jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.FaceletsAttachedObjectHandler
( TagConfig ) |
Call
through to super |
true |
|
true |
| JSF:JAVADOC:2340 |
String |
jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.getFor
|
Return
the value of the "for" attribute. This enables the runtime to know to
which inner component this attached object should be retargeted. |
true |
|
true |
| JSF:JAVADOC:2341 |
String |
jakarta.faces.view.facelets.FacetHandler.getFacetName
( FaceletContext ) |
Returns
the resolved literal String value of the facet name after evaluating
EL. |
true |
|
true |
| JSF:JAVADOC:2342 |
void |
jakarta.faces.view.facelets.Metadata.applyMetadata
( FaceletContext ,
Object ) |
Take
the action prescribed in the JSF specification for this particular VDL
element attribute. |
true |
|
true |
| JSF:JAVADOC:2343 |
Metadata |
jakarta.faces.view.facelets.Metadata.Metadata
|
|
true |
|
true |
| JSF:JAVADOC:2344 |
PropertyDescriptor |
jakarta.faces.view.facelets.MetadataTarget.getProperty
( String ) |
Return
a beans PropertyDescriptor for the property with name given by
argument name. |
true |
|
true |
| JSF:JAVADOC:2345 |
Class |
jakarta.faces.view.facelets.MetadataTarget.getPropertyType
( String ) |
Return
a Class for the property with name given by argument name. |
true |
|
true |
| JSF:JAVADOC:2346 |
Method |
jakarta.faces.view.facelets.MetadataTarget.getReadMethod
( String ) |
Return
a Method for the getter of the property with name given by argument
name. |
true |
|
true |
| JSF:JAVADOC:2347 |
Class |
jakarta.faces.view.facelets.MetadataTarget.getTargetClass
|
Return
the Class of the metadata target. |
true |
|
true |
| JSF:JAVADOC:2348 |
Method |
jakarta.faces.view.facelets.MetadataTarget.getWriteMethod
( String ) |
Return
a Method for the setter of the property with name given by argument
name. |
true |
|
true |
| JSF:JAVADOC:2349 |
boolean |
jakarta.faces.view.facelets.MetadataTarget.isTargetInstanceOf
( Class ) |
Return
true if the target for this metadata element is an instance of the
argument type. |
true |
|
true |
| JSF:JAVADOC:2350 |
MetadataTarget |
jakarta.faces.view.facelets.MetadataTarget.MetadataTarget
|
|
true |
|
true |
| JSF:JAVADOC:2351 |
Metadata |
jakarta.faces.view.facelets.MetaRule.applyRule
( String ,
TagAttribute ,
MetadataTarget ) |
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. The abstraction must encapsulate the
value from the argument attribute. |
true |
|
true |
| JSF:JAVADOC:2352 |
MetaRule |
jakarta.faces.view.facelets.MetaRule.MetaRule
|
|
true |
|
true |
| JSF:JAVADOC:2353 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.add
( Metadata ) |
Add
another Metadata to this ruleset, returning this. |
true |
|
true |
| JSF:JAVADOC:2354 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.addRule
( MetaRule ) |
Add
another MetaRule to this ruleset, returning this. |
true |
|
true |
| JSF:JAVADOC:2355 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.alias
( String ,
String ) |
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. |
true |
|
true |
| JSF:JAVADOC:2356 |
Metadata |
jakarta.faces.view.facelets.MetaRuleset.finish
|
Take
actions to apply the rule. |
true |
|
true |
| JSF:JAVADOC:2357 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.ignore
( String ) |
Customize this MetaRuleset instance to advise it to ignore the
attribute named by the attribute argument, returning this. |
true |
|
true |
| JSF:JAVADOC:2358 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.ignoreAll
|
Customize this MetaRuleset instance to advise it to ignore all
attributes, returning this. |
true |
|
true |
| JSF:JAVADOC:2359 |
MetaRuleset |
jakarta.faces.view.facelets.MetaRuleset.MetaRuleset
|
|
true |
|
true |
| JSF:JAVADOC:2360 |
MetaTagHandler |
jakarta.faces.view.facelets.MetaTagHandler.MetaTagHandler
( TagConfig ) |
|
true |
|
true |
| JSF:JAVADOC:2361 |
URL |
jakarta.faces.view.facelets.ResourceResolver.resolveUrl
( String ) |
Returns
the URL of a Facelet template file. Called by the Facelets Runtime to
load a template file referred to in a Facelets page. |
true |
|
true |
| JSF:JAVADOC:2362 |
ResourceResolver |
jakarta.faces.view.facelets.ResourceResolver.ResourceResolver
|
|
true |
|
true |
| JSF:JAVADOC:2363 |
TagAttributes |
jakarta.faces.view.facelets.Tag.getAttributes
|
Return
an object encapsulating the TagAttributes specified on this element in
the view. |
true |
|
true |
| JSF:JAVADOC:2364 |
String |
jakarta.faces.view.facelets.Tag.getLocalName
|
Return
the XML local name of the tag. For example, would be "tag". |
true |
|
true |
| JSF:JAVADOC:2365 |
Location |
jakarta.faces.view.facelets.Tag.getLocation
|
Return
the Location of this Tag instance in the Facelet view. |
true |
|
true |
| JSF:JAVADOC:2366 |
String |
jakarta.faces.view.facelets.Tag.getNamespace
|
Return
the resolved XML Namespace for this tag in the Facelets view. |
true |
|
true |
| JSF:JAVADOC:2367 |
String |
jakarta.faces.view.facelets.Tag.getQName
|
Return
the XML qualified name for this tag. For example, would be "my:tag". |
true |
|
true |
| JSF:JAVADOC:2368 |
Tag |
jakarta.faces.view.facelets.Tag.Tag
( Location ,
String ,
String ,
String ,
TagAttributes ) |
|
true |
|
true |
| JSF:JAVADOC:2369 |
Tag |
jakarta.faces.view.facelets.Tag.Tag
( Tag ,
TagAttributes ) |
|
true |
|
true |
| JSF:JAVADOC:2370 |
String |
jakarta.faces.view.facelets.Tag.toString
|
|
true |
|
true |
| JSF:JAVADOC:2371 |
boolean |
jakarta.faces.view.facelets.TagAttribute.getBoolean
( FaceletContext ) |
If
literal, return Boolean#getBoolean(java.lang.String)
Boolean.getBoolean(java.lang.String) passing our value, otherwise call
#getObject(FaceletContext, Class) getObject(FaceletContext, Class). |
true |
|
true |
| JSF:JAVADOC:2372 |
int |
jakarta.faces.view.facelets.TagAttribute.getInt
( FaceletContext ) |
If
literal, call Integer#parseInt(java.lang.String)
Integer.parseInt(String), otherwise call #getObject(FaceletContext,
Class) getObject(FaceletContext, Class). |
true |
|
true |
| JSF:JAVADOC:2373 |
String |
jakarta.faces.view.facelets.TagAttribute.getLocalName
|
Local
name of this attribute |
true |
|
true |
| JSF:JAVADOC:2374 |
Location |
jakarta.faces.view.facelets.TagAttribute.getLocation
|
The
location of this attribute in the FaceletContext |
true |
|
true |
| JSF:JAVADOC:2375 |
MethodExpression |
jakarta.faces.view.facelets.TagAttribute.getMethodExpression
( FaceletContext ,
Class ,
Class[] ) |
Create
a MethodExpression, using this attribute's value as the expression
String. |
true |
|
true |
| JSF:JAVADOC:2376 |
String |
jakarta.faces.view.facelets.TagAttribute.getNamespace
|
The
resolved Namespace for this attribute |
true |
|
true |
| JSF:JAVADOC:2377 |
Object |
jakarta.faces.view.facelets.TagAttribute.getObject
( FaceletContext ) |
Delegates to getObject with Object.class as a param |
true |
|
true |
| JSF:JAVADOC:2378 |
Object |
jakarta.faces.view.facelets.TagAttribute.getObject
( FaceletContext ,
Class ) |
If
literal, simply coerce our String literal value using an
ExpressionFactory, otherwise create a ValueExpression and evaluate it.
|
true |
|
true |
| JSF:JAVADOC:2379 |
String |
jakarta.faces.view.facelets.TagAttribute.getQName
|
The
qualified name for this attribute |
true |
|
true |
| JSF:JAVADOC:2380 |
String |
jakarta.faces.view.facelets.TagAttribute.getValue
|
Return
the literal value of this attribute |
true |
|
true |
| JSF:JAVADOC:2381 |
String |
jakarta.faces.view.facelets.TagAttribute.getValue
( FaceletContext ) |
If
literal, then return our value, otherwise delegate to getObject,
passing String.class. |
true |
|
true |
| JSF:JAVADOC:2382 |
ValueExpression |
jakarta.faces.view.facelets.TagAttribute.getValueExpression
( FaceletContext ,
Class ) |
Create
a ValueExpression, using this attribute's literal value and the passed
expected type. |
true |
|
true |
| JSF:JAVADOC:2383 |
boolean |
jakarta.faces.view.facelets.TagAttribute.isLiteral
|
If this
TagAttribute is literal (not #{..} or ${..}) |
true |
|
true |
| JSF:JAVADOC:2384 |
TagAttribute |
jakarta.faces.view.facelets.TagAttribute.TagAttribute
|
|
true |
|
true |
| JSF:JAVADOC:2385 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( TagAttribute ) |
|
true |
|
true |
| JSF:JAVADOC:2386 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( TagAttribute ,
String ) |
|
true |
|
true |
| JSF:JAVADOC:2387 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( TagAttribute ,
Throwable ) |
|
true |
|
true |
| JSF:JAVADOC:2388 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( TagAttribute ,
String ,
Throwable ) |
|
true |
|
true |
| JSF:JAVADOC:2389 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( Tag ,
TagAttribute ) |
|
true |
|
true |
| JSF:JAVADOC:2390 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( Tag ,
TagAttribute ,
String ) |
|
true |
|
true |
| JSF:JAVADOC:2391 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( Tag ,
TagAttribute ,
Throwable ) |
|
true |
|
true |
| JSF:JAVADOC:2392 |
TagAttributeException |
jakarta.faces.view.facelets.TagAttributeException.TagAttributeException
( Tag ,
TagAttribute ,
String ,
Throwable ) |
|
true |
|
true |
| JSF:JAVADOC:2393 |
TagAttribute |
jakarta.faces.view.facelets.TagAttributes.get
( String ) |
Using
no namespace, find the TagAttribute |
true |
|
true |
| JSF:JAVADOC:2394 |
TagAttribute |
jakarta.faces.view.facelets.TagAttributes.get
( String ,
String ) |
Find a
TagAttribute that matches the passed namespace and local name. |
true |
|
true |
| JSF:JAVADOC:2395 |
TagAttribute[] |
jakarta.faces.view.facelets.TagAttributes.getAll
|
Return
an array of all TagAttributes in this set |
true |
|
true |
| JSF:JAVADOC:2396 |
TagAttribute[] |
jakarta.faces.view.facelets.TagAttributes.getAll
( String ) |
Get all
TagAttributes for the passed namespace |
true |
|
true |
| JSF:JAVADOC:2397 |
String[] |
jakarta.faces.view.facelets.TagAttributes.getNamespaces
|
A list
of Namespaces found in this set |
true |
|
true |
| JSF:JAVADOC:2398 |
TagAttributes |
jakarta.faces.view.facelets.TagAttributes.TagAttributes
|
|
true |
|
true |
| JSF:JAVADOC:2399 |
FaceletHandler |
jakarta.faces.view.facelets.TagConfig.getNextHandler
|
The
next FaceletHandler (child or children) to be applied. This must never
be null. |
true |
|
true |
| JSF:JAVADOC:2400 |
Tag |
jakarta.faces.view.facelets.TagConfig.getTag
|
Return
the Tag representing this handler. |
true |
|
true |
| JSF:JAVADOC:2401 |
String |
jakarta.faces.view.facelets.TagConfig.getTagId
|
A
document-unique id, follows the convention "_tagId##" |
true |
|
true |
| JSF:JAVADOC:2402 |
Tag |
jakarta.faces.view.facelets.TagDecorator.decorate
( Tag ) |
If
handled, return a new Tag instance, otherwise return null |
true |
|
true |
| JSF:JAVADOC:2403 |
TagException |
jakarta.faces.view.facelets.TagException.TagException
( Tag ) |
Wrap
the argument tag so the exception can reference its information. |
true |
|
true |
| JSF:JAVADOC:2404 |
TagException |
jakarta.faces.view.facelets.TagException.TagException
( Tag ,
String ) |
Wrap
the argument tag so the exception can reference its information. |
true |
|
true |
| JSF:JAVADOC:2405 |
TagException |
jakarta.faces.view.facelets.TagException.TagException
( Tag ,
Throwable ) |
Wrap
the argument tag so the exception can reference its information. |
true |
|
true |
| JSF:JAVADOC:2406 |
TagException |
jakarta.faces.view.facelets.TagException.TagException
( Tag ,
String ,
Throwable ) |
Wrap
the argument tag so the exception can reference its information. |
true |
|
true |
| JSF:JAVADOC:2407 |
TagHandler |
jakarta.faces.view.facelets.TagHandler.TagHandler
( TagConfig ) |
Every
TagHandler instance is associated with a Tag. Each Tag instance has a
TagAttributes property, which is simply a collection of TagAttribute
instances. Extract and save as protected instance variables the
TagConfig#getTagId, TagConfig#getTag and TagConfig#getNextHandler
returns from the argument TagConfig. This constructor is only called
when the Facelets View is compiled. |
true |
|
true |
| JSF:JAVADOC:2408 |
String |
jakarta.faces.view.facelets.TagHandler.toString
|
|
true |
|
true |
| JSF:JAVADOC:2409 |
void |
jakarta.faces.view.facelets.TagHandlerDelegate.apply
( FaceletContext ,
UIComponent ) |
Called
by classes that implement jakarta.faces.view.facelets.FaceletHandler in
their implementation of apply(). |
true |
|
true |
| JSF:JAVADOC:2410 |
void |
jakarta.faces.view.facelets.TagHandlerDelegate.apply
( FaceletContext ,
UIComponent )
throws IOException
|
|
true |
|
true |
| JSF:JAVADOC:2411 |
MetaRuleset |
jakarta.faces.view.facelets.TagHandlerDelegate.createMetaRuleset
( Class ) |
Return
a MetaRuleset particular to this kind of tag handler. Called from
classes that implement MetaTagHandler. |
true |
|
true |
| JSF:JAVADOC:2412 |
TagHandlerDelegate |
jakarta.faces.view.facelets.TagHandlerDelegate.TagHandlerDelegate
|
|
true |
|
true |
| JSF:JAVADOC:2413 |
TagHandlerDelegate |
jakarta.faces.view.facelets.TagHandlerDelegateFactory.createBehaviorHandlerDelegate
( BehaviorHandler ) |
Create
and return a TagHandlerDelegate instance designed for use with
BehaviorHandler. |
true |
|
true |
| JSF:JAVADOC:2414 |
TagHandlerDelegate |
jakarta.faces.view.facelets.TagHandlerDelegateFactory.createComponentHandlerDelegate
( ComponentHandler ) |
Create
and return a TagHandlerDelegate instance designed for use with
ComponentHandler. |
true |
|
true |
| JSF:JAVADOC:2415 |
TagHandlerDelegate |
jakarta.faces.view.facelets.TagHandlerDelegateFactory.createConverterHandlerDelegate
( ConverterHandler ) |
Create
and return a TagHandlerDelegate instance designed for use with
ConverterHandler. |
true |
|
true |
| JSF:JAVADOC:2416 |
TagHandlerDelegate |
jakarta.faces.view.facelets.TagHandlerDelegateFactory.createValidatorHandlerDelegate
( ValidatorHandler ) |
Create
and return a TagHandlerDelegate instance designed for use with
ValidatorHandler. |
true |
|
true |
| JSF:JAVADOC:2417 |
TagHandlerDelegateFactory |
jakarta.faces.view.facelets.TagHandlerDelegateFactory.TagHandlerDelegateFactory
|
|
true |
|
true |
| JSF:JAVADOC:2418 |
String |
jakarta.faces.view.facelets.TextHandler.getText
|
Returns
the literal String value of the contained text. |
true |
|
true |
| JSF:JAVADOC:2419 |
String |
jakarta.faces.view.facelets.TextHandler.getText
( FaceletContext ) |
Returns
the resolved literal String value of the contained text after
evaluating EL. |
true |
|
true |
| JSF:JAVADOC:2420 |
String |
jakarta.faces.view.facelets.ValidatorConfig.getValidatorId
|
Return
the validator-id associated with a particular validator in your
faces-config |
true |
|
true |
| JSF:JAVADOC:2421 |
ValidatorConfig |
jakarta.faces.view.facelets.ValidatorHandler.getValidatorConfig
|
Return
the TagConfig subclass used to configure this handler instance. |
true |
|
true |
| JSF:JAVADOC:2422 |
String |
jakarta.faces.view.facelets.ValidatorHandler.getValidatorId
( FaceletContext ) |
Retrieve the id of the validator that is to be created and added to
the parent EditableValueHolder. All subclasses should override this
method because it is important for Facelets to have a unique way of
identifying the validators that are added to this EditableValueHolder
and allows exclusions to work properly. An exclusion is a validator
declaration that has the attribute "disabled" which resolves to false,
instructing Facelets not to register a default validator with the same
id. |
true |
|
true |
| JSF:JAVADOC:2423 |
ValidatorHandler |
jakarta.faces.view.facelets.ValidatorHandler.ValidatorHandler
( ValidatorConfig ) |
Construct this instance around the configuration information in
argument config |
true |
|
true |
| JSF:JAVADOC:2424 |
AttributeTag |
jakarta.faces.webapp.AttributeTag.AttributeTag
|
|
true |
true |
true |
| JSF:JAVADOC:2425 |
int |
jakarta.faces.webapp.AttributeTag.doEndTag
|
|
true |
true |
true |
| JSF:JAVADOC:2426 |
int |
jakarta.faces.webapp.AttributeTag.doEndTag
throws JspException
|
|
true |
true |
true |
| JSF:JAVADOC:2427 |
int |
jakarta.faces.webapp.AttributeTag.doStartTag
|
Register the specified attribute name and value with the UIComponent
instance associated with our most immediately surrounding
UIComponentTag instance, if this UIComponent does not already have a
value for the specified attribute name. |
true |
true |
true |
| JSF:JAVADOC:2428 |
int |
jakarta.faces.webapp.AttributeTag.doStartTag
throws JspException
|
if a JSP
error occurs |
true |
true |
true |
| JSF:JAVADOC:2429 |
void |
jakarta.faces.webapp.AttributeTag.release
|
Release
references to any acquired resources. |
true |
true |
true |
| JSF:JAVADOC:2430 |
void |
jakarta.faces.webapp.AttributeTag.setName
( String ) |
Set the
attribute name. |
true |
true |
true |
| JSF:JAVADOC:2431 |
void |
jakarta.faces.webapp.AttributeTag.setValue
( String ) |
Set the
attribute value. |
true |
true |
true |
| JSF:JAVADOC:2432 |
ConverterELTag |
jakarta.faces.webapp.ConverterELTag.ConverterELTag
|
|
true |
|
true |
| JSF:JAVADOC:2433 |
int |
jakarta.faces.webapp.ConverterELTag.doStartTag
|
Create
a new instance of the specified 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 JSP page. If
the localValue of the UIComponent is a String, attempt to convert it.
|
true |
|
true |
| JSF:JAVADOC:2434 |
int |
jakarta.faces.webapp.ConverterELTag.doStartTag
throws JspException
|
if a JSP
error occurs |
true |
|
true |
| JSF:JAVADOC:2435 |
ConverterTag |
jakarta.faces.webapp.ConverterTag.ConverterTag
|
|
true |
true |
true |
| JSF:JAVADOC:2436 |
int |
jakarta.faces.webapp.ConverterTag.doStartTag
|
Create
a new instance of the specified 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 JSP page. If the
localValue of the UIComponent is a String, attempt to convert it. |
true |
true |
true |
| JSF:JAVADOC:2437 |
int |
jakarta.faces.webapp.ConverterTag.doStartTag
throws JspException
|
if a JSP
error occurs |
true |
true |
true |
| JSF:JAVADOC:2438 |
void |
jakarta.faces.webapp.ConverterTag.release
|
Release
references to any acquired resources. |
true |
true |
true |
| JSF:JAVADOC:2439 |
void |
jakarta.faces.webapp.ConverterTag.setBinding
( String ) |
Set the
expression that will be used to create a ValueExpression that
references a backing bean property of the Converter instance to be
created. |
true |
true |
true |
| JSF:JAVADOC:2440 |
void |
jakarta.faces.webapp.ConverterTag.setBinding
( String )
throws JspException
|
if a JSP
error occurs |
true |
true |
true |
| JSF:JAVADOC:2441 |
void |
jakarta.faces.webapp.ConverterTag.setConverterId
( String ) |
Set the
identifer of the Converter instance to be created. |
true |
true |
true |
| JSF:JAVADOC:2442 |
void |
jakarta.faces.webapp.FacesServlet.destroy
|
Release
all resources acquired at startup time. |
true |
|
true |
| JSF:JAVADOC:2443 |
FacesServlet |
jakarta.faces.webapp.FacesServlet.FacesServlet
|
|
true |
|
true |
| JSF:JAVADOC:2444 |
ServletConfig |
jakarta.faces.webapp.FacesServlet.getServletConfig
|
Return
the ServletConfig instance for this servlet. |
true |
|
true |
| JSF:JAVADOC:2445 |
String |
jakarta.faces.webapp.FacesServlet.getServletInfo
|
Return
information about this Servlet. |
true |
|
true |
| JSF:JAVADOC:2446 |
void |
jakarta.faces.webapp.FacesServlet.init
( ServletConfig ) |
Acquire
the factory instances we will require. |
true |
|
true |
| JSF:JAVADOC:2447 |
void |
jakarta.faces.webapp.FacesServlet.init
( ServletConfig )
throws ServletException
|
if, for
any reason, the startup of this Faces application failed. This
includes errors in the config file that is parsed before or during the
processing of this init() method. |
true |
|
true |
| JSF:JAVADOC:2448 |
void |
jakarta.faces.webapp.FacesServlet.service
( ServletRequest ,
ServletResponse ) |
Process
an incoming request, and create the corresponding response according
to the following specification. If the request and response arguments
to this method are not instances of HttpServletRequest and
HttpServletResponse, respectively, the results of invoking this method
are undefined. This method must respond to requests that start with
the following strings by invoking the sendError method on the response
argument (cast to HttpServletResponse), passing the code
HttpServletResponse.SC_NOT_FOUND as the argument. /WEB-INF/ /WEB-INF
/META-INF/ /META-INF If none of the cases described above in the
specification for this method apply to the servicing of this request,
the following action must be taken to service the request. Acquire a
FacesContext instance for this request. Acquire the ResourceHandler
for this request by calling
jakarta.faces.application.Application#getResourceHandler. Call
jakarta.faces.application.ResourceHandler#isResourceRequest. If this
returns true call
jakarta.faces.application.ResourceHandler#handleResourceRequest. If this
returns false, call jakarta.faces.lifecycle.Lifecycle#execute followed
by jakarta.faces.lifecycle.Lifecycle#render. If a
jakarta.faces.FacesException is thrown in either case, extract the cause
from the FacesException. If the cause is null extract the message from
the FacesException, put it inside of a new ServletException instance,
and pass the FacesException instance as the root cause, then rethrow
the ServletException instance. If the cause is an instance of
ServletException, rethrow the cause. If the cause is an instance of
IOException, rethrow the cause. Otherwise, create a new
ServletException instance, passing the message from the cause, as the
first argument, and the cause itself as the second argument. In a
finally block, jakarta.faces.context.FacesContext#release must be
called. |
true |
|
true |
| JSF:JAVADOC:2449 |
void |
jakarta.faces.webapp.FacesServlet.service
( ServletRequest ,
ServletResponse )
throws IOException
|
if an
input/output error occurs during processing |
true |
|
true |
| JSF:JAVADOC:2450 |
void |
jakarta.faces.webapp.FacesServlet.service
( ServletRequest ,
ServletResponse )
throws ServletException
|
if a
servlet error occurs during processing |
true |
|
true |
| JSF:JAVADOC:2451 |
int |
jakarta.faces.webapp.FacetTag.doStartTag
|
Return
EVAL_BODY_INCLUDE to cause nested body content to be evaluated. |
true |
|
true |
| JSF:JAVADOC:2452 |
int |
jakarta.faces.webapp.FacetTag.doStartTag
throws JspException
|
|
true |
|
true |
| JSF:JAVADOC:2453 |
FacetTag |
jakarta.faces.webapp.FacetTag.FacetTag
|
|
true |
|
true |
| JSF:JAVADOC:2454 |
String |
jakarta.faces.webapp.FacetTag.getName
|
Return
the name to be assigned to this facet. |
true |
|
true |
| JSF:JAVADOC:2455 |
void |
jakarta.faces.webapp.FacetTag.release
|
Release
any resources allocated by this tag instance. |
true |
|
true |
| JSF:JAVADOC:2456 |
void |
jakarta.faces.webapp.FacetTag.setName
( String ) |
Set the
name to be assigned to this facet. |
true |
|
true |
| JSF:JAVADOC:2457 |
ExceptionHandler |
jakarta.faces.webapp.PreJsf2ExceptionHandlerFactory.getExceptionHandler
|
Create
and return a A new ExceptionHandler instance. The implementation must
return an ExceptionHandler instance suitable for the environment. For
example, in some cases it may be desirable for an ExceptionHandler to
write error information to the response instead of throwing exceptions
as in the case of Ajax applications. |
true |
|
true |
| JSF:JAVADOC:2458 |
PreJsf2ExceptionHandlerFactory |
jakarta.faces.webapp.PreJsf2ExceptionHandlerFactory.PreJsf2ExceptionHandlerFactory
|
|
true |
|
true |
| JSF:JAVADOC:2459 |
UIComponentBodyTag |
jakarta.faces.webapp.UIComponentBodyTag.UIComponentBodyTag
|
|
true |
true |
true |
| JSF:JAVADOC:2460 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doAfterBody
|
Perform
any processing necessary to handle the content implications of CASE 4
in the class description. Return result from #getDoAfterBodyValue |
true |
|
true |
| JSF:JAVADOC:2461 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doAfterBody
throws JspException
|
if an
error is encountered |
true |
|
true |
| JSF:JAVADOC:2462 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doEndTag
|
Perform
any processing necessary to handle the content implications of CASE 3
in the class description. The default implementation, which is
intended to be sufficient for most components, calls
#createVerbatimComponentFromBodyContent on this instance and adds it
as a child of the component for this tag's component at the end of the
child list. In addition, the following housekeeping steps are taken.
Retrieve from the UIComponent the set of component ids of child
components created by UIComponentTag instances the last time this page
was processed (if any). Compare it to the list of children created
during this page processing pass, and remove all children present in
the old list but not the new. Save the new list as a component
attribute so that it gets saved as part of the component's state.
Retrieve from the UIComponent the set of facet names of facets created
by UIComponentTag instances the last time this page was processed (if
any). Compare it to the list of facets created during this page
processing pass, and remove all facets present in the old list but not
the new. Save the new list as a component attribute so that it gets
saved as part of the component's state. Release all references to the
component, and pop it from the component stack for this response,
removing the stack if this was the outermost component. The flag value
to be returned is acquired by calling the getDoEndValue() method,
which tag subclasses may override if they do not want the default
value. |
true |
|
true |
| JSF:JAVADOC:2463 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doEndTag
throws JspException
|
if an
error occurs |
true |
|
true |
| JSF:JAVADOC:2464 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.doInitBody
|
Prepare
for evaluation of the body. This method is invoked by the JSP page
implementation object after setBodyContent() and before the first time
the body is to be evaluated. This method will not be invoked for empty
tags or for non-empty tags whose doStartTag() method returns SKIP_BODY
or EVAL_BODY_INCLUDE. |
true |
|
true |
| JSF:JAVADOC:2465 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.doInitBody
throws JspException
|
if an
error is encountered |
true |
|
true |
| JSF:JAVADOC:2466 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doStartTag
|
Perform
any processing necessary to find (or create) the 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. Secondarily, cause a
transient UIOutput component to be created and placed in the tree
before the UIComponent instance for this tag. The value of this
UIOutput component must include anything covered by CASE 1 or CASE 2
in the class description. The default implementation, which is
intended to be sufficient for most components, implements this
secondary requirement by calling #getParentUIComponentClassicTagBase,
and calling #createVerbatimComponentFromBodyContent on the result. It
then adds the returned component to the tree before the actual
component for this tag instance instance by calling
#addVerbatimBeforeComponent. Before returning, the component is pushed
onto the component stack for this response to enable the
#getParentUIComponentClassicTagBase method to work properly. The flag
value to be returned is acquired by calling the getDoStartValue()
method, which tag subclasses may override if they do not want the
default value. |
true |
|
true |
| JSF:JAVADOC:2467 |
int |
jakarta.faces.webapp.UIComponentClassicTagBase.doStartTag
throws JspException
|
if an
error occurs |
true |
|
true |
| JSF:JAVADOC:2468 |
BodyContent |
jakarta.faces.webapp.UIComponentClassicTagBase.getBodyContent
|
|
true |
|
true |
| JSF:JAVADOC:2469 |
UIComponent |
jakarta.faces.webapp.UIComponentClassicTagBase.getComponentInstance
|
Return
the UIComponent instance that is associated with this tag instance.
This method is designed to be used by tags nested within this tag, and
only returns useful results between the execution of doStartTag() and
doEndTag() on this tag instance. |
true |
|
true |
| JSF:JAVADOC:2470 |
boolean |
jakarta.faces.webapp.UIComponentClassicTagBase.getCreated
|
Return
true if we dynamically created a new component instance during
execution of this tag. This method is designed to be used by tags
nested within this tag, and only returns useful results between the
execution of doStartTag() and doEndTag() on this tag instance. |
true |
|
true |
| JSF:JAVADOC:2471 |
String |
jakarta.faces.webapp.UIComponentClassicTagBase.getJspId
|
|
true |
|
true |
| JSF:JAVADOC:2472 |
Tag |
jakarta.faces.webapp.UIComponentClassicTagBase.getParent
|
Return
the Tag that is the parent of this instance. |
true |
|
true |
| JSF:JAVADOC:2473 |
UIComponentClassicTagBase |
jakarta.faces.webapp.UIComponentClassicTagBase.getParentUIComponentClassicTagBase
( PageContext ) |
Locate
and return the nearest enclosing UIComponentClassicTagBase if any;
otherwise, return null. |
true |
|
true |
| JSF:JAVADOC:2474 |
JspWriter |
jakarta.faces.webapp.UIComponentClassicTagBase.getPreviousOut
|
Get the
JspWriter from our BodyContent. |
true |
|
true |
| JSF:JAVADOC:2475 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.release
|
Release
any resources allocated during the execution of this tag handler. |
true |
|
true |
| JSF:JAVADOC:2476 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setBodyContent
( BodyContent ) |
Set the
bodyContent for this tag handler. This method is invoked by the JSP
page implementation object at most once per action invocation, before
doInitiBody(). This method will not be invoked for empty tags or for
non-empty tags whose doStartTag() method returns SKIP_BODY or
EVAL_BODY_INCLUDE. |
true |
|
true |
| JSF:JAVADOC:2477 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setId
( String ) |
Set the
component identifier for our component. If the argument begins with
UIViewRoot#UNIQUE_ID_PREFIX throw an IllegalArgumentException |
true |
|
true |
| JSF:JAVADOC:2478 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setId
( String )
throws IllegalArgumentException
|
if the
argument is non-null and starts with UIViewRoot#UNIQUE_ID_PREFIX. |
true |
|
true |
| JSF:JAVADOC:2479 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setJspId
( String ) |
Defined
on JspIdConsumer. This method is called by the container before
#doStartTag. The argument is guaranteed to be unique within the page.
IMPLEMENTATION NOTE: This method will detect where we are in an
include and assign a unique ID for each include in a particular
'logical page'. This allows us to avoid possible duplicate ID
situations for included pages that have components without explicit
IDs. |
true |
|
true |
| JSF:JAVADOC:2480 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setPageContext
( PageContext ) |
Set the
PageContext of the page containing this tag instance. |
true |
|
true |
| JSF:JAVADOC:2481 |
void |
jakarta.faces.webapp.UIComponentClassicTagBase.setParent
( Tag ) |
Set the
Tag that is the parent of this instance. |
true |
|
true |
| JSF:JAVADOC:2482 |
UIComponentClassicTagBase |
jakarta.faces.webapp.UIComponentClassicTagBase.UIComponentClassicTagBase
|
|
true |
|
true |
| JSF:JAVADOC:2483 |
void |
jakarta.faces.webapp.UIComponentELTag.release
|
Release
any resources allocated during the execution of this tag handler. |
true |
|
true |
| JSF:JAVADOC:2484 |
void |
jakarta.faces.webapp.UIComponentELTag.setBinding
( ValueExpression ) |
Set the
value expression for our component. |
true |
|
true |
| JSF:JAVADOC:2485 |
void |
jakarta.faces.webapp.UIComponentELTag.setBinding
( ValueExpression )
throws JspException
|
if an
error occurs |
true |
|
true |
| JSF:JAVADOC:2486 |
void |
jakarta.faces.webapp.UIComponentELTag.setRendered
( ValueExpression ) |
Set an
override for the rendered attribute. |
true |
|
true |
| JSF:JAVADOC:2487 |
UIComponentELTag |
jakarta.faces.webapp.UIComponentELTag.UIComponentELTag
|
|
true |
|
true |
| JSF:JAVADOC:2488 |
UIComponentTag |
jakarta.faces.webapp.UIComponentTag.getParentUIComponentTag
( PageContext ) |
Locate
and return the nearest enclosing UIComponentTag if any; otherwise,
return null. |
true |
true |
true |
| JSF:JAVADOC:2489 |
boolean |
jakarta.faces.webapp.UIComponentTag.isValueReference
( String ) |
Return
true if the specified value conforms to the syntax requirements of a
value binding expression. Such expressions ` * may be used on most
component tag attributes to signal a desire for deferred evaluation of
the attribute or property value to be set on the underlying
UIComponent. |
true |
true |
true |
| JSF:JAVADOC:2490 |
boolean |
jakarta.faces.webapp.UIComponentTag.isValueReference
( String )
throws NullPointerException
|
if value
is null |
true |
true |
true |
| JSF:JAVADOC:2491 |
void |
jakarta.faces.webapp.UIComponentTag.release
|
Release
any resources allocated during the execution of this tag handler. |
true |
true |
true |
| JSF:JAVADOC:2492 |
void |
jakarta.faces.webapp.UIComponentTag.setBinding
( String ) |
Set the
value binding expression for our component. |
true |
true |
true |
| JSF:JAVADOC:2493 |
void |
jakarta.faces.webapp.UIComponentTag.setBinding
( String )
throws JspException
|
|
true |
true |
true |
| JSF:JAVADOC:2494 |
void |
jakarta.faces.webapp.UIComponentTag.setBinding
( String )
throws IllegalArgumentException
|
if the
specified binding is not a valid value binding expression. |
true |
true |
true |
| JSF:JAVADOC:2495 |
void |
jakarta.faces.webapp.UIComponentTag.setRendered
( String ) |
Set an
override for the rendered attribute. |
true |
true |
true |
| JSF:JAVADOC:2496 |
UIComponentTag |
jakarta.faces.webapp.UIComponentTag.UIComponentTag
|
|
true |
true |
true |
| JSF:JAVADOC:2497 |
UIComponent |
jakarta.faces.webapp.UIComponentTagBase.getComponentInstance
|
Return
the UIComponent instance that is associated with this tag instance.
This method is designed to be used by tags nested within this tag, and
only returns useful results between the execution of doStartTag() and
doEndTag() on this tag instance. |
true |
|
true |
| JSF:JAVADOC:2498 |
String |
jakarta.faces.webapp.UIComponentTagBase.getComponentType
|
Return
the component type for the component that is or will be bound to this
tag. This value can be passed to
jakarta.faces.application.Application#createComponent to create the
UIComponent instance for this tag. Subclasses must override this
method to return the appropriate value. |
true |
|
true |
| JSF:JAVADOC:2499 |
boolean |
jakarta.faces.webapp.UIComponentTagBase.getCreated
|
Return
true if we dynamically created a new component instance during
execution of this tag. This method is designed to be used by tags
nested within this tag, and only returns useful results between the
execution of doStartTag() and doEndTag() on this tag instance. |
true |
|
true |
| JSF:JAVADOC:2500 |
String |
jakarta.faces.webapp.UIComponentTagBase.getRendererType
|
Return
the rendererType property that selects the Renderer to be used for
encoding this component, or null to ask the component to render itself
directly. Subclasses must override this method to return the
appropriate value. |
true |
|
true |
| JSF:JAVADOC:2501 |
void |
jakarta.faces.webapp.UIComponentTagBase.setId
( String ) |
Set the
component identifier for the component corresponding to this tag
instance. If the argument begins with
jakarta.faces.component.UIViewRoot#UNIQUE_ID_PREFIX throw an
IllegalArgumentException |
true |
|
true |
| JSF:JAVADOC:2502 |
void |
jakarta.faces.webapp.UIComponentTagBase.setId
( String )
throws IllegalArgumentException
|
if the
argument is non-null and starts with
jakarta.faces.component.UIViewRoot#UNIQUE_ID_PREFIX. |
true |
|
true |
| JSF:JAVADOC:2503 |
UIComponentTagBase |
jakarta.faces.webapp.UIComponentTagBase.UIComponentTagBase
|
|
true |
|
true |
| JSF:JAVADOC:2504 |
int |
jakarta.faces.webapp.ValidatorELTag.doStartTag
|
Create
a new instance of the specified 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 JSP page. |
true |
|
true |
| JSF:JAVADOC:2505 |
int |
jakarta.faces.webapp.ValidatorELTag.doStartTag
throws JspException
|
if a JSP
error occurs |
true |
|
true |
| JSF:JAVADOC:2506 |
ValidatorELTag |
jakarta.faces.webapp.ValidatorELTag.ValidatorELTag
|
|
true |
|
true |
| JSF:JAVADOC:2507 |
int |
jakarta.faces.webapp.ValidatorTag.doStartTag
|
Create
a new instance of the specified 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 JSP page. |
true |
true |
true |
| JSF:JAVADOC:2508 |
int |
jakarta.faces.webapp.ValidatorTag.doStartTag
throws JspException
|
if a JSP
error occurs |
true |
true |
true |
| JSF:JAVADOC:2509 |
void |
jakarta.faces.webapp.ValidatorTag.release
|
Release
references to any acquired resources. |
true |
true |
true |
| JSF:JAVADOC:2510 |
void |
jakarta.faces.webapp.ValidatorTag.setBinding
( String ) |
Set the
expression that will be used to create a ValueExpression that
references a backing bean property of the Validator instance to be
created. |
true |
true |
true |
| JSF:JAVADOC:2511 |
void |
jakarta.faces.webapp.ValidatorTag.setBinding
( String )
throws JspException
|
if a JSP
error occurs |
true |
true |
true |
| JSF:JAVADOC:2512 |
void |
jakarta.faces.webapp.ValidatorTag.setValidatorId
( String ) |
Set the
identifer of the Validator instance to be created. |
true |
true |
true |
| JSF:JAVADOC:2513 |
ValidatorTag |
jakarta.faces.webapp.ValidatorTag.ValidatorTag
|
|
true |
true |
true |