Class SelectItem

    • Constructor Summary

      Constructors 
      Constructor 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.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 true, the code that renders this select item must escape the label using escaping syntax appropriate to the content type being rendered.
      boolean isNoSelectionOption()
      Return the value of the noSelectionOption property.
      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 noSelectionOption property.
      void setValue​(Object value)
      Set the value of this item, to be delivered to the model if this item is selected by this user.
    • 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.

        Returns:
        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.

        Returns:
        the disabled flag for this item
      • 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.

        Returns:
        the label of this item
      • 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.

        Returns:
        the value of this item
      • 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.

        Returns:
        the escape value.
        Since:
        2.0
      • setEscape

        public void setEscape​(boolean escape)

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

        Parameters:
        escape - the new value of the escape property
        Since:
        2.0
      • setNoSelectionOption

        public void setNoSelectionOption​(boolean noSelectionOption)

        Set the value of the noSelectionOption property.

        Parameters:
        noSelectionOption - the new value of the noSelectionOption property
        Since:
        2.0