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

java.lang.Object
  extended by SelectItem
      extended by com.webmethods.caf.faces.data.object.DefaultSelectItemProvider
          extended by com.webmethods.caf.faces.data.object.DefaultSelectItemGroupProvider
All Implemented Interfaces:
IFilterableSelectItemGroupProvider, ISelectItemGroupProvider, ISelectItemProvider, Serializable
Direct Known Subclasses:
CharacterEncodingSelectItemGroupProvider, DirectoryServicesSelectItemGroupProvider, LocaleSelectItemGroupProvider, PrincipalAttributeValueSourceSelectItemGroupProvider

public class DefaultSelectItemGroupProvider
extends DefaultSelectItemProvider
implements Serializable, IFilterableSelectItemGroupProvider

Default implementation of ISelectItemGroupProvider.

Used by UI controls internally to adapt various input objects to ISelectItemGroupProvider.


Field Summary
protected  String m_filter
          Filter expression; null by default (indicating no filter).
protected  boolean m_filterable
          True if this provider can filter select-items; false by default.
protected  List m_items
          Static list of select-items.
 
Fields inherited from class com.webmethods.caf.faces.data.object.DefaultSelectItemProvider
m_description, m_disabled, m_escaped, m_icon, m_label, m_style, m_value, source
 
Constructor Summary
DefaultSelectItemGroupProvider()
          Default constructor.
DefaultSelectItemGroupProvider(SelectItem[] group)
          Adapts array of SelectItem components
DefaultSelectItemGroupProvider(SelectItemGroup group)
          Adapts SelectItemGroup component
DefaultSelectItemGroupProvider(UISelectItems component)
          Adapts UISeletcItems component
 
Method Summary
 void add(ISelectItemProvider item)
          Adds and single ISelectItemProvider to the list
 ISelectItemProvider findSelectItemContentProvider(Object value)
          Finds the first item in the group with the exact specified value.
 String getFilter()
          Filter expression.
 Collection getSelectItemContentProviders()
          Returns a collection of ISelectItemProviders.
 void initialize(ISelectItemProvider item)
           
 void initialize(SelectItem item)
           
 void initialize(SelectItem[] group)
           
 void initialize(SelectItemGroup group)
           
 void initialize(UISelectItems component)
           
 boolean isFilterable()
          True if this provider truely is filterable.
 void setFilter(String filter)
          Filter expression.
 void setFilterable(boolean filterable)
          True if this provider truely is filterable.
 
Methods inherited from class com.webmethods.caf.faces.data.object.DefaultSelectItemProvider
getDescription, getIcon, getLabel, getSource, getStyle, getValue, isDisabled, isEscape, setDescription, setDisabled, setEscape, setIcon, setLabel, setSource, setStyle, setValue
 
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.ISelectItemProvider
getDescription, getIcon, getLabel, getStyle, getValue, isDisabled, isEscape
 

Field Detail

m_items

protected List m_items
Static list of select-items.


m_filterable

protected boolean m_filterable
True if this provider can filter select-items; false by default.


m_filter

protected String m_filter
Filter expression; null by default (indicating no filter).

Constructor Detail

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider()
Default constructor. Requires DefaultSelectItemProvider.setSource(Object) method to be called with the input object.


DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(UISelectItems component)
Adapts UISeletcItems component

Parameters:
component - UISelectItems component to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(SelectItemGroup group)
Adapts SelectItemGroup component

Parameters:
group - SelectItemGroup component to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(SelectItem[] group)
Adapts array of SelectItem components

Parameters:
group - array of SelectItem components to add to the list of ISelectItemProvider's
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

isFilterable

public boolean isFilterable()
Description copied from interface: IFilterableSelectItemGroupProvider
True if this provider truely is filterable.

Specified by:
isFilterable in interface IFilterableSelectItemGroupProvider

getFilter

public String getFilter()
Description copied from interface: IFilterableSelectItemGroupProvider
Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.

Specified by:
getFilter in interface IFilterableSelectItemGroupProvider

setFilter

public void setFilter(String filter)
Description copied from interface: IFilterableSelectItemGroupProvider
Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.

Specified by:
setFilter in interface IFilterableSelectItemGroupProvider

findSelectItemContentProvider

public ISelectItemProvider findSelectItemContentProvider(Object value)
Description copied from interface: IFilterableSelectItemGroupProvider
Finds the first item in the group with the exact specified value. Searches the entire collection, regardless of the filter expression. Returns null if no item is found.

Specified by:
findSelectItemContentProvider in interface IFilterableSelectItemGroupProvider

initialize

public void initialize(ISelectItemProvider item)
Overrides:
initialize in class DefaultSelectItemProvider
See Also:
#DefaultSelectItemGroupProvider(ISelectItemGroupProvider)

initialize

public void initialize(SelectItem item)
Overrides:
initialize in class DefaultSelectItemProvider
See Also:
#DefaultSelectItemGroupProvider(SelectItem)

initialize

public void initialize(UISelectItems component)
Overrides:
initialize in class DefaultSelectItemProvider
See Also:
DefaultSelectItemGroupProvider.DefaultSelectItemGroupProvider(UISelectItems)

initialize

public void initialize(SelectItemGroup group)
Overrides:
initialize in class DefaultSelectItemProvider
See Also:
DefaultSelectItemGroupProvider.DefaultSelectItemGroupProvider(SelectItemGroup)

initialize

public void initialize(SelectItem[] group)
Overrides:
initialize in class DefaultSelectItemProvider
See Also:
DefaultSelectItemGroupProvider.DefaultSelectItemGroupProvider(SelectItem[])

add

public void add(ISelectItemProvider item)
Adds and single ISelectItemProvider to the list

Parameters:
item - ISelectItemProvider

setFilterable

public void setFilterable(boolean filterable)
True if this provider truely is filterable.