Class CAF.Output.Model

Object
   |
   +--CAF.Output.Model

Direct Known Subclasses:

CAF.OverlayPanel.Model, CAF.Dialog.Modeless.Model, CAF.Newsfeed.Model, CAF.Dialog.Modal.Model, CAF.Popup.Model, CAF.Input.Model, CAF.RefreshInterval.Model, CAF.Message.Model, CAF.ToggleMenus.Model, CAF.Image.Model, CAF.Link.Model

class CAF.Output.Model

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

Field Detail

form

Object form

Form to which this command applies. Readonly.

id

Object id

Client-side id. Readonly.

CAF.Output.Model

CAF.Output.Model()

_reapplyOriginalStyle

void _reapplyOriginalStyle(originalStyle, element)

addRefreshCompleteListener

void addRefreshCompleteListener(fn)

Adds refresh-complete listener. Refresh-complete listener function takes one argument:
1. refreshed control id

Parameters:
fn - Refresh-complete listener.

addToggleListener

void addToggleListener(fn, key)

Adds toggle listener. Toggle listener function takes one argument, and object with the following properties:

id

Id of toggled control.

way

"show" when toggled visible, "hide" when toggled hidden.

Parameters:
fn - Toggle listener.

equals

Object equals(o)

Custom equals method.

Parameters:
o - Model to compare to this.

Returns:
True if the two models are equal.

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.

hide

void hide(callback)

Hides this control.

initialize

void initialize(element)

Model constructor.

Parameters:
element - Control element or id.

isDisabled

Object isDisabled()

Returns true if this control is disabled.

Returns:
True if this control is disabled.

isFocused

Object isFocused()

Returns true if this control is focused. For a panel control, returns true if a child is focused.

Returns:
True if this control is focused.

isVisible

Object isVisible()

Returns true if this control is visible.

Returns:
true if this control is visible.

listRefreshCompleteListeners

Object listRefreshCompleteListeners(fn)

Lists registered refresh-complete listeners.

Returns:
Array of refresh-complete listeners or empty array.

listToggleListeners

Object listToggleListeners(fn)

Lists registered toggle listeners.

Returns:
Array of toggle listeners or empty array.

reAttachBehaviors

void reAttachBehaviors()

refresh

void refresh(params)

Refreshes the content of this control from the server.

refreshWhenVisible

void refreshWhenVisible()

If visible, refreshes the content of this control from the server; if not visible, flags the control to refresh its content when toggled visible.

removeRefreshCompleteListener

void removeRefreshCompleteListener(fn)

Removes refresh-complete listener.

Parameters:
fn - Refresh-complete listener.

removeToggleListener

void removeToggleListener(fn, key)

Removes toggle listener.

Parameters:
fn - Toggle 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. For a panel control, attempts to give focus to a focusable child.

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

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.

setVisible

void setVisible(visible)

Sets this control as shown or hidden.

Parameters:
visible - True to show, false to hide.

show

void show(callback)

Shows this control.

toggle

void toggle()

Hides this control, if visible, otherwise shows this control.

toString

Object toString()

Custom toString method.

Returns:
String value of model.