Top Description Fields Constructors Methods
javax.faces.render

public abstract Class RenderKitWrapper

extends RenderKit
implements FacesWrapper<RenderKit>
Class Inheritance
All Implemented Interfaces
javax.faces.FacesWrapper
Imports
java.io.OutputStream, .Writer, java.util.Iterator, javax.faces.FacesWrapper, javax.faces.context.ResponseStream, .ResponseWriter

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.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.0

Field Summary

Modifier and TypeField and Description
private RenderKit

Constructor Summary

AccessConstructor and Description
public
RenderKitWrapper()

Deprecated Use the other constructor taking the implementation being wrapped.
public
RenderKitWrapper(RenderKit
The implementation being wrapped.
wrapped
)

If this render kit has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public void
addClientBehaviorRenderer(String
type of the ClientBehaviorRenderer to register
type
,
ClientBehaviorRenderer
ClientBehaviorRenderer instance we are registering
renderer
)

Overrides javax.faces.render.RenderKit.addClientBehaviorRenderer.

The default behavior of this method is to call RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer) on the wrapped RenderKit object.

public void
addRenderer(String
Component family of the Renderer to register
family
,
String
Renderer type of the Renderer to register
rendererType
,
Renderer
Renderer instance we are registering
renderer
)

Implements abstract javax.faces.render.RenderKit.addRenderer.

The default behavior of this method is to call RenderKit#addRenderer(String, String, Renderer) on the wrapped RenderKit object.

public ResponseStream
createResponseStream(OutputStream
the OutputStream around which to create the ResponseStream
out
)

Implements abstract javax.faces.render.RenderKit.createResponseStream.

The default behavior of this method is to call RenderKit#createResponseStream(java.io.OutputStream) on the wrapped RenderKit object.

public ResponseWriter
createResponseWriter(Writer
the Writer around which this ResponseWriter must be built.
writer
,
String
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.
contentTypeList
,
String
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.
characterEncoding
)

Implements abstract javax.faces.render.RenderKit.createResponseWriter.

The default behavior of this method is to call RenderKit#createResponseWriter(java.io.Writer, String, String) on the wrapped RenderKit object.

public ClientBehaviorRenderer
getClientBehaviorRenderer(String
type of the requested ClientBehaviorRenderer instance
type
)

Overrides javax.faces.render.RenderKit.getClientBehaviorRenderer.

The default behavior of this method is to call RenderKit#getClientBehaviorRenderer(String) on the wrapped RenderKit object.

public Iterator<String>
public Iterator<String>
getComponentFamilies()

Overrides javax.faces.render.RenderKit.getComponentFamilies.

The default behavior of this method is to call javax.faces.render.RenderKit#getComponentFamilies() on the wrapped RenderKit object.

public Renderer
getRenderer(String
Component family of the requested Renderer instance
family
,
String
Renderer type of the requested Renderer instance
rendererType
)

Implements abstract javax.faces.render.RenderKit.getRenderer.

The default behavior of this method is to call RenderKit#getRenderer(String, String) on the wrapped RenderKit object.

public Iterator<String>
getRendererTypes(String
one of the members of the Iterator returned by getComponentFamilies.
componentFamily
)

Overrides javax.faces.render.RenderKit.getRendererTypes.

The default behavior of this method is to call RenderKit#getRendererTypes(String) on the wrapped RenderKit object.

public ResponseStateManager
getResponseStateManager()

Implements abstract javax.faces.render.RenderKit.getResponseStateManager.

The default behavior of this method is to call javax.faces.render.RenderKit#getResponseStateManager() on the wrapped RenderKit object.

public RenderKit
getWrapped()

Implements javax.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Field Detail

wrappedback to summary
private RenderKit wrapped

Constructor Detail

RenderKitWrapperback to summary
public RenderKitWrapper()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
RenderKitWrapperback to summary
public RenderKitWrapper(RenderKit wrapped)

If this render kit 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:RenderKit

The implementation being wrapped.

Since
2.3

Method Detail

addClientBehaviorRendererback to summary
public void addClientBehaviorRenderer(String type, ClientBehaviorRenderer renderer)

Overrides javax.faces.render.RenderKit.addClientBehaviorRenderer.

The default behavior of this method is to call RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer) on the wrapped RenderKit object.

Parameters
type:String

Doc from javax.faces.render.RenderKit.addClientBehaviorRenderer.

type of the ClientBehaviorRenderer to register

renderer:ClientBehaviorRenderer

Doc from javax.faces.render.RenderKit.addClientBehaviorRenderer.

ClientBehaviorRenderer instance we are registering

Annotations
@Override
See Also
RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer)
addRendererback to summary
public void addRenderer(String family, String rendererType, Renderer renderer)

Implements abstract javax.faces.render.RenderKit.addRenderer.

The default behavior of this method is to call RenderKit#addRenderer(String, String, Renderer) on the wrapped RenderKit object.

Parameters
family:String

Doc from javax.faces.render.RenderKit.addRenderer.

Component family of the Renderer to register

rendererType:String

Doc from javax.faces.render.RenderKit.addRenderer.

Renderer type of the Renderer to register

renderer:Renderer

Doc from javax.faces.render.RenderKit.addRenderer.

Renderer instance we are registering

Annotations
@Override
See Also
RenderKit#addRenderer(String, String, Renderer)
createResponseStreamback to summary
public ResponseStream createResponseStream(OutputStream out)

Implements abstract javax.faces.render.RenderKit.createResponseStream.

The default behavior of this method is to call RenderKit#createResponseStream(java.io.OutputStream) on the wrapped RenderKit object.

Parameters
out:OutputStream

Doc from javax.faces.render.RenderKit.createResponseStream.

the OutputStream around which to create the ResponseStream

Returns:ResponseStream

Doc from javax.faces.render.RenderKit.createResponseStream.

the new ResponseStream

Annotations
@Override
See Also
RenderKit#createResponseStream(java.io.OutputStream)
createResponseWriterback to summary
public ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding)

Implements abstract javax.faces.render.RenderKit.createResponseWriter.

The default behavior of this method is to call RenderKit#createResponseWriter(java.io.Writer, String, String) on the wrapped RenderKit object.

Parameters
writer:Writer

Doc from javax.faces.render.RenderKit.createResponseWriter.

the Writer around which this ResponseWriter must be built.

contentTypeList:String

Doc from javax.faces.render.RenderKit.createResponseWriter.

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:String

Doc from javax.faces.render.RenderKit.createResponseWriter.

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.

Returns:ResponseWriter

Doc from javax.faces.render.RenderKit.createResponseWriter.

a new ResponseWriter.

Annotations
@Override
See Also
RenderKit#createResponseWriter(java.io.Writer, String, String)
getClientBehaviorRendererback to summary
public ClientBehaviorRenderer getClientBehaviorRenderer(String type)

Overrides javax.faces.render.RenderKit.getClientBehaviorRenderer.

The default behavior of this method is to call RenderKit#getClientBehaviorRenderer(String) on the wrapped RenderKit object.

Parameters
type:String

Doc from javax.faces.render.RenderKit.getClientBehaviorRenderer.

type of the requested ClientBehaviorRenderer instance

Returns:ClientBehaviorRenderer

Doc from javax.faces.render.RenderKit.getClientBehaviorRenderer.

the ClientBehaviorRenderer instance

Annotations
@Override
See Also
RenderKit#getClientBehaviorRenderer(String)
getClientBehaviorRendererTypesback to summary
public Iterator<String> getClientBehaviorRendererTypes()

Overrides javax.faces.render.RenderKit.getClientBehaviorRendererTypes.

The default behavior of this method is to call javax.faces.render.RenderKit#getClientBehaviorRendererTypes() on the wrapped RenderKit object.

Returns:Iterator<String>

Doc from javax.faces.render.RenderKit.getClientBehaviorRendererTypes.

an Iterator over the ClientBehaviorRenderer

Annotations
@Override
See Also
javax.faces.render.RenderKit#getClientBehaviorRendererTypes()
getComponentFamiliesback to summary
public Iterator<String> getComponentFamilies()

Overrides javax.faces.render.RenderKit.getComponentFamilies.

The default behavior of this method is to call javax.faces.render.RenderKit#getComponentFamilies() on the wrapped RenderKit object.

Returns:Iterator<String>

Doc from javax.faces.render.RenderKit.getComponentFamilies.

Return an Iterator over the component-family entries

Annotations
@Override
See Also
javax.faces.render.RenderKit#getComponentFamilies()
getRendererback to summary
public Renderer getRenderer(String family, String rendererType)

Implements abstract javax.faces.render.RenderKit.getRenderer.

The default behavior of this method is to call RenderKit#getRenderer(String, String) on the wrapped RenderKit object.

Parameters
family:String

Doc from javax.faces.render.RenderKit.getRenderer.

Component family of the requested Renderer instance

rendererType:String

Doc from javax.faces.render.RenderKit.getRenderer.

Renderer type of the requested Renderer instance

Returns:Renderer

Doc from javax.faces.render.RenderKit.getRenderer.

the Renderer instance

Annotations
@Override
See Also
RenderKit#getRenderer(String, String)
getRendererTypesback to summary
public Iterator<String> getRendererTypes(String componentFamily)

Overrides javax.faces.render.RenderKit.getRendererTypes.

The default behavior of this method is to call RenderKit#getRendererTypes(String) on the wrapped RenderKit object.

Parameters
componentFamily:String

Doc from javax.faces.render.RenderKit.getRendererTypes.

one of the members of the Iterator returned by getComponentFamilies.

Returns:Iterator<String>

Doc from javax.faces.render.RenderKit.getRendererTypes.

an Iterator over the renderer-type

Annotations
@Override
See Also
RenderKit#getRendererTypes(String)
getResponseStateManagerback to summary
public ResponseStateManager getResponseStateManager()

Implements abstract javax.faces.render.RenderKit.getResponseStateManager.

The default behavior of this method is to call javax.faces.render.RenderKit#getResponseStateManager() on the wrapped RenderKit object.

Returns:ResponseStateManager

Doc from javax.faces.render.RenderKit.getResponseStateManager.

the ResponseStateManager

Annotations
@Override
See Also
javax.faces.render.RenderKit#getResponseStateManager()
getWrappedback to summary
public RenderKit getWrapped()

Implements javax.faces.FacesWrapper.getWrapped.

Doc from javax.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:RenderKit

the wrapped instance.

Annotations
@Override