Class RenderKitWrapper
- All Implemented Interfaces:
FacesWrapper<RenderKit>
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.
- Since:
- 2.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addClientBehaviorRenderer
(String type, ClientBehaviorRenderer renderer) The default behavior of this method is to callRenderKit.addClientBehaviorRenderer(String, ClientBehaviorRenderer)
on the wrappedRenderKit
object.void
addRenderer
(String family, String rendererType, Renderer renderer) The default behavior of this method is to callRenderKit.addRenderer(String, String, Renderer)
on the wrappedRenderKit
object.The default behavior of this method is to callRenderKit.createResponseStream(java.io.OutputStream)
on the wrappedRenderKit
object.createResponseWriter
(Writer writer, String contentTypeList, String characterEncoding) The default behavior of this method is to callRenderKit.createResponseWriter(java.io.Writer, String, String)
on the wrappedRenderKit
object.The default behavior of this method is to callRenderKit.getClientBehaviorRenderer(String)
on the wrappedRenderKit
object.The default behavior of this method is to callRenderKit.getClientBehaviorRendererTypes()
on the wrappedRenderKit
object.The default behavior of this method is to callRenderKit.getComponentFamilies()
on the wrappedRenderKit
object.getRenderer
(String family, String rendererType) The default behavior of this method is to callRenderKit.getRenderer(String, String)
on the wrappedRenderKit
object.getRendererTypes
(String componentFamily) The default behavior of this method is to callRenderKit.getRendererTypes(String)
on the wrappedRenderKit
object.The default behavior of this method is to callRenderKit.getResponseStateManager()
on the wrappedRenderKit
object.abstract RenderKit
A class that implements this interface uses this method to return an instance of the class being wrapped.
-
Constructor Details
-
RenderKitWrapper
public RenderKitWrapper()
-
-
Method Details
-
getWrapped
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<RenderKit>
- Returns:
- the wrapped
RenderKit
instance - See Also:
-
addRenderer
The default behavior of this method is to call
RenderKit.addRenderer(String, String, Renderer)
on the wrappedRenderKit
object.- Specified by:
addRenderer
in classRenderKit
- Parameters:
family
- Component family of theRenderer
to registerrendererType
- Renderer type of theRenderer
to registerrenderer
-Renderer
instance we are registering- See Also:
-
createResponseStream
The default behavior of this method is to call
RenderKit.createResponseStream(java.io.OutputStream)
on the wrappedRenderKit
object.- Specified by:
createResponseStream
in classRenderKit
- See Also:
-
createResponseWriter
public ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding) The default behavior of this method is to call
RenderKit.createResponseWriter(java.io.Writer, String, String)
on the wrappedRenderKit
object.- Specified by:
createResponseWriter
in classRenderKit
- Parameters:
writer
- the Writer around which thisResponseWriter
must be built.contentTypeList
- an "Accept header style" list of content types for this response, ornull
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 Stringtext/html
,application/xhtml+xml
,application/xml
ortext/xml
. This may change in a future version. The RenderKit must support a value for this argument that comes straight from theAccept
HTTP header, and therefore requires parsing according to the specification of theAccept
header. Please see Section 14.1 of RFC 2616 for the specification of theAccept
header.characterEncoding
- such as "ISO-8859-1" for this ResponseWriter, ornull
if theRenderKit
should choose the best fit. Please see the IANA for a list of character encodings.- Returns:
- a new
ResponseWriter
. - See Also:
-
getRenderer
The default behavior of this method is to call
RenderKit.getRenderer(String, String)
on the wrappedRenderKit
object.- Specified by:
getRenderer
in classRenderKit
- Parameters:
family
- Component family of the requestedRenderer
instancerendererType
- Renderer type of the requestedRenderer
instance- See Also:
-
getResponseStateManager
The default behavior of this method is to call
RenderKit.getResponseStateManager()
on the wrappedRenderKit
object.- Specified by:
getResponseStateManager
in classRenderKit
- See Also:
-
getComponentFamilies
The default behavior of this method is to call
RenderKit.getComponentFamilies()
on the wrappedRenderKit
object.- Overrides:
getComponentFamilies
in classRenderKit
- See Also:
-
getRendererTypes
The default behavior of this method is to call
RenderKit.getRendererTypes(String)
on the wrappedRenderKit
object.- Overrides:
getRendererTypes
in classRenderKit
- Parameters:
componentFamily
- one of the members of theIterator
returned byRenderKit.getComponentFamilies()
.- See Also:
-
addClientBehaviorRenderer
The default behavior of this method is to call
RenderKit.addClientBehaviorRenderer(String, ClientBehaviorRenderer)
on the wrappedRenderKit
object.- Overrides:
addClientBehaviorRenderer
in classRenderKit
- Parameters:
type
- type of theClientBehaviorRenderer
to registerrenderer
-ClientBehaviorRenderer
instance we are registering- See Also:
-
getClientBehaviorRenderer
The default behavior of this method is to call
RenderKit.getClientBehaviorRenderer(String)
on the wrappedRenderKit
object.- Overrides:
getClientBehaviorRenderer
in classRenderKit
- Parameters:
type
- type of the requestedClientBehaviorRenderer
instance- See Also:
-
getClientBehaviorRendererTypes
The default behavior of this method is to call
RenderKit.getClientBehaviorRendererTypes()
on the wrappedRenderKit
object.- Overrides:
getClientBehaviorRendererTypes
in classRenderKit
- See Also:
-