Class RenderKitFactory
- All Implemented Interfaces:
FacesWrapper<RenderKitFactory>
- Direct Known Subclasses:
RenderKitFactoryImpl
public abstract class RenderKitFactory extends Object implements FacesWrapper<RenderKitFactory>
RenderKitFactory is a factory object that
registers and returns RenderKit
instances. Implementations of Jakarta Server Faces must provide at least a
default implementation of RenderKit
. Advanced implementations (or external third party libraries) may provide
additional RenderKit
implementations (keyed by render kit identifiers) for performing different types of
rendering for the same components.
There must be one RenderKitFactory
instance per web application that is utilizing Jakarta Server Faces. This
instance can be acquired, in a portable manner, by calling:
RenderKitFactory factory = (RenderKitFactory) FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
-
Field Summary
Fields Modifier and Type Field Description static String
HTML_BASIC_RENDER_KIT
The render kit identifier of the defaultRenderKit
instance for this Jakarta Server Faces implementation. -
Constructor Summary
Constructors Constructor Description RenderKitFactory()
Deprecated.Use the other constructor taking the implementation being wrapped.RenderKitFactory(RenderKitFactory wrapped)
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. -
Method Summary
Modifier and Type Method Description abstract void
addRenderKit(String renderKitId, RenderKit renderKit)
Register the specifiedRenderKit
instance, associated with the specifiedrenderKitId
, to be supported by thisRenderKitFactory
, replacing any previously registeredRenderKit
for this identifier.abstract RenderKit
getRenderKit(FacesContext context, String renderKitId)
Return aRenderKit
instance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specifiedFacesContext
, if non-null
.abstract Iterator<String>
getRenderKitIds()
Return anIterator
over the set of render kit identifiers registered with this factory.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.
-
Field Details
-
HTML_BASIC_RENDER_KIT
The render kit identifier of the default
RenderKit
instance for this Jakarta Server Faces implementation.- See Also:
- Constant Field Values
-
-
Constructor Details
-
RenderKitFactory
Deprecated.Use the other constructor taking the implementation being wrapped. -
RenderKitFactory
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The
getWrapped()
will then return the implementation being wrapped.- Parameters:
wrapped
- The implementation being wrapped.
-
-
Method Details
-
getWrapped
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<RenderKitFactory>
- Returns:
- the wrapped instance.
- Since:
- 2.0
-
addRenderKit
Register the specified
RenderKit
instance, associated with the specifiedrenderKitId
, to be supported by thisRenderKitFactory
, replacing any previously registeredRenderKit
for this identifier.- Parameters:
renderKitId
- Identifier of theRenderKit
to registerrenderKit
-RenderKit
instance that we are registering- Throws:
NullPointerException
- ifrenderKitId
orrenderKit
isnull
-
getRenderKit
Return a
RenderKit
instance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specifiedFacesContext
, if non-null
. If there is no registeredRenderKit
for the specified identifier, returnnull
. The set of available render kit identifiers is available via thegetRenderKitIds()
method.- Parameters:
context
- FacesContext for the request currently being processed, ornull
if none is available.renderKitId
- Render kit identifier of the requestedRenderKit
instance- Returns:
- a
RenderKit
instance - Throws:
IllegalArgumentException
- if noRenderKit
instance can be returned for the specified identifierNullPointerException
- ifrenderKitId
isnull
-
getRenderKitIds
Return an
Iterator
over the set of render kit identifiers registered with this factory. This set must include the value specified byRenderKitFactory.HTML_BASIC_RENDER_KIT
.- Returns:
- an
Iterator
over the set of render kit identifiers
-