List Scripting Functions

This page details the various component and extension functions available for Vision's List component.

Component Functions

.addSelectionInterval(start, end)

• Description
  • Adds the options at indexes start through end (inclusive) to the selected options.
• Parameters
  • int start - The first index (stating at 0) to add to the selection.
  • int end - The last index (stating at 0) to add to the selection.
• Return
  • Nothing
• Scope
  • Client

.clearSelection()

• Description
  • Clears the current selection, making nothing selected.
• Parameters
  • Nothing
• Return
  • Nothing
• Scope
  • Client

.getSelectedIndices()

• Description
  • Returns a list of the selected indices in increasing order. Returns an empty list if nothing is selected.
• Parameters
  • Nothing
• Return
  • List of Integers
• Scope
  • Client

.getSelectedValue()

• Description
  • Returns the currently selected value, or None if the selection is empty.
• Parameters
  • Nothing
• Return
  • Object
• Scope
  • Client

.getSelectedValues()

• Description
  • Returns a list of the currently selected values. Returns an empty list if the selection is empty.
• Parameters
  • Nothing
• Return
  • Object[]
• Scope
  • Client

.isSelectedIndex(index)

• Description
  • Checks whether or not the given index is currently selected.
• Parameters
  • int index
• Return
  • boolean
• Scope
  • Client

.isSelectionEmpty()

• Description
  • Checks to see if anything is selected in the list or not.
• Parameters
  • Nothing
• Return
  • boolean
• Scope
  • Client

.setSelectedValue(value)

• Description
  • Sets the currently selected value to the argument, if found in the list.
• Parameters
  • Object value
• Return
  • Nothing
• Scope
  • Client

Extension Functions

This component does not have extension functions associated with it.