Class EditSelectionField

Object
   |
   +--Field
         |
         +--ComponentField
               |
               +--EditSelectionField

class EditSelectionField

extends ComponentField

Defined in form/editselectionfield.js

Requires:

- StringList

Field Detail

added

Object added

Control field that holds the added list 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 list size

edit

Object edit

Text iput used to add values in the list

listSep

String listSep

Separator to the control lists

lookup

Object lookup

Select element that holds the inserted items

removed

Object removed

Control field that holds the removed list items

top

Object top

Top element in the component output structure

EditSelectionField

EditSelectionField(<String> id, <String> edit, <String> lookup, <String> added, <String> removed, <String> sep)

This class contains the client code of the EditSelectionField component. The component consists in a text input, a select input and 3 action buttons. The select is populated by the values entered in the text input

Parameters:
id - Component ID
edit - Text input ID
lookup - Select input ID
added - Added values field ID
removed - Removed values field ID
sep - Separator to the control lists

Requires:
- StringList

add

void add(<Object> opts)

Create a new list item based on the text input value. If the value was already inserted, an alert message is displayed

Parameters:
opts - Add options

clear

void clear()

Reset the component to its default state

focus

void focus()

Focus the first component's element

isEmpty

Boolean isEmpty()

Checks if at least one option was added in the component's select element

remove

void remove()

Remove all selected options in the list

removeAll

void removeAll()

Remove all options of the list

serialize

String serialize()

Serialize the component's value. The EditSelectionField 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