Class CAF.Select.Model

Object
   |
   +--CAF.Output.Model
         |
         +--CAF.Input.Model
               |
               +--CAF.Select.Model

Direct Known Subclasses:

CAF.Select.Radio.Model, CAF.Messages.Model, CAF.Select.Swapbox.Model, CAF.Select.Button.Model, CAF.Select.Tabs.Model, CAF.Select.Listbox.Model

class CAF.Select.Model

extends CAF.Input.Model

CAF Select-One and Select-Many client-side model.
Defined in select.js

Field Detail

classes

Object classes

CAF.Select.Model

CAF.Select.Model()

add

void add(x, item)

Adds item before the specified index or the specified value. Adds to end if index out of range or item not found.

Parameters:
x - (optional) Zero-based item index or value or existing CAF.Select.Item.Model, or array of indicies, values, or CAF.Select.Item.Models. Less than zero signals add to end.
item - CAF.Select.Item.Model or array of CAF.Select.Item.Models.

addFilterListener

void addFilterListener(fn, key)

Adds filter listener. Row-change listener function takes three arguments:
1. client-side id
2. filter expr

Parameters:
fn - Filter listener.
key - (optional) Key with which to unregister listener (defaults to fn).

addSelectionChangeListener

void addSelectionChangeListener(fn, value)

Adds selection-change listener. Listener notified when selection of specified value changes. Selection-change listener function takes three arguments:
1. client-side control id
2. item value
3. new selection state (true/false)

Parameters:
fn - Selection-change listener.
value - Selection value for which to listen.

filter

void filter(expr)

Filters the items with the specified expression string. If this control is bound to a server-side data-model which has server-side filtering enabled, the items will be filtered on the server; otherwise they will be filtered one the client. Note that not all select models are filterable.

Parameters:
expr - Expression string. Null or empty ("") signals show the default set of options.

get

Object get(x)

Returns item at the specified index or with the specified value.

Parameters:
x - Zero-based item index or value, or array of indicies or values.

Returns:
Found CAF.Select.Item.Models, or null if all indicies out of range or no items found.

getValue

Object getValue()

Gets this control's string or string array value.

Returns:
String value, or in the case of a control with multiple values, an array of string values. If the control has no value, returns an empty string ("") or an empty arry ([]); never null.

indexOf

Object indexOf(x)

Returns index of specified value or item.

Parameters:
x - Value or existing CAF.Select.Item.Model, or array of values or CAF.Select.Item.Models.

Returns:
Index of item, or -1 for each item not found.

isSelected

Object isSelected(x)

Returns true if the item at specified index or with the specified value is selected.

Parameters:
x - Zero-based item index or value or existing CAF.Select.Item.Model, or array of indicies, values, or CAF.Select.Item.Models.

Returns:
True if all items are selected, or false if all indicies out of range or no items found

list

Object list()

Returns array of items in model.

Returns:
Array of CAF.Select.Item.Models. May be empty; never null.

listFilterListeners

Object listFilterListeners()

Lists registered filter listeners.

Parameters:
Array - of filter listener fns. Never null.

listSelectionChangeListeners

Object listSelectionChangeListeners(value)

Lists selection-change listeners for this control, optionally for the specified value.

Parameters:
value - (optional) If specified, list selection-change listeners registered for this value only.

Returns:
Array of selection-change listeners or empty array.

remove

Object remove(x)

Removes item at the specified index or with the specified value.

Parameters:
x - Zero-based item index or value or existing CAF.Select.Item.Model, or array of indicies, values, or CAF.Select.Item.Models.

Returns:
Old CAF.Select.Item.Models, or null if all indicies out of range or no items found.

removeAll

Object removeAll()

Removes all items from this control.

Returns:
Array of removed CAF.Select.Item.Models.

removeFilterListener

void removeFilterListener(fn)

Removes filter listener.

Parameters:
fn - Filter listener.

removeSelectionChangeListener

void removeSelectionChangeListener(fn, value)

Removes selection-change listener.

Parameters:
fn - Selection-change listener.
value - Selection value for which to listen.

selectAll

void selectAll(selected)

Selects all items.

Parameters:
selected - (optional) True to select all, false to unselect all.

selected

Object selected()

Returns array of selected items in model.

Returns:
Array of CAF.Select.Item.Models. May be empty; never null.

selectNone

void selectNone()

Unselects all items.

set

Object set(x, item)

Set item at the specified index or with the specified value.

Parameters:
x - Zero-based item index or value or existing CAF.Select.Item.Model, or array of indicies, values, or CAF.Select.Item.Models.
item - CAF.Select.Item.Model or array of CAF.Select.Item.Models.

Returns:
Old CAF.Select.Item.Models, or null if all indicies out of range or no items found.

setDisabled

Object setDisabled(disabled)

Sets this control as disabled or enabled.

Returns:
True to disabled, false to enable.

setSelected

Object setSelected(x, selected)

Selects or unselects item at the specified index or with the specified value.

Parameters:
x - Zero-based item index or value or existing CAF.Select.Item.Model, or array of indicies, values, or CAF.Select.Item.Models.
optional - ) selected True to select items, false to unselect.

Returns:
Newly selected or unselected CAF.Select.Item.Models, or null if all indicies out of range or no items newly selected or unselected. If CAF.Select.Item.Model was already selected/unselected, it is not considered newly selected/unselected.

setValue

void setValue(value)

Sets this control's string or string array value.

Parameters:
value - String value, or in the case of a control with multiple values, an array of string values. If the control has no value, pass an empty string ("") or an empty arry ([]); never null.

size

Object size()

Counts number of items in model.

Returns:
Number of CAF.Select.Item.Model.