Class UISelectItem

    • Field Detail

      • COMPONENT_TYPE

        public static final java.lang.String COMPONENT_TYPE

        The standard component type for this component.

        See Also:
        Constant Field Values
      • COMPONENT_FAMILY

        public static final java.lang.String COMPONENT_FAMILY

        The standard component family for this component.

        See Also:
        Constant Field Values
    • Constructor Detail

      • UISelectItem

        public UISelectItem​()

        Create a new UISelectItem instance with default property values.

    • Method Detail

      • getFamily

        public java.lang.String getFamily​()
        Description copied from class: UIComponent

        Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

        Specified by:
        getFamily in class UIComponent
        Returns:
        the component family (not null).
      • getItemDescription

        public java.lang.String getItemDescription​()

        Return the description for this selection item.

        Returns:
        the item description.
      • setItemDescription

        public void setItemDescription​(java.lang.String itemDescription)

        Set the description for this selection item.

        Parameters:
        itemDescription - The new description
      • isItemDisabled

        public boolean isItemDisabled​()

        Return the disabled setting for this selection item.

        Returns:
        true is the item disabled, false otherwise.
      • setItemDisabled

        public void setItemDisabled​(boolean itemDisabled)

        Set the disabled value for this selection item.

        Parameters:
        itemDisabled - The new disabled flag
      • isItemEscaped

        public boolean isItemEscaped​()

        Return the escape setting for the label of this selection item.

        Returns:
        true if the item is escaped, false otherwise.
      • setItemEscaped

        public void setItemEscaped​(boolean itemEscaped)

        Set the escape value for the label of this selection item.

        Parameters:
        itemEscaped - The new disabled flag
      • getItemLabel

        public java.lang.String getItemLabel​()

        Return the localized label for this selection item.

        Returns:
        the item label.
      • setItemLabel

        public void setItemLabel​(java.lang.String itemLabel)

        Set the localized label for this selection item.

        Parameters:
        itemLabel - The new localized label
      • getItemValue

        public java.lang.Object getItemValue​()

        Return the server value for this selection item.

        Returns:
        the item value.
      • setItemValue

        public void setItemValue​(java.lang.Object itemValue)

        Set the server value for this selection item.

        Parameters:
        itemValue - The new server value
      • getValue

        public java.lang.Object getValue​()

        Returns the value property of the UISelectItem.

        Returns:
        the value.
      • setValue

        public void setValue​(java.lang.Object value)

        Sets the value property of the UISelectItem.

        Parameters:
        value - the new value
      • setNoSelectionOption

        public void setNoSelectionOption​(boolean noSelectionOption)

        Set the value of the noSelectionOption property.

        Parameters:
        noSelectionOption - the no selection option.
        Since:
        2.0