Class ListSelectionValueDefinition

    • Field Detail

      • m_Values

        protected BaseString[] m_Values
        the list values to choose from.
      • m_DefaultValue

        protected String m_DefaultValue
        the default value.
      • m_MultiSelect

        protected boolean m_MultiSelect
        whether to use multi-select.
    • Constructor Detail

      • ListSelectionValueDefinition

        public ListSelectionValueDefinition()
    • Method Detail

      • setValues

        public void setValues​(BaseString[] value)
        Sets the available list items to choose from.
        Parameters:
        value - the items
      • getValues

        public BaseString[] getValues()
        Returns the available list items to choose from.
        Returns:
        the items
      • valuesTipText

        public String valuesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setDefaultValue

        public void setDefaultValue​(String value)
        Sets the default list value.
        Parameters:
        value - the default
      • getDefaultValue

        public String getDefaultValue()
        Returns the default list value.
        Returns:
        the default
      • defaultValueTipText

        public String defaultValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setMultiSelect

        public void setMultiSelect​(boolean value)
        Sets whether to allow selection of multiple options.
        Parameters:
        value - true if multi-select enabled
      • isMultiSelect

        public boolean isMultiSelect()
        Returns whether multiple options can be selected.
        Returns:
        true if multi-select enabled
      • multiSelectTipText

        public String multiSelectTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • headlessInteraction

        public String headlessInteraction()
        Prompts the user to enter a value in headless mode and returns it.
        Specified by:
        headlessInteraction in class AbstractValueDefinition
        Returns:
        the entered value, null if canceled