DefaultSelectItemProvider (server-common-api)

java.lang.Object
- javax.faces.model.SelectItem
- - com.webmethods.caf.faces.data.object.DefaultSelectItemProvider

All Implemented Interfaces:

ISelectItemProvider, Serializable

Direct Known Subclasses:

DefaultSelectItemGroupProvider
```
public class DefaultSelectItemProvider
extends SelectItem
implements Serializable, ISelectItemProvider
```
Default implementation of ISelectItemProvider.

Used by UI controls internally to adapt various input objects to ISelectItemProvider

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`m_description`
`protected boolean`	`m_disabled`
`protected boolean`	`m_escaped`
`protected String`	`m_icon`
`protected String`	`m_label`
`protected String`	`m_style`
`protected Object`	`m_value`
`protected Object`	`source`

Constructor Summary

Constructors
Constructor and Description
`DefaultSelectItemProvider()` Default constructor.
`DefaultSelectItemProvider(Object item)` Adapts single supported object
`DefaultSelectItemProvider(SelectItem item)` Adapts single SelectItem component
`DefaultSelectItemProvider(String label, Object value)` Initializes this provider with the given label and value
`DefaultSelectItemProvider(String label, Object value, String description, boolean disabled, String style, String icon)` Initializes this provider with everything it needs
`DefaultSelectItemProvider(UISelectItem component)` Adapts single UISelectItem component

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`Object`	`getSource()` Returns currently set source object instance
`String`	`getStyle()` Returns item's inline CSS style.
`Object`	`getValue()` Returns item's value, used for data binding, typically a unique identifier.
`void`	`initialize(ISelectItemProvider item)`
`void`	`initialize(Object o)` Initializes the provider with a given source object.
`void`	`initialize(SelectItem item)`
`void`	`initialize(String item)`
`void`	`initialize(UISelectItem component)`
`boolean`	`isDisabled()` Returns true if item is disabled.
`boolean`	`isEscape()` Returns true if item label should be escaped.
`void`	`setDescription(String description)` Sets item new description
`void`	`setDisabled(boolean disabled)` Sets disabled flag
`void`	`setEscape(boolean escaped)` Sets escaped flag
`void`	`setIcon(String icon)` Sets item icon URL
`void`	`setLabel(String label)` Sets item new label
`void`	`setSource(Object object)` Property access to initialize the provider with a supported object.
`void`	`setStyle(String style)` Sets item CSS style
`void`	`setValue(Object value)` Sets item new value

Methods inherited from class javax.faces.model.SelectItem
isNoSelectionOption, setNoSelectionOption

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_value
```
protected Object m_value
```
  - m_label
```
protected String m_label
```
  - m_description
```
protected String m_description
```
  - m_disabled
```
protected boolean m_disabled
```
  - m_escaped
```
protected boolean m_escaped
```
  - m_style
```
protected String m_style
```
  - m_icon
```
protected String m_icon
```
  - source
```
protected Object source
```
- Constructor Detail
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider()
```
    Default constructor. Requires setSource(Object) to be called.
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider(SelectItem item)
```
    Adapts single SelectItem component
    
    Parameters:
    
    item - select item component
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider(UISelectItem component)
```
    Adapts single UISelectItem component
    
    Parameters:
    
    component - select item component
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider(Object item)
```
    Adapts single supported object
    
    Parameters:
    
    item - a supported object instance
    
    See Also:
    
    initialize(Object)
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider(String label,
                                 Object value)
```
    Initializes this provider with the given label and value
    
    Parameters:
    
    label - display name for the select item
    
    value - the value for the select item
  - DefaultSelectItemProvider
```
public DefaultSelectItemProvider(String label,
                                 Object value,
                                 String description,
                                 boolean disabled,
                                 String style,
                                 String icon)
```
    Initializes this provider with everything it needs
    
    Parameters:
    
    label - the display name of the item
    
    value - the value of the item
    
    description - the description of the item
    
    disabled - true if the item is disabled
    
    style - CSS style of the item
    
    icon - the icon URL
- Method Detail
  - getValue
```
public Object getValue()
```
    Description copied from interface: ISelectItemProvider
    
    Returns item's value, used for data binding, typically a unique identifier.
    
    Specified by:
    
    getValue in interface ISelectItemProvider
    
    Overrides:
    
    getValue in class SelectItem
    
    Returns:
    
    item's value
  - getLabel
```
public String getLabel()
```
    Description copied from interface: ISelectItemProvider
    
    Returns item's display name, typically used in the UI to diplay this item
    
    Specified by:
    
    getLabel in interface ISelectItemProvider
    
    Overrides:
    
    getLabel in class SelectItem
    
    Returns:
    
    item's label
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ISelectItemProvider
    
    Returns item's extended description, typically used in the UI as a tooltip
    
    Specified by:
    
    getDescription in interface ISelectItemProvider
    
    Overrides:
    
    getDescription in class SelectItem
    
    Returns:
    
    item's description
  - isDisabled
```
public boolean isDisabled()
```
    Description copied from interface: ISelectItemProvider
    
    Returns true if item is disabled.
    
    Specified by:
    
    isDisabled in interface ISelectItemProvider
    
    Overrides:
    
    isDisabled in class SelectItem
    
    Returns:
    
    disabled status
  - isEscape
```
public boolean isEscape()
```
    Description copied from interface: ISelectItemProvider
    
    Returns true if item label should be escaped.
    
    Specified by:
    
    isEscape in interface ISelectItemProvider
    
    Overrides:
    
    isEscape in class SelectItem
    
    Returns:
    
    true or false
    
    See Also:
    
    SelectItem.isEscape()
  - getStyle
```
public String getStyle()
```
    Description copied from interface: ISelectItemProvider
    
    Returns item's inline CSS style.
    
    Specified by:
    
    getStyle in interface ISelectItemProvider
    
    Returns:
    
    items's CSS style
  - getIcon
```
public String getIcon()
```
    Description copied from interface: ISelectItemProvider
    
    Returns item's encoded icon URL.
    
    Specified by:
    
    getIcon in interface ISelectItemProvider
    
    Returns:
    
    icon url
  - initialize
```
public void initialize(String item)
```
  - initialize
```
public void initialize(ISelectItemProvider item)
```
    See Also:
    
    #DefaultSelectItemProvider(ISelectItemProvider)
  - initialize
```
public void initialize(SelectItem item)
```
    See Also:
    
    DefaultSelectItemProvider(SelectItem)
  - initialize
```
public void initialize(UISelectItem component)
```
    See Also:
    
    DefaultSelectItemProvider(UISelectItem)
  - initialize
```
public void initialize(Object o)
```
    Initializes the provider with a given source object. Supported types are:
    Parameters:
    
    o - a supported object type instance
    
    See Also:
    
    setSource(Object)
  - setValue
```
public void setValue(Object value)
```
    Sets item new value
    
    Overrides:
    
    setValue in class SelectItem
    
    Parameters:
    
    value - new value
  - setLabel
```
public void setLabel(String label)
```
    Sets item new label
    
    Overrides:
    
    setLabel in class SelectItem
    
    Parameters:
    
    label - new label
  - setDescription
```
public void setDescription(String description)
```
    Sets item new description
    
    Overrides:
    
    setDescription in class SelectItem
    
    Parameters:
    
    description - new description
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Sets disabled flag
    
    Overrides:
    
    setDisabled in class SelectItem
    
    Parameters:
    
    disabled - true to disable the item
  - setEscape
```
public void setEscape(boolean escaped)
```
    Sets escaped flag
    
    Overrides:
    
    setEscape in class SelectItem
    
    Parameters:
    
    escaped - true to escape the item label
  - setStyle
```
public void setStyle(String style)
```
    Sets item CSS style
    
    Parameters:
    
    style - new CSS style
  - setIcon
```
public void setIcon(String icon)
```
    Sets item icon URL
    
    Parameters:
    
    icon - new icon URL
  - setSource
```
public void setSource(Object object)
```
    Property access to initialize the provider with a supported object.
    
    Parameters:
    
    object - any supported object instance, not null
    
    See Also:
    
    initialize(Object)
  - getSource
```
public Object getSource()
```
    Returns currently set source object instance
    
    Returns:
    
    null if not set

Class DefaultSelectItemProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.faces.model.SelectItem

Methods inherited from class java.lang.Object

Field Detail

m_value

m_label

m_description

m_disabled

m_escaped

m_style

m_icon

source

Constructor Detail

DefaultSelectItemProvider

DefaultSelectItemProvider

DefaultSelectItemProvider

DefaultSelectItemProvider

DefaultSelectItemProvider

DefaultSelectItemProvider

Method Detail

getValue

getLabel

getDescription

isDisabled

isEscape

getStyle

getIcon

initialize

initialize

initialize

initialize

initialize

setValue

setLabel

setDescription

setDisabled

setEscape

setStyle

setIcon

setSource

getSource