com.webmethods.caf.faces.data.object
Class TableSelectItemGroupProvider

java.lang.Object
  com.webmethods.caf.faces.bean.PageFlowScopeAdapter
      com.webmethods.caf.faces.data.object.TableSelectItemGroupProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, ISelectItemGroupProvider, ISelectItemProvider, Serializable

public class TableSelectItemGroupProvider
extends PageFlowScopeAdapter
implements Serializable, ISelectItemGroupProvider

Adapts a ITableContentProvider, List and arrays to ISelectItemGroupProvider. For list or array it internally creates a instance of ListTableContentProvider.

At least label field name must be defined. It value field name is not defined, label field value is used for the select item value.

 class Item {
                public int getId();
                public String getName(); 
 };
 
 Item[] items = new Items[] {....};
 ISelectItemGroupProvider provider = new TableSelectItemGroupProvider(items, "name", "id");
 Collection selectItems = provider.getSelectItemContentProviders();
                 
 for (java.util.Iterator it = selectItems(); it.hasNext(); ) {
   ISelectItemProvider selectItem = (ISelectItemProvider)it.next();
         String label = selectItem.getLabel(); // returns value of "name" property for each item
         Object value = selectItem.getValue(); // returns value of "id" property for each item
 }
 
 

See Also:

Serialized Form

Field Summary

protected Object[]	m_array
protected String	m_descriptionFieldName
protected String	m_disabledFieldName
protected List	m_group
protected String	m_iconFieldName
protected String	m_labelFieldName
protected List	m_list
protected String	m_styleFieldName
protected ITableContentProvider	m_table
protected String	m_valueFieldName

Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

fExpireWithPageFlow

Constructor Summary

TableSelectItemGroupProvider()
Default constructor.

TableSelectItemGroupProvider(ITableContentProvider table, String labelFieldName)

TableSelectItemGroupProvider(ITableContentProvider table, String labelFieldName, String valueFieldName)

TableSelectItemGroupProvider(ITableContentProvider table, String labelFieldName, String valueFieldName, String descriptionFieldName, String disabledFieldName, String styleFieldName, String iconFieldName)
Fully configured provider constructor

TableSelectItemGroupProvider(List list, String labelFieldName)

TableSelectItemGroupProvider(List list, String labelFieldName, String valueFieldName)

TableSelectItemGroupProvider(Object[] array, String labelFieldName)

TableSelectItemGroupProvider(Object[] array, String labelFieldName, String valueFieldName)

Method Summary

Object[]	getArray() Returns wrapped array if set
String	getDescription() Always returns null
String	getDescriptionFieldName() Returns property name of the source object to use for select item description
String	getDisabledFieldName() Returns property name of the source object to use for select item disabled flag
String	getIcon() Always returns null
String	getIconFieldName() Returns property name of the source object to use for select item icon
String	getLabel() Always returns null
String	getLabelFieldName() Returns property name of the source object to use for select item label
List	getList() Returns wrapped list if set
Collection	getSelectItemContentProviders() Returns a collection of ISelectItemProviders.
String	getStyle() Always returns null
String	getStyleFieldName() Returns property name of the source object to use for select item description
ITableContentProvider	getTable() Returns currently used table provider
Object	getValue() Always returns null
String	getValueFieldName() Returns property name of the source object to use for select item value
boolean	isDisabled() Always returns false
boolean	isEscape() Returns true if item label should be escaped.
void	setArray(Object[] array) Sets new array to use
void	setDescriptionFieldName(String descriptionFieldName) Sets property name on the source object to use for select item description
void	setDisabledFieldName(String disabledFieldName) Sets property name on the source object to use for select item disabled flag
void	setIconFieldName(String iconFieldName) Sets property name on the source object to use for select item icon
void	setLabelFieldName(String labelFieldName) Sets property name on the source object to use for select item description
void	setList(List list) Sets a list to use
void	setStyleFieldName(String styleFieldName) Sets property name on the source object to use for select item style
void	setTable(ITableContentProvider table) Sets new table provider to use
void	setValueFieldName(String valueFieldName) Sets property name on the source object to use for select item value

Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

getExpireWithPageFlow, setExpireWithPageFlow

Methods inherited from class java.lang.Object

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

Field Detail

m_table

protected ITableContentProvider m_table

m_list

protected List m_list

m_array

protected Object[] m_array

m_group

protected List m_group

m_labelFieldName

protected String m_labelFieldName

m_valueFieldName

protected String m_valueFieldName

m_descriptionFieldName

protected String m_descriptionFieldName

m_disabledFieldName

protected String m_disabledFieldName

m_styleFieldName

protected String m_styleFieldName

m_iconFieldName

protected String m_iconFieldName

Constructor Detail

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(ITableContentProvider table,
                                    String labelFieldName,
                                    String valueFieldName,
                                    String descriptionFieldName,
                                    String disabledFieldName,
                                    String styleFieldName,
                                    String iconFieldName)

Fully configured provider constructor

Parameters:

table - table content provider

labelFieldName - content provider property name to use as select item label

valueFieldName - content provider property name to use as select item value

descriptionFieldName - content provider property name to use as select item description

disabledFieldName - content provider property name to use as select item disabled flag

styleFieldName - content provider property name to use as select item style

iconFieldName - content provider property name to use as select item icon

TableSelectItemGroupProvider

public TableSelectItemGroupProvider()

Default constructor. Requires TableSelectItemGroupProvider.setTable(ITableContentProvider), TableSelectItemGroupProvider.setList(List) or TableSelectItemGroupProvider.setArray(Object[]) as well as TableSelectItemGroupProvider.setLabelFieldName(String) to be called before use.

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(ITableContentProvider table,
                                    String labelFieldName)

Parameters:

table - a table provider

labelFieldName - content provider property name to use as select item label

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(ITableContentProvider table,
                                    String labelFieldName,
                                    String valueFieldName)

Parameters:

table - a table provider

labelFieldName - content provider property name to use as select item label

valueFieldName - content provider property name to use as select item value

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(List list,
                                    String labelFieldName)

Parameters:

list - a list of objects

labelFieldName - content provider property name to use as select item label

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(List list,
                                    String labelFieldName,
                                    String valueFieldName)

Parameters:

list - a list of objects

labelFieldName - content provider property name to use as select item label

valueFieldName - content provider property name to use as select item value

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(Object[] array,
                                    String labelFieldName)

Parameters:

array - an array of objects

labelFieldName - content provider property name to use as select item label

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

TableSelectItemGroupProvider

public TableSelectItemGroupProvider(Object[] array,
                                    String labelFieldName,
                                    String valueFieldName)

Parameters:

array - an array of objects

labelFieldName - content provider property name to use as select item label

valueFieldName - content provider property name to use as select item value

See Also:

TableSelectItemGroupProvider.TableSelectItemGroupProvider(ITableContentProvider, String, String, String, String, String, String)

Method Detail

getSelectItemContentProviders

public Collection getSelectItemContentProviders()

Description copied from interface: ISelectItemGroupProvider

Returns a collection of ISelectItemProviders.

Specified by:

getSelectItemContentProviders in interface ISelectItemGroupProvider

Returns:

collectio of individual select items

getDescription

public String getDescription()

Always returns null

Specified by:

getDescription in interface ISelectItemProvider

Returns:

null

getIcon

public String getIcon()

Always returns null

Specified by:

getIcon in interface ISelectItemProvider

Returns:

null

getLabel

public String getLabel()

Always returns null

Specified by:

getLabel in interface ISelectItemProvider

Returns:

null

getStyle

public String getStyle()

Always returns null

Specified by:

getStyle in interface ISelectItemProvider

Returns:

null

getValue

public Object getValue()

Always returns null

Specified by:

getValue in interface ISelectItemProvider

Returns:

null

isDisabled

public boolean isDisabled()

Always returns false

Specified by:

isDisabled in interface ISelectItemProvider

Returns:

false

isEscape

public boolean isEscape()

Description copied from interface: ISelectItemProvider

Returns true if item label should be escaped.

Specified by:

isEscape in interface ISelectItemProvider

Returns:

true or false

getDescriptionFieldName

public String getDescriptionFieldName()

Returns property name of the source object to use for select item description

Returns:

property name of null if not set

setDescriptionFieldName

public void setDescriptionFieldName(String descriptionFieldName)

Sets property name on the source object to use for select item description

Parameters:

descriptionFieldName - property name, can be null

getDisabledFieldName

public String getDisabledFieldName()

Returns property name of the source object to use for select item disabled flag

Returns:

property name of null if not set

setDisabledFieldName

public void setDisabledFieldName(String disabledFieldName)

Sets property name on the source object to use for select item disabled flag

Parameters:

disabledFieldName - property name, can be null

getIconFieldName

public String getIconFieldName()

Returns property name of the source object to use for select item icon

Returns:

property name of null if not set

setIconFieldName

public void setIconFieldName(String iconFieldName)

Sets property name on the source object to use for select item icon

Parameters:

iconFieldName - property name, can be null

getLabelFieldName

public String getLabelFieldName()

Returns property name of the source object to use for select item label

Returns:

property name of null if not set

setLabelFieldName

public void setLabelFieldName(String labelFieldName)

Sets property name on the source object to use for select item description

Parameters:

labelFieldName - property name, can be null

getStyleFieldName

public String getStyleFieldName()

Returns property name of the source object to use for select item description

Returns:

property name of null if not set

setStyleFieldName

public void setStyleFieldName(String styleFieldName)

Sets property name on the source object to use for select item style

Parameters:

styleFieldName - property name, can be null

getValueFieldName

public String getValueFieldName()

Returns property name of the source object to use for select item value

Returns:

property name of null if not set

setValueFieldName

public void setValueFieldName(String valueFieldName)

Sets property name on the source object to use for select item value

Parameters:

valueFieldName - property name, can be null

getTable

public ITableContentProvider getTable()

Returns currently used table provider

Returns:

null if not set

setTable

public void setTable(ITableContentProvider table)

Sets new table provider to use

Parameters:

table - table provider

setList

public void setList(List list)

Sets a list to use

Parameters:

list - list of objects

getList

public List getList()

Returns wrapped list if set

Returns:

null if not set

setArray

public void setArray(Object[] array)

Sets new array to use

Parameters:

array - array of objects

getArray

public Object[] getArray()

Returns wrapped array if set

Returns:

null if not set