Shuttle

Definition

A Shuttle is a user interface element used in the Browse and Collect Pattern. It is used to move entries from one table to another table to select the entries.

Description of UI Element Properties

• availableListId

  Determines the Id of the list that contains the available keys.

• behavior

  This property can take the following values and is represented by enumeration type WDShuttleBehavior :

  • add. Add or remove items.
  • move. Move items up or down.
• enableAddButtons

  Determines whether the add buttons are enabled.

• enableRemoveButtons

  Determines whether the remove buttons are enabled.

• selectedListId

  Determines the ID of the list that contains the selected keys.

• showAllButtons

  Determines whether the all buttons (both remove all button and add all button) are visible.

• vertical

  Determines whether the Shuttle is arranged vertically or horizontally.

Properties Overview

Events

• onAdd (boolean all)

  This event is triggered if the user presses an add button. The parameter determines whether the add all button has been pressed.

• onRemove (boolean all)

  This event is triggered if the user presses a remove button. The parameter indicates whether the remove all button has been pressed.