javax.faces.model
Class SelectItem

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SelectItemGroup

public class SelectItem
extends Object
implements Serializable

SelectItem represents a single item in the list of supported items associated with a UISelectMany or UISelectOne component.

See Also:

Serialized Form

Constructor Summary

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

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

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

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

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

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

Method Summary

String	getDescription() Return a description of this item, for use in development tools.
String	getLabel() Return the label of this item, to be rendered visibly for the user.
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() Getter for property escape.
void	setDescription(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) Setter for property escape.
void	setLabel(String label) Set the label of this item, to be rendered visibly for the user.
void	setValue(Object value) Set the value of this item, to be delivered to the model if this item is selected by this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectItem

public SelectItem()

Construct a SelectItem with no initialized property values.

SelectItem

public SelectItem(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:

NullPointerException - if value is null

SelectItem

public SelectItem(Object value,
                  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:

NullPointerException - if value or label null

SelectItem

public SelectItem(Object value,
                  String label,
                  String description)

Construct a SelectItem instance with the specified value, label and description. This 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:

NullPointerException - if value or label is null

SelectItem

public SelectItem(Object value,
                  String label,
                  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:

NullPointerException - if value or label is null

SelectItem

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

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

escape - Flag indicating that the text of this option should be escaped when rendered.

Throws:

NullPointerException - if value or label is null

Since:

1.2

Method Detail

getDescription

public String getDescription()

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

setDescription

public void setDescription(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.

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

getLabel

public String getLabel()

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

setLabel

public void setLabel(String label)

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

Parameters:

label - The new label

Throws:

NullPointerException - if label is null

getValue

public Object getValue()

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

setValue

public void setValue(Object value)

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

Parameters:

value - The new value

isEscape

public boolean isEscape()

Getter for property escape.

Returns:

Value of property escape.

setEscape

public void setEscape(boolean escape)

Setter for property escape.

Parameters:

escape - New value of property escape.