com.ibm.xsp.registry
Interface FacesRenderKitFragment

All Superinterfaces:

FacesExtensibleNode

public interface FacesRenderKitFragment
extends FacesExtensibleNode

A FacesRenderKitFragment represents all of the tags with the same render-kit-id in a config file. Each FacesLibraryFragment will only contain one FacesRenderKitFragment with a given render-kit-id.

A FacesRenderKitFragment belongs to a FacesLibraryFragment, which is in a FacesProject in a FacesRegistry.

The FacesRenderKitFragments are aggregated to FacesRenderKitLibrarys.

Note, the com.ibm.xsp.registry.FacesDefinitionGroup#getIdentifier() is not the getRenderKitId(), but there will be only one FacesRenderKitFragment with a given renderKitId in a FacesLibraryFragment.

Method Summary

java.util.List<java.lang.String>	getAliases() The String aliases in this fragment.
java.lang.String	getBaseRenderKitId() The base render-kit-id of this render-kit.
java.util.List<FacesRendererDefinition>	getDefs() The list of FacesRendererDefinitions in this file's contribution to the renderKit.
FacesLibraryFragment	getLibraryFragment() The container FacesLibraryFragment, corresponding to the file where this tag is defined.
FacesRendererDefinition	getRenderer(java.lang.String key) See RegistryUtil.getRendererId(String, String) to create a key from a component family and renderer type.
FacesRendererDefinition	getRendererDefinition(java.lang.String rendererType, java.lang.String componentFamily) Retrieves the renderer definition for the given renderer-type and component-family in this render-kit, if it is present in this FacesRenderKitFragment.
java.util.List<java.lang.String>	getRendererKeys()
java.lang.String	getRenderKitId() The render-kit-id of this render-kit that this collection of renderers are associated with.
boolean	isRenderKitAlias(java.lang.String alias) Whether the specified String was registered with this Fragment as a render-kit-alias.

Methods inherited from interface com.ibm.xsp.registry.FacesExtensibleNode

getExtension, setExtension

Method Detail

getDefs

java.util.List<FacesRendererDefinition> getDefs()

The list of FacesRendererDefinitions in this file's contribution to the renderKit.

Returns:

an unmodifiable List of renderer definitions.

getRendererKeys

java.util.List<java.lang.String> getRendererKeys()

Returns:

getRendererDefinition

FacesRendererDefinition getRendererDefinition(java.lang.String rendererType,
                                              java.lang.String componentFamily)

Retrieves the renderer definition for the given renderer-type and component-family in this render-kit, if it is present in this FacesRenderKitFragment.

Parameters:

rendererType -

componentFamily -

Returns:

null or the FacesRendererDefinition with the given type and family.

getLibraryFragment

FacesLibraryFragment getLibraryFragment()

The container FacesLibraryFragment, corresponding to the file where this tag is defined.

Returns:

the container FacesLibraryFragment (non-null).

getRenderKitId

java.lang.String getRenderKitId()

The render-kit-id of this render-kit that this collection of renderers are associated with. (non-null)

Returns:

a render-kit-id see RenderKitFactory.getRenderKit(javax.faces.context.FacesContext, java.lang.String).

getBaseRenderKitId

java.lang.String getBaseRenderKitId()

The base render-kit-id of this render-kit.

Returns:

a render-kit-id see RenderKitFactory.getRenderKit(javax.faces.context.FacesContext, java.lang.String).

isRenderKitAlias

boolean isRenderKitAlias(java.lang.String alias)

Whether the specified String was registered with this Fragment as a render-kit-alias. See getAliases() for more details.

Parameters:

alias - an alias that might be defined in this fragment.

Returns:

true if the string matches a render-kit-alias was defined in this render-kit's render-kit-extension.

getAliases

java.util.List<java.lang.String> getAliases()

The String aliases in this fragment. The alias is a string that will appear at the end of render kit tag names, associating that tag with the alias's render-kit.

If an alias "html" were registered for the render-kit-id "HTML_BASIC" then, on encountering a render kit tag named "inputText.html" it would be assumed that the tag's render-kit-id was "HTML_BASIC".

Any alias only appears in getAliases() once; duplicates are merged.

getRenderer

FacesRendererDefinition getRenderer(java.lang.String key)

See RegistryUtil.getRendererId(String, String) to create a key from a component family and renderer type. This returns the renderer for that key in this file's render-kit fragment.

Parameters:

key -

Returns: