oracle.adfmf.javax.faces.model
Class SelectItem

java.lang.Object
  oracle.adfmf.javax.faces.model.SelectItem

public class SelectItem
extends java.lang.Object

The ADF Mobile Framework runtime equivalent of javax.faces.model.SelectItem.

Application java beans that define an accessor (getItems() by convention) that is of type SelectItem[] can be bound to through EL by the AMX selectItems tag:

 <amx:selectOneChoice value="#{MyBean.value}">
   <selectItems value="#{MyBean.items}"/>
 </amx:selectOneChoice>
 

The SelectItem array is used to populate the available items for selection in the component that nests the selectItems tag.

See Also:

javax.faces.model.SelectItem

Constructor Summary

SelectItem()
Construct a SelectItem with no initialized property values.

SelectItem(java.lang.Object value)
Construct a SelectItem with the specified value.

SelectItem(java.lang.Object value, java.lang.String label)
Construct a SelectItem with the specified value and label.

SelectItem(java.lang.Object value, java.lang.String label, java.lang.String description)
Construct a SelectItem instance with the specified value, label and description.

SelectItem(java.lang.Object value, java.lang.String label, java.lang.String description, boolean disabled)
Construct a SelectItem instance with the specified property values.

SelectItem(java.lang.Object value, java.lang.String label, java.lang.String description, boolean disabled, boolean escape)

Method Summary

java.lang.String	getDescription() Return a description of this item, for use in development tools.
java.lang.String	getLabel() Return the label of this item, to be rendered visibly for the user.
java.lang.Object	getValue() Return the value of this item, to be delivered to the model if this item is selected by the user.
boolean	isDisabled() Return the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.
boolean	isEscape() Get the item's escape status
void	setDescription(java.lang.String description) Set the description of this item, for use in development tools.
void	setDisabled(boolean disabled) Set the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.
void	setEscape(boolean escape) Set the item's escape status.
void	setLabel(java.lang.String label) Set the label of this item, to be rendered visibly for the user.
void	setValue(java.lang.Object value) Set the value of this item, to be delivered to the model if this item is selected by the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectItem

public SelectItem()

Construct a SelectItem with no initialized property values.

SelectItem

public SelectItem(java.lang.Object value)

Construct a SelectItem with the specified value. The label property will be set to the value (converted to a String, if necessary), the description property will be set to null, and the disabled property will be set to false.

Parameters:

value - Value to be delivered to the model if this item is selected by the user

Throws:

java.lang.NullPointerException - - if value is null

SelectItem

public SelectItem(java.lang.Object value,
                  java.lang.String label)

Construct a SelectItem with the specified value and label. The description property will be set to null, and the disabled property will be set to false.

Parameters:

value - Value to be delivered to the model if this item is selected by the user

label - Label to be rendered for this item in the response

Throws:

java.lang.NullPointerException - - if value is null

SelectItem

public SelectItem(java.lang.Object value,
                  java.lang.String label,
                  java.lang.String description)

Construct a SelectItem instance with the specified value, label and description. The disabled property will be set to false.

Parameters:

value - Value to be delivered to the model if this item is selected by the user

label - Label to be rendered for this item in the response

description - Description of this item, for use in tools

Throws:

java.lang.NullPointerException - - if value is null

SelectItem

public SelectItem(java.lang.Object value,
                  java.lang.String label,
                  java.lang.String description,
                  boolean disabled)

Construct a SelectItem instance with the specified property values.

Parameters:

value - Value to be delivered to the model if this item is selected by the user

label - Label to be rendered for this item in the response

description - Description of this item, for use in tools

disabled - Flag indicating that this option is disabled

Throws:

java.lang.NullPointerException - - if value is null

SelectItem

public SelectItem(java.lang.Object value,
                  java.lang.String label,
                  java.lang.String description,
                  boolean disabled,
                  boolean escape)

Method Detail

getValue

public java.lang.Object getValue()

Return the value of this item, to be delivered to the model if this item is selected by the user.

Returns:

setValue

public void setValue(java.lang.Object value)

Set the value of this item, to be delivered to the model if this item is selected by the user.

Parameters:

value - The new value

Throws:

java.lang.NullPointerException - - if value is null

getLabel

public java.lang.String getLabel()

Return the label of this item, to be rendered visibly for the user.

Returns:

setLabel

public void setLabel(java.lang.String label)

Set the label of this item, to be rendered visibly for the user.

Parameters:

label - The new label

Throws:

java.lang.NullPointerException - - if label is null

getDescription

public java.lang.String getDescription()

Return a description of this item, for use in development tools.

Returns:

setDescription

public void setDescription(java.lang.String description)

Set the description of this item, for use in development tools.

Parameters:

description - The new description

isDisabled

public boolean isDisabled()

Return the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.

Returns:

setDisabled

public void setDisabled(boolean disabled)

Set the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true.

Parameters:

disabled - The new disabled flag

isEscape

public boolean isEscape()

Get the item's escape status

setEscape

public void setEscape(boolean escape)

Set the item's escape status.