com.webmethods.caf.faces.data
Interface ISelectItemProvider

All Known Subinterfaces:

IFilterableSelectItemGroupProvider, ISavedSearch, ISelectItemGroupProvider

All Known Implementing Classes:

BoundPropertiesSelectItemGroupProvider, BoundPropertiesSelectItemGroupProvider.SelectItem, CharacterEncodingSelectItemGroupProvider, DefaultSelectItemGroupProvider, DefaultSelectItemProvider, DirectoryServicesSelectItemGroupProvider, ELSelectItemProvider, LocaleSelectItemGroupProvider, PrincipalAttributeValueSourceSelectItemGroupProvider, TableSelectItemGroupProvider

public interface ISelectItemProvider

Models individual select item data, (like a select-box option or a checkbox, etc.).

Implementations of this interface must extend javax.faces.model.SelectItem.

Method Summary

String	getDescription() Returns item's extended description, typically used in the UI as a tooltip
String	getIcon() Returns item's encoded icon URL.
String	getLabel() Returns item's display name, typically used in the UI to diplay this item
String	getStyle() Returns item's inline CSS style.
Object	getValue() Returns item's value, used for data binding, typically a unique identifier.
boolean	isDisabled() Returns true if item is disabled.
boolean	isEscape() Returns true if item label should be escaped.

Method Detail

getValue

Object getValue()

Returns item's value, used for data binding, typically a unique identifier.

Returns:

item's value

getLabel

String getLabel()

Returns item's display name, typically used in the UI to diplay this item

Returns:

item's label

getDescription

String getDescription()

Returns item's extended description, typically used in the UI as a tooltip

Returns:

item's description

isDisabled

boolean isDisabled()

Returns true if item is disabled.

Returns:

disabled status

getStyle

String getStyle()

Returns item's inline CSS style.

Returns:

items's CSS style

getIcon

String getIcon()

Returns item's encoded icon URL.

Returns:

icon url

isEscape

boolean isEscape()

Returns true if item label should be escaped.

Returns:

true or false