Module jakarta.faces

Package com.sun.faces.renderkit

Class RenderKitImpl

java.lang.Object

jakarta.faces.render.RenderKit

com.sun.faces.renderkit.RenderKitImpl

public class RenderKitImpl
extends RenderKit

RenderKitImpl is a class ... Lifetime And Scope

Constructor Summary

Constructors

Constructor	Description
RenderKitImpl()

Method Summary

Modifier and Type	Method	Description
void	addClientBehaviorRenderer(String behaviorRendererType, ClientBehaviorRenderer behaviorRenderer)	Register the specified ClientBehaviorRenderer instance, associated with the specified component type, to the set of ClientBehaviorRenderers registered with this RenderKit, replacing any previously registered ClientBehaviorRenderer for this type.
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 Renderers 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 desiredContentTypeList, String characterEncoding)	Use the provided Writer to create a new ResponseWriter instance for the specified (optional) content type, and character encoding.
ClientBehaviorRenderer	getClientBehaviorRenderer(String behaviorRendererType)	Return the ClientBehaviorRenderer instance most recently registered for the specified type, if any; otherwise, return null.
Iterator<String>	getClientBehaviorRendererTypes()	Return an Iterator over the ClientBehaviorRenderer types.
Iterator<String>	getComponentFamilies()	Return an Iterator over the component-family entries supported by this RenderKit instance.
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 Iterator over the renderer-type entries for the given component-family.
ResponseStateManager	getResponseStateManager()	Return an instance of ResponseStateManager to handle rendering technology specific state management decisions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RenderKitImpl

public RenderKitImpl()

Method Details

addRenderer

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

Description copied from class: RenderKit

Register the specified Renderer instance, associated with the specified component family and rendererType, to the set of Renderers registered with this RenderKit, replacing any previously registered Renderer for this combination of identifiers.

Specified by:

addRenderer in class RenderKit

Parameters:

family - Component family of the Renderer to register

rendererType - Renderer type of the Renderer to register

renderer - Renderer instance we are registering

getRenderer

public Renderer getRenderer(String family,
 String rendererType)

Description copied from class: RenderKit

Return the Renderer instance most recently registered for the specified component family and rendererType, if any; otherwise, return null.

Specified by:

getRenderer in class RenderKit

Parameters:

family - Component family of the requested Renderer instance

rendererType - Renderer type of the requested Renderer instance

Returns:

the Renderer instance

addClientBehaviorRenderer

public void addClientBehaviorRenderer(String behaviorRendererType,
 ClientBehaviorRenderer behaviorRenderer)

Description copied from class: RenderKit

Register the specified ClientBehaviorRenderer instance, associated with the specified component type, to the set of ClientBehaviorRenderers registered with this RenderKit, replacing any previously registered ClientBehaviorRenderer for this type.

Overrides:

addClientBehaviorRenderer in class RenderKit

Parameters:

behaviorRendererType - type of the ClientBehaviorRenderer to register

behaviorRenderer - ClientBehaviorRenderer instance we are registering

getClientBehaviorRenderer

public ClientBehaviorRenderer getClientBehaviorRenderer(String behaviorRendererType)

Description copied from class: RenderKit

Return the ClientBehaviorRenderer instance most recently registered for the specified type, if any; otherwise, return null.

Overrides:

getClientBehaviorRenderer in class RenderKit

Parameters:

behaviorRendererType - type of the requested ClientBehaviorRenderer instance

Returns:

the ClientBehaviorRenderer instance

getClientBehaviorRendererTypes

public Iterator<String> getClientBehaviorRendererTypes()

Description copied from class: RenderKit

Return an Iterator over the ClientBehaviorRenderer types.

Overrides:

getClientBehaviorRendererTypes in class RenderKit

Returns:

an Iterator over the ClientBehaviorRenderer

getResponseStateManager

public ResponseStateManager getResponseStateManager()

Description copied from class: RenderKit

Return an instance of ResponseStateManager to handle rendering technology specific state management decisions.

Specified by:

getResponseStateManager in class RenderKit

Returns:

the ResponseStateManager

createResponseWriter

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

Description copied from class: 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.

Specified by:

createResponseWriter in class RenderKit

Parameters:

writer - the Writer around which this ResponseWriter must be built.

desiredContentTypeList - 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.

Returns:

a new ResponseWriter.

createResponseStream

public ResponseStream createResponseStream(OutputStream out)

Description copied from class: RenderKit

Use the provided OutputStream to create a new ResponseStream instance.

Specified by:

createResponseStream in class RenderKit

Parameters:

out - the OutputStream around which to create the ResponseStream

Returns:

the new ResponseStream

getComponentFamilies

public Iterator<String> getComponentFamilies()

Description copied from class: RenderKit

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:

Return an Iterator over the component-family entries

See Also:

• RenderKit.getComponentFamilies()

getRendererTypes

public Iterator<String> getRendererTypes(String componentFamily)

Description copied from class: 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

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

See Also:

• RenderKit.getRendererTypes(String)