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.
Constructor and Description |
---|
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. |
SelectItem(Object value,
String label,
String description,
boolean disabled,
boolean escape,
boolean noSelectionOption)
Construct a
SelectItem instance with the specified property values. |
Modifier and Type | Method and Description |
---|---|
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()
If and only if this returns |
boolean |
isNoSelectionOption()
Return the value of the |
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)
Set the value of the escape property. |
void |
setLabel(String label)
Set the label of this item, to be rendered visibly for the user.
|
void |
setNoSelectionOption(boolean noSelectionOption)
Set the value of the |
void |
setValue(Object value)
Set the value of this item, to be delivered to the model if this item is selected by this user.
|
public SelectItem()
Construct a SelectItem
with no initialized property values.
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
.
value
- Value to be delivered to the model if this item is selected by the userpublic 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
.
value
- Value to be delivered to the model if this item is selected by the userlabel
- Label to be rendered for this item in the responsepublic 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
.
value
- Value to be delivered to the model if this item is selected by the userlabel
- Label to be rendered for this item in the responsedescription
- Description of this item, for use in toolspublic 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
.
value
- Value to be delivered to the model if this item is selected by the userlabel
- Label to be rendered for this item in the responsedescription
- Description of this item, for use in toolsdisabled
- Flag indicating that this option is disabledpublic SelectItem(Object value, String label, String description, boolean disabled, boolean escape)
Construct a SelectItem
instance with the specified property values.
value
- Value to be delivered to the model if this item is selected by the userlabel
- Label to be rendered for this item in the responsedescription
- Description of this item, for use in toolsdisabled
- Flag indicating that this option is disabledescape
- Flag indicating that the text of this option should be escaped when rendered.public SelectItem(Object value, String label, String description, boolean disabled, boolean escape, boolean noSelectionOption)
Construct a SelectItem
instance with the specified property values.
value
- Value to be delivered to the model if this item is selected by the userlabel
- Label to be rendered for this item in the responsedescription
- Description of this item, for use in toolsdisabled
- Flag indicating that this option is disabledescape
- Flag indicating that the text of this option should be escaped when rendered.noSelectionOption
- Flag indicating that the current option is a "no selection" optionpublic String getDescription()
Return a description of this item, for use in development tools.
public void setDescription(String description)
Set the description of this item, for use in development tools.
description
- The new descriptionpublic 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 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
.
disabled
- The new disabled flagpublic String getLabel()
Return the label of this item, to be rendered visibly for the user.
public void setLabel(String label)
Set the label of this item, to be rendered visibly for the user.
label
- The new labelpublic Object getValue()
Return the value of this item, to be delivered to the model if this item is selected by the user.
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.
value
- The new valuepublic 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 void setEscape(boolean escape)
Set the value of the escape property. See isEscape()
.
escape
- the new value of the escape propertypublic 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(jakarta.faces.context.FacesContext, java.lang.Object)
and UISelectMany.validateValue(jakarta.faces.context.FacesContext, java.lang.Object)
for usage.
noSelectionOption
propertypublic void setNoSelectionOption(boolean noSelectionOption)
Set the value of the noSelectionOption
property.
noSelectionOption
- the new value of the noSelectionOption
propertyCopyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.