Home » Mojarra-2.0.1 » javax » faces » model » [javadoc | source]
javax.faces.model
public class: SelectItem [javadoc | source]
java.lang.Object
   javax.faces.model.SelectItem

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    SelectItemGroup, GenericObjectSelectItem

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

Constructor:
 public 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, the disabled property will be set to false, and the escape property will be set to ( true.

    Parameters:
    value - Value to be delivered to the model if this item is selected by the user
 public SelectItem(Object value,
    String label) 

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

    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
 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, and the escape property will be set to true.

    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
 public SelectItem(Object value,
    String label,
    String description,
    boolean disabled) 

    Construct a SelectItem instance with the specified property values. The escape property will be set to true.

    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
 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.
    since: 1.2 -
 public SelectItem(Object value,
    String label,
    String description,
    boolean disabled,
    boolean escape,
    boolean noSelectionOption) 

    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.
    noSelectionOption - Flag indicating that the current option is a "no selection" option
    since: 1.2 -
Method from javax.faces.model.SelectItem Summary:
getDescription,   getLabel,   getValue,   isDisabled,   isEscape,   isNoSelectionOption,   setDescription,   setDisabled,   setEscape,   setLabel,   setNoSelectionOption,   setValue
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.faces.model.SelectItem Detail:
 public String getDescription() 

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

 public String getLabel() 

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

 public Object getValue() 

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

 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.

 public boolean isEscape() 

    If and only if this returns true, the code that renders this select item must escape the label using escaping syntax appropriate to the content type being rendered.

 public boolean isNoSelectionOption() 

    Return the value of the noSelectionOption property. If the value of this property is true, the system interprets the option represented by this SelectItem instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage.

 public  void setDescription(String description) 

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

 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.

 public  void setEscape(boolean escape) 

    Set the value of the escape property. See #isEscape .

 public  void setLabel(String label) 

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

 public  void setNoSelectionOption(boolean noSelectionOption) 

    Set the value of the noSelectionOption property.

 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.