|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.render.RenderKit
javax.faces.render.RenderKitWrapper
public abstract class RenderKitWrapper
Provides a simple implementation of
RenderKit
that
can be subclassed by developers wishing to provide specialized
behavior to an existing RenderKit
instance. The default
implementation of all methods is to call through to the wrapped
RenderKit
.
Usage: extend this class and override getWrapped()
to
return the instance we are wrapping.
Constructor Summary | |
---|---|
RenderKitWrapper()
|
Method Summary | |
---|---|
void |
addRenderer(String family,
String rendererType,
Renderer renderer)
Register the specified Renderer instance, associated with the
specified component family and rendererType ,
to the set of Renderer s registered with this RenderKit ,
replacing any previously registered Renderer for this
combination of identifiers. |
ResponseStream |
createResponseStream(OutputStream out)
Use the provided OutputStream to create a new
ResponseStream instance. |
ResponseWriter |
createResponseWriter(Writer writer,
String contentTypeList,
String characterEncoding)
Use the provided Writer to create a new ResponseWriter instance for the specified (optional) content
type, and character encoding. |
Iterator<String> |
getComponentFamilies()
Return an |
Renderer |
getRenderer(String family,
String rendererType)
Return the Renderer instance most recently registered for
the specified component family and
rendererType , if any; otherwise, return
null . |
Iterator<String> |
getRendererTypes(String componentFamily)
Return an |
ResponseStateManager |
getResponseStateManager()
Return an instance of ResponseStateManager to handle
rendering technology specific state management decisions. |
abstract RenderKit |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RenderKitWrapper()
Method Detail |
---|
public void addRenderer(String family, String rendererType, Renderer renderer)
RenderKit
Register the specified Renderer
instance, associated with the
specified component family
and rendererType
,
to the set of Renderer
s registered with this RenderKit
,
replacing any previously registered Renderer
for this
combination of identifiers.
addRenderer
in class RenderKit
family
- Component family of the Renderer
to registerrendererType
- Renderer type of the Renderer
to registerrenderer
- Renderer
instance we are registeringpublic ResponseStream createResponseStream(OutputStream out)
RenderKit
Use the provided OutputStream
to create a new
ResponseStream
instance.
createResponseStream
in class RenderKit
public ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding)
RenderKit
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 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.
createResponseWriter
in class RenderKit
writer
- the Writer around which this ResponseWriter
must be built.contentTypeList
- an "Accept header style" list of content
types for this response, or null
if the RenderKit
should choose the best fit. As of the current version, the
values accepted by the Standard render-kit for this parameter
include any valid "Accept header style" String that includes the
String text/html
,
application/xhtml+xml
, application/xml
or text/xml
. This may change in a future version.
The RenderKit must support a value for this argument that comes
straight from the Accept
HTTP header, and therefore
requires parsing according to the specification of the
Accept
header. Please see Section
14.1 of RFC 2616 for the specification of the
Accept
header.characterEncoding
- such as "ISO-8859-1" for this
ResponseWriter, or null
if the
RenderKit
should choose the best fit. Please see the
IANA for a list of character encodings.
ResponseWriter
.public Renderer getRenderer(String family, String rendererType)
RenderKit
Return the Renderer
instance most recently registered for
the specified component family
and
rendererType
, if any; otherwise, return
null
.
getRenderer
in class RenderKit
family
- Component family of the requested
Renderer
instancerendererType
- Renderer type of the requested
Renderer
instancepublic ResponseStateManager getResponseStateManager()
RenderKit
Return an instance of ResponseStateManager
to handle
rendering technology specific state management decisions.
getResponseStateManager
in class RenderKit
public abstract RenderKit getWrapped()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<RenderKit>
public Iterator<String> getComponentFamilies()
RenderKit
Return an Iterator
over
the component-family entries supported by this
RenderKit
instance.
The default implementation of this method returns an empty
Iterator
getComponentFamilies
in class RenderKit
public Iterator<String> getRendererTypes(String componentFamily)
RenderKit
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
getRendererTypes
in class RenderKit
componentFamily
- one of the members of the
Iterator
returned by RenderKit.getComponentFamilies()
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |