javax.faces.render
Class RenderKitWrapper

java.lang.Object
  extended by javax.faces.render.RenderKit
      extended by javax.faces.render.RenderKitWrapper
All Implemented Interfaces:
FacesWrapper<RenderKit>

public abstract class RenderKitWrapper
extends RenderKit
implements 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 wrapped instance.

Since:
2.0
Author:
Jan-Kees van Andel

Constructor Summary
RenderKitWrapper()
           
 
Method Summary
 void addClientBehaviorRenderer(String type, ClientBehaviorRenderer renderer)
           
 void addRenderer(String family, String rendererType, Renderer renderer)
          
 ResponseStream createResponseStream(OutputStream out)
          
 ResponseWriter createResponseWriter(Writer writer, String contentTypeList, String characterEncoding)
          
 ClientBehaviorRenderer getClientBehaviorRenderer(String type)
           
 Iterator<String> getClientBehaviorRendererTypes()
           
 Iterator<String> getComponentFamilies()
           Return an Iterator over the component-family entries supported by this RenderKit instance.
 Renderer getRenderer(String family, String rendererType)
          
 Iterator<String> getRendererTypes(String componentFamily)
           Return an Iterator over the renderer-type entries for the given component-family.
 ResponseStateManager getResponseStateManager()
          
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

RenderKitWrapper

public RenderKitWrapper()
Method Detail

addClientBehaviorRenderer

public void addClientBehaviorRenderer(String type,
                                      ClientBehaviorRenderer renderer)
Overrides:
addClientBehaviorRenderer in class RenderKit

addRenderer

public void addRenderer(String family,
                        String rendererType,
                        Renderer renderer)

Specified by:
addRenderer in class RenderKit

createResponseStream

public ResponseStream createResponseStream(OutputStream out)

Specified by:
createResponseStream in class RenderKit

createResponseWriter

public ResponseWriter createResponseWriter(Writer writer,
                                           String contentTypeList,
                                           String characterEncoding)

Specified by:
createResponseWriter in class RenderKit

getClientBehaviorRenderer

public ClientBehaviorRenderer getClientBehaviorRenderer(String type)
Overrides:
getClientBehaviorRenderer in class RenderKit

getClientBehaviorRendererTypes

public Iterator<String> getClientBehaviorRendererTypes()
Overrides:
getClientBehaviorRendererTypes in class RenderKit

getRenderer

public Renderer getRenderer(String family,
                            String rendererType)

Specified by:
getRenderer in class RenderKit

getResponseStateManager

public ResponseStateManager getResponseStateManager()

Specified by:
getResponseStateManager in class RenderKit

getWrapped

public abstract RenderKit getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:
getWrapped in interface FacesWrapper<RenderKit>
Returns:
the instance of the class being wrapped

getComponentFamilies

public Iterator<String> getComponentFamilies()

Return an Iterator over the component-family entries supported by this RenderKit instance.

The default implementation of this method returns an empty Iterator

Overrides:
getComponentFamilies in class RenderKit
Returns:
an iterator over the component families supported by this RenderKit.

getRendererTypes

public Iterator<String> getRendererTypes(String componentFamily)

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

Overrides:
getRendererTypes in class RenderKit
Parameters:
componentFamily - one of the members of the Iterator returned by RenderKit.getComponentFamilies()
Returns:
an iterator over the renderer-type entries for the given component-family.


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.