Class MultiColumnLookupField

Object
   |
   +--Field
         |
         +--ComponentField
               |
               +--MultiColumnLookupField

class MultiColumnLookupField

extends ComponentField

MultiColumnLookupField
Defined in form/multicolumnlookupfield.js

Field Detail

btn

Object btn

container

Object container

height

Object height

selectedIndex

Object selectedIndex

size

Object size

style

Object style

tbl

Object tbl

tblContainer

Object tblContainer

text

Object text

MultiColumnLookupField

MultiColumnLookupField(<String> id, <Integer> height, <Object> style)

Javascript component used by the MultiColumnLookupField form component

Parameters:
id - Component's ID
height - Table height
style - Style properties hash

cellClickHandler

void cellClickHandler(<Event> e)

Handles a mouse click event on the table rows. The target option become selected

Parameters:
e - Event

cellHoverHandler

void cellHoverHandler(<Event> e)

Handles mouseover event on the option rows. Used to highlight the row when the cursor pointer is over it

Parameters:
e - Event

clear

void clear()

Clear the component's value

clearOptions

void clearOptions()

Clear all options in the component

focus

void focus()

Move focus to the component's first member

getValue

String getValue()

Retrieve the component's value

hide

void hide()

Hide the table containing component's options

importOptions

void importOptions(str, lsep, csep, pos)

Import options to the component from a string splitted by line and column separators. The default separators are "|" for lines and "~" for columns. Each 'line' in the string must contain the same number of columns specified in the component's datasource. The add position can be specified at the 4th parameter (pos)

Parameters:
String - str Options string
String - lsep Line separator
String - csep Column separator
Integer - pos Add position

keyHandler

void keyHandler(<Event> e)

Handler method for keyboard events

Parameters:
e - Event

mouseDownHandler

void mouseDownHandler(<Event> e)

Handler method for the mousedown event. Used to listen to mouse events outside the component's table. If an outer click is detected, the table must be hidden

Parameters:
e - Event

navigate

void navigate(<Integer> fw)

Navigation method. Called from MultiColumnLookupField.navigate(), this method allows to move focus from one row to another, in a given offset

Parameters:
fw - Offset (positive or negative)

setDisabled

void setDisabled(<Boolean> b)

Disables/enables the component

Parameters:
b - Flag value

setup

void setup()

Initializes the component's properties and event handlers

setValue

void setValue(<String> val)

Define the component's value

Parameters:
val - New value

setValueByIndex

void setValueByIndex(<Integer> idx)

Select an option from its index

Parameters:
idx - Option index

toggleDisplay

void toggleDisplay()

Toggle display status of the component