javax.faces.component
Class UINamingContainer

java.lang.Object
  javax.faces.component.UIComponentBase
      javax.faces.component.UINamingContainer

All Implemented Interfaces:

NamingContainer, java.io.Serializable, UIComponent

public class UINamingContainer

extends UIComponentBase

implements NamingContainer

UINamingContainer is a convenience base class for components that wish to implement NamingContainer functionality.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.faces.component.UIComponent

SEPARATOR_CHAR

Constructor Summary

UINamingContainer()

Method Summary

void	addComponentToNamespace(UIComponent namedComponent) Add the specified UIComponent to the namespace of this naming container.
UIComponent	findComponentInNamespace(java.lang.String name) Find and return a UIComponent in this namespace, if it is present; otherwise return null.
java.lang.String	generateClientId() Generate an identifier for a component, suitable for communication to a client.
void	removeComponentFromNamespace(UIComponent namedComponent) Remove the specified UIComponent from the namespace of this naming container, if it is present.

Methods inherited from class javax.faces.component.UIComponentBase

addChild, addChild, addFacet, addValidator, broadcast, clearChildren, clearFacets, clearValidators, containsChild, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributeNames, getChild, getChildCount, getChildren, getClientId, getComponentId, getConverter, getFacet, getFacetNames, getFacetsAndChildren, getParent, getRendererType, getRendersChildren, getRendersSelf, getValidators, isRendered, isValid, processDecodes, processReconstitutes, processUpdates, processValidators, reconstitute, removeChild, removeChild, removeFacet, removeValidator, setAttribute, setComponentId, setConverter, setParent, setRendered, setRendererType, setValid, updateModel, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

UINamingContainer

public UINamingContainer()

Method Detail

addComponentToNamespace

public void addComponentToNamespace(UIComponent namedComponent)

Description copied from interface: NamingContainer

Add the specified UIComponent to the namespace of this naming container.

Specified by:

addComponentToNamespace in interface NamingContainer

Parameters:

namedComponent - The UIComponent to be added

removeComponentFromNamespace

public void removeComponentFromNamespace(UIComponent namedComponent)

Description copied from interface: NamingContainer

Remove the specified UIComponent from the namespace of this naming container, if it is present.

Specified by:

removeComponentFromNamespace in interface NamingContainer

Parameters:

namedComponent - The UIComponent to be removed

findComponentInNamespace

public UIComponent findComponentInNamespace(java.lang.String name)

Description copied from interface: NamingContainer

Find and return a UIComponent in this namespace, if it is present; otherwise return null.

If the argument name does not contain any UIComponent.SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container.

If the argument name does contain UIComponent.SEPARATOR_CHAR characters, each segment between UIComponent.SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right.

Specified by:

findComponentInNamespace in interface NamingContainer

Parameters:

name - Identifier of the desired component

generateClientId

public java.lang.String generateClientId()

Description copied from interface: NamingContainer

Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace.

Specified by:

generateClientId in interface NamingContainer