javax.faces.model

Class SelectItem

    • 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, 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
      • SelectItem

        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
      • 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, 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
      • SelectItem

        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
      • 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.
        Since:
        1.2
      • SelectItem

        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 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
      • 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()

        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.

        Since:
        2.0
      • setEscape

        public void setEscape(boolean escape)

        Set the value of the escape property. See isEscape().

        Since:
        2.0
      • setNoSelectionOption

        public void setNoSelectionOption(boolean noSelectionOption)

        Set the value of the noSelectionOption property.

        Since:
        2.0

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/model/SelectItem.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, SelectItem (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.