Class CAF.Input.Model

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

Direct Known Subclasses:

CAF.PagingJumper.Model, CAF.GMap.Model, CAF.FilterInput.Model, CAF.Input.File.Model, CAF.Select.Model, CAF.HTMLInput.Model, CAF.SelectAllRows.Checkbox.Model, CAF.Tree.Control.Model, CAF.DateInput.Model, CAF.Checkbox.Model, CAF.PopupCalendar.Model, CAF.SimpleSchedule.Model

class CAF.Input.Model

extends CAF.Output.Model

CAF Input client-side model.
Defined in core.js

Field Detail

classes

Object classes

CAF.Input.Model

CAF.Input.Model()

addValidator

void addValidator(validator)

Adds a validator. Validator function takes two arguments:
1. client-side control id
2. control value

Parameters:
validator - Validator function.

addValueChangeListener

void addValueChangeListener(fn, ignoreWhenDisabled, key)

Adds value-change listener. Value-change listener function takes three arguments:
1. client-side control id
2. old value
3. new value

Parameters:
fn - Value-change listener.
ignoreWhenDisabled - True to ignore value-changes when control is disabled.

getLabel

Object getLabel()

Gets input's label HTML (if input has label).

Returns:
Un-escaped input label, or null if no label.

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.

isEmpty

Object isEmpty()

Returns true if a value hasn't been entered for this control (ie should fail "required" validation).

Returns:
True if a value hasn't been entered for this control.

isFocused

Object isFocused()

Returns true if this control is focused.

Returns:
True if this control is focused.

listValidators

Object listValidators()

Lists registered validators.

Returns:
Array of validators or empty array.

listValueChangeListeners

Object listValueChangeListeners()

Lists registered value-change listeners.

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

removeValidator

void removeValidator(validator)

Removes a validator.

Parameters:
validator - Validator function.

removeValueChangeListener

void removeValueChangeListener(fn)

Removes value-change listener.

Parameters:
fn - Value-change listener.

setDisabled

Object setDisabled(disabled)

Sets this control as disabled or enabled.

Returns:
True to disabled, false to enable.

setFocused

Object setFocused(focus)

Sets this control as focused or not focused.

Returns:
True to focus, false to remove focus (aka blur).

setLabel

void setLabel(label)

Sets input's label HTML (if input has label).

Parameters:
Un - -escaped input label.

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.

validate

Object validate(setfocus)

Re-validates this input control. If invalid, adds validation messages for control; if valid, removes validation messages for control.

Parameters:
setfocus - (optional) True to set focus to control if invalid.

Returns:
Aggregate error detail (un-escaped html) if invalid, empty string if valid.