Top Description Fields Constructors Methods
com.sun.faces.renderkit

public Class RenderKitImpl

extends RenderKit
Class Inheritance
Static Imports
com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter.EnableJSStyleHiding, .WebConfiguration.BooleanWebContextInitParameter.EnableScriptInAttributeValue, .WebConfiguration.BooleanWebContextInitParameter.PreferXHTMLContentType, .WebConfiguration.WebContextInitParameter.DisableUnicodeEscaping

RenderKitImpl is a class ... Lifetime And Scope

Field Summary

Modifier and TypeField and Description
private ConcurrentHashMap<String, ClientBehaviorRenderer>
behaviorRenderers

For Behavior Renderers: Keys are Strings for the behaviorRendererType, and values are the behaviorRenderer instances themselves.

private static final Logger
private ConcurrentHashMap<String, HashMap<String, Renderer<T extends UIComponent>>>
rendererFamilies

Keys are String renderer family.

private ResponseStateManager
private static final String
private static final String[]
private WebConfiguration

Constructor Summary

AccessConstructor and Description
public

Method Summary

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

Overrides jakarta.faces.render.RenderKit.addClientBehaviorRenderer.

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.

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

Implements abstract jakarta.faces.render.RenderKit.addRenderer.

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.

private String[]
contentTypeSplit(String contentTypeString)

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

Implements abstract jakarta.faces.render.RenderKit.createResponseStream.

Use the provided OutputStream to create a new ResponseStream instance.

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.
desiredContentTypeList
,
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 jakarta.faces.render.RenderKit.createResponseWriter.

Use the provided Writer to create a new ResponseWriter instance for the specified (optional) content type, and character encoding.

private String
findMatch(String desiredContentTypeList, String[] supportedTypes)

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

Overrides jakarta.faces.render.RenderKit.getClientBehaviorRenderer.

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

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

Overrides jakarta.faces.render.RenderKit.getComponentFamilies.

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

private String
public Renderer<T extends UIComponent>
getRenderer(String
Component family of the requested Renderer instance
family
,
String
Renderer type of the requested Renderer instance
rendererType
)

Implements abstract jakarta.faces.render.RenderKit.getRenderer.

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

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

Overrides jakarta.faces.render.RenderKit.getRendererTypes.

Return an Iterator over the renderer-type entries for the given component-family.

public synchronized ResponseStateManager
getResponseStateManager()

Implements abstract jakarta.faces.render.RenderKit.getResponseStateManager.

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

private boolean

Field Detail

behaviorRenderersback to summary
private ConcurrentHashMap<String, ClientBehaviorRenderer> behaviorRenderers

For Behavior Renderers: Keys are Strings for the behaviorRendererType, and values are the behaviorRenderer instances themselves.

LOGGERback to summary
private static final Logger LOGGER
rendererFamiliesback to summary
private ConcurrentHashMap<String, HashMap<String, Renderer<T extends UIComponent>>> rendererFamilies

Keys are String renderer family. Values are HashMaps. Nested HashMap keys are Strings for the rendererType, and values are the Renderer instances themselves.

responseStateManagerback to summary
private ResponseStateManager responseStateManager
SUPPORTED_CONTENT_TYPESback to summary
private static final String SUPPORTED_CONTENT_TYPES
SUPPORTED_CONTENT_TYPES_ARRAYback to summary
private static final String[] SUPPORTED_CONTENT_TYPES_ARRAY
webConfigback to summary
private WebConfiguration webConfig

Constructor Detail

RenderKitImplback to summary
public RenderKitImpl()

Method Detail

addClientBehaviorRendererback to summary
public void addClientBehaviorRenderer(String behaviorRendererType, ClientBehaviorRenderer behaviorRenderer)

Overrides jakarta.faces.render.RenderKit.addClientBehaviorRenderer.

Doc from jakarta.faces.render.RenderKit.addClientBehaviorRenderer.

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.

Parameters
behaviorRendererType:String

type of the ClientBehaviorRenderer to register

behaviorRenderer:ClientBehaviorRenderer

ClientBehaviorRenderer instance we are registering

Annotations
@Override
addRendererback to summary
public void addRenderer(String family, String rendererType, Renderer<T extends UIComponent> renderer)

Implements abstract jakarta.faces.render.RenderKit.addRenderer.

Doc from jakarta.faces.render.RenderKit.addRenderer.

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.

Parameters
family:String

Component family of the Renderer to register

rendererType:String

Renderer type of the Renderer to register

renderer:Renderer<T extends UIComponent>

Renderer instance we are registering

Annotations
@Override
contentTypeSplitback to summary
private String[] contentTypeSplit(String contentTypeString)
createResponseStreamback to summary
public ResponseStream createResponseStream(OutputStream out)

Implements abstract jakarta.faces.render.RenderKit.createResponseStream.

Doc from jakarta.faces.render.RenderKit.createResponseStream.

Use the provided OutputStream to create a new ResponseStream instance.

Parameters
out:OutputStream

the OutputStream around which to create the ResponseStream

Returns:ResponseStream

the new ResponseStream

Annotations
@Override
createResponseWriterback to summary
public ResponseWriter createResponseWriter(Writer writer, String desiredContentTypeList, String characterEncoding)

Implements abstract jakarta.faces.render.RenderKit.createResponseWriter.

Doc from jakarta.faces.render.RenderKit.createResponseWriter.

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 jakarta.servlet.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.

Parameters
writer:Writer

the Writer around which this ResponseWriter must be built.

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

characterEncoding: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.

Returns:ResponseWriter

a new ResponseWriter.

Annotations
@Override
findMatchback to summary
private String findMatch(String desiredContentTypeList, String[] supportedTypes)
getClientBehaviorRendererback to summary
public ClientBehaviorRenderer getClientBehaviorRenderer(String behaviorRendererType)

Overrides jakarta.faces.render.RenderKit.getClientBehaviorRenderer.

Doc from jakarta.faces.render.RenderKit.getClientBehaviorRenderer.

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

Parameters
behaviorRendererType:String

type of the requested ClientBehaviorRenderer instance

Returns:ClientBehaviorRenderer

the ClientBehaviorRenderer instance

Annotations
@Override
getClientBehaviorRendererTypesback to summary
public Iterator<String> getClientBehaviorRendererTypes()

Overrides jakarta.faces.render.RenderKit.getClientBehaviorRendererTypes.

Doc from jakarta.faces.render.RenderKit.getClientBehaviorRendererTypes.

Return an Iterator over the ClientBehaviorRenderer types.

Returns:Iterator<String>

an Iterator over the ClientBehaviorRenderer

Annotations
@Override
getComponentFamiliesback to summary
public Iterator<String> getComponentFamilies()

Overrides jakarta.faces.render.RenderKit.getComponentFamilies.

Doc from jakarta.faces.render.RenderKit.getComponentFamilies.

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

The default implementation of this method returns an empty Iterator

Returns:Iterator<String>

Return an Iterator over the component-family entries

Annotations
@Override
See Also
jakarta.faces.render.RenderKit#getComponentFamilies()
getDefaultContentTypeback to summary
private String getDefaultContentType()
getRendererback to summary
public Renderer<T extends UIComponent> getRenderer(String family, String rendererType)

Implements abstract jakarta.faces.render.RenderKit.getRenderer.

Doc from jakarta.faces.render.RenderKit.getRenderer.

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

Parameters
family:String

Component family of the requested Renderer instance

rendererType:String

Renderer type of the requested Renderer instance

Returns:Renderer<T extends UIComponent>

the Renderer instance

Annotations
@Override
getRendererTypesback to summary
public Iterator<String> getRendererTypes(String componentFamily)

Overrides jakarta.faces.render.RenderKit.getRendererTypes.

Doc from jakarta.faces.render.RenderKit.getRendererTypes.

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

Parameters
componentFamily:String

one of the members of the Iterator returned by getComponentFamilies.

Returns:Iterator<String>

an Iterator over the renderer-type

Annotations
@Override
See Also
jakarta.faces.render.RenderKit#getRendererTypes(String)
getResponseStateManagerback to summary
public synchronized ResponseStateManager getResponseStateManager()

Implements abstract jakarta.faces.render.RenderKit.getResponseStateManager.

Doc from jakarta.faces.render.RenderKit.getResponseStateManager.

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

Returns:ResponseStateManager

the ResponseStateManager

Annotations
@Override
preferXhtmlback to summary
private boolean preferXhtml()