com.ibm.xsp.registry
Interface FacesRendererDefinition

All Superinterfaces:

FacesDefinition, FacesExtensibleNode

public interface FacesRendererDefinition
extends FacesDefinition

The definition for a specific renderer, unique per render-kit-id, renderer-type and component-family.

The value returned by com.ibm.xsp.registry.FacesDefinition#getDefinitionGroup() is always a FacesRenderKitFragment.

FacesDefinition.getTagName()() is always null.

Method Summary

java.lang.String	getComponentFamily()
FacesFacet	getFacet(java.lang.String facetName)
java.util.Collection<java.lang.String>	getFacetNames() Lists the component's non-inherited expected facets.
java.lang.String	getRendererType()
FacesRenderKitFragment	getRenderKitFragment() The container FacesRenderKitFragment, the representation of the render-kit element in the xsp-config file.

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

getDefaultFacesProperty, getDefaultProperty, getDefinedInlinePropertyNames, getDefinedPropertyNames, getFile, getFirstDefaultPrefix, getGroupTypeRefs, getId, getJavaClass, getNamespaceUri, getParent, getProperty, getPropertyNames, getReferenceId, getSince, getTagName, isDefinedProperty, isGroupProperty, isProperty, isTag

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

getExtension, setExtension

Method Detail

getComponentFamily

java.lang.String getComponentFamily()

Returns:

The family the component associated to the renderer belongs to.

getRendererType

java.lang.String getRendererType()

Returns:

The type of the renderer.

getFacet

FacesFacet getFacet(java.lang.String facetName)

Parameters:

facetName -

Returns:

The Facet that corresponds to the specified name.

getFacetNames

java.util.Collection<java.lang.String> getFacetNames()

Lists the component's non-inherited expected facets. To get the full list of facets that are expected, aggregate the facets on this component, its ancestors, and the per-renderkit renderers associated with the component. Note that there is no runtime restriction on the facets that may be placed in a component, so other facets may be specified in the final component.

getRenderKitFragment

FacesRenderKitFragment getRenderKitFragment()

The container FacesRenderKitFragment, the representation of the render-kit element in the xsp-config file. See FacesRenderKitFragment.getRenderKitId() for this definition's renderKitId The kit fragment contributes to the overall render-kit, which is the aggregate of all the kit fragments.

Returns:

non-null renderKit fragment defined in the current file.