Class LookupSelectionField

Object
   |
   +--Field
         |
         +--ComponentField
               |
               +--LookupSelectionField

class LookupSelectionField

extends ComponentField

Defined in form/lookupselectionfield.js

Requires:

- StringList

Field Detail

added

Object added

Control field that holds the added list items

available

Object available

Select element that holds the available items

buttons

Array buttons

Action buttons

changed

Boolean changed

Indicates if the list contents is different from its original state

count

Object count

Label that shows the current count of selected items

listSep

String listSep

Separator to the control lists

removed

Object removed

Control field that holds the removed list items

selected

Object selected

Select element that holds the selected items

top

Object top

Top element in the component output structure

LookupSelectionField

LookupSelectionField(<String> id, <String> available, <String> selected, <String> added, <String> removed, <String> sep)

The LookupSelectionField component is composed by two select elements that can exchange options. The source list options can be copied to the target list, which represents the list of selected items. The action buttons allow to add options, add all options from left to right, remove already inserted options and remove all inserted options

Parameters:
id - Component ID
available - Source list ID
selected - Selected list ID
added - Added values field ID
removed - Removed values field ID
sep - Separator to the control lists

Requires:
- StringList

add

void add()

Fetch all selected options from the source list and add them in the selected items list. Options successfully added will be unselected; Duplicated items will remain selected

addAll

void addAll()

Copy all options from the source list to the target list. Duplicated items will be ignored

addSingle

 <private> void addSingle(<Object> opt)

Private method that adds a single options in the selected items list

Parameters:
opt - Option to be added

clear

void clear()

Reset the component to its default state

focus

void focus()

Move focus to the component's first member

isEmpty

Boolean isEmpty()

Checks if the list of selected items contains at least one option

remove

void remove()

Remove all selected options from the selected items list

removeAll

void removeAll()

Remove all options of the selected items list

serialize

String serialize()

Serialize the component's value. The LookupSelectionField is serialized in the form of a 2-dimension array: the added values list and the removed values list

setDisabled

void setDisabled(<Boolean> b)

Disables/enables the component

Parameters:
b - Flag value

setup

void setup()

Execute all the initialization steps of this form component

updateButtons

void updateButtons()

Update remove and removeAll buttons status based on the existance of elements in the target list