com.webmethods.caf.faces.bean
Class BaseViewBean.ClientIdsContentProvider

java.lang.Object
  extended by com.webmethods.caf.faces.bean.BaseViewBean.ClientIdsContentProvider
All Implemented Interfaces:
IContentProvider
Enclosing class:
BaseViewBean

protected class BaseViewBean.ClientIdsContentProvider
extends Object
implements IContentProvider

Providers that maps raw control ids to client-side element ids.


Field Summary
protected  UIComponent root
          Reference to the UIComponent at the root of the view.
 
Constructor Summary
BaseViewBean.ClientIdsContentProvider(UIComponent root)
          Constructor.
 
Method Summary
 Object[] getPropertyKeys()
          Returns list of properties supported by this content provider.
 Class getType(Object propertyKey)
          Returns java type of the given property
 Object getValue(Object propertyKey)
          Returns value of the given property
 boolean hasProperty(Object propertyKey)
          Checks if the given property is supported by this content provider
protected  void listAllKeys(List list, UIComponent component)
          Recursively adds all ids of descendants of component (inclusive) to list.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider
toString
 

Field Detail

root

protected UIComponent root
Reference to the UIComponent at the root of the view.

Constructor Detail

BaseViewBean.ClientIdsContentProvider

public BaseViewBean.ClientIdsContentProvider(UIComponent root)
Constructor. Populates all the controls ids and their respective client-side element ids.

Parameters:
root - UIComponent at the root of the view.
Method Detail

getPropertyKeys

public Object[] getPropertyKeys()
Description copied from interface: IContentProvider
Returns list of properties supported by this content provider. Can return Object[0], never null.

Specified by:
getPropertyKeys in interface IContentProvider
Returns:
array of property keys which is typically of type String or Integer

getType

public Class getType(Object propertyKey)
              throws PropertyNotFoundException
Description copied from interface: IContentProvider
Returns java type of the given property

Specified by:
getType in interface IContentProvider
Parameters:
propertyKey - the property key of type String or Integer
Returns:
property java Class
Throws:
PropertyNotFoundException - if property is not supported

getValue

public Object getValue(Object propertyKey)
                throws EvaluationException,
                       PropertyNotFoundException
Description copied from interface: IContentProvider
Returns value of the given property

Specified by:
getValue in interface IContentProvider
Parameters:
propertyKey - the property key of type String or Integer
Returns:
value of the property, can be null
Throws:
EvaluationException - if error during property evaluation
PropertyNotFoundException - if property is not supported

hasProperty

public boolean hasProperty(Object propertyKey)
Description copied from interface: IContentProvider
Checks if the given property is supported by this content provider

Specified by:
hasProperty in interface IContentProvider
Parameters:
propertyKey - property key of type String or Integer
Returns:
true if property is supported

listAllKeys

protected void listAllKeys(List list,
                           UIComponent component)
Recursively adds all ids of descendants of component (inclusive) to list.