Class SelectionChoiceHandle


  • public class SelectionChoiceHandle
    extends StructureHandle
    Represents the handle of selection choice. The selection choice is the value and label pair for parameter.
    Value
    the data value for this choice. The value string is interpreted base on the parameter data type.
    Label
    a optional label to display for this value.
    Label Resource Key
    a optional label resource key when localiztion is needed.
    • Constructor Detail

      • SelectionChoiceHandle

        public SelectionChoiceHandle​(SimpleValueHandle valueHandle,
                                     int index)
        Constructs the handle of selection choice.
        Parameters:
        valueHandle - the value handle for selection choice list of one property
        index - the position of this selection choice in the list
    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        Returns the label.
        Returns:
        the label
      • setLabel

        public void setLabel​(java.lang.String label)
        Sets the label.
        Parameters:
        label - the label to set
      • getLabelKey

        public java.lang.String getLabelKey()
        Returns the resource key if label needs localization.
        Returns:
        the resource key of label.
      • setLabelKey

        public void setLabelKey​(java.lang.String labelResourceKey)
        Sets the resource key if label needs localization.
        Parameters:
        labelResourceKey - the resource key to set
      • getValue

        public java.lang.String getValue()
        Returns the data value for this choice.
        Returns:
        the data value for this choice
      • setValue

        public void setValue​(java.lang.String value)
                      throws SemanticException
        Sets the data value for this choice.
        Parameters:
        value - the value to set
        Throws:
        SemanticException - value required exception