public abstract class RenderKitFactory extends Object implements FacesWrapper<RenderKitFactory>
RenderKitFactory is a
factory object that registers
and returns RenderKit
instances. Implementations of
JavaServer 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 JavaServer Faces. This instance can be
acquired, in a portable manner, by calling:
RenderKitFactory factory = (RenderKitFactory) FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
Modifier and Type | Field and Description |
---|---|
static String |
HTML_BASIC_RENDER_KIT
The render kit identifier of the default
RenderKit instance
for this JavaServer Faces implementation. |
Constructor and Description |
---|
RenderKitFactory() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addRenderKit(String renderKitId,
RenderKit 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. |
abstract RenderKit |
getRenderKit(FacesContext context,
String renderKitId)
Return a
RenderKit instance for the specified render
kit identifier, possibly customized based on dynamic
characteristics of the specified FacesContext , if
non-null . |
abstract Iterator<String> |
getRenderKitIds()
Return an
Iterator 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. |
public static final String HTML_BASIC_RENDER_KIT
The render kit identifier of the default RenderKit
instance
for this JavaServer Faces implementation.
public 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
.
getWrapped
in interface FacesWrapper<RenderKitFactory>
public abstract void addRenderKit(String renderKitId, RenderKit 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.
renderKitId
- Identifier of the RenderKit
to registerrenderKit
- RenderKit
instance that we are registeringNullPointerException
- if renderKitId
or
renderKit
is null
public abstract RenderKit getRenderKit(FacesContext context, String renderKitId)
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.
context
- FacesContext for the request currently being
processed, or null
if none is available.renderKitId
- Render kit identifier of the requested
RenderKit
instanceIllegalArgumentException
- if no RenderKit
instance
can be returned for the specified identifierNullPointerException
- if renderKitId
is
null
Copyright © 2016 JBoss by Red Hat. All rights reserved.