Class CAF.Select.Item.Model

Object
   |
   +--CAF.Select.Item.Model

Direct Known Subclasses:

CAF.Message.Item.Model, CAF.Table.Row.Model

class CAF.Select.Item.Model

CAF SelectItem client-side model. Represents a select control option. Changes made to the option model are not reflected by the actual option unless CAF.Select.Model.set() is called.
Defined in select.js

Constructor Detail

CAF.Select.Item.Model

CAF.Select.Item.Model()

equals

Object equals(o)

Custom equals method.

Parameters:
o - Model to compare to this.

Returns:
True if the two models are equal.

getDescription

Object getDescription()

Gets this option's description.

Returns:
String description or "".

getIcon

Object getIcon()

Gets this option's icon url.

Returns:
Icon url or "".

getLabel

Object getLabel()

Gets this option's label.

Returns:
String label.

getStyle

Object getStyle()

Gets this option's inline css style.

Returns:
String inline css style or "".

getStyleClass

Object getStyleClass()

Gets this option's inline css style.

Returns:
String inline css style or "".

getValue

Object getValue()

Gets this option's string value.

Returns:
String value.

initialize

void initialize(value, label, description, disabled, style, styleClass, icon)

Initializer.

Parameters:
value - Item value.
label - Item label.
description - (optional) Extended description.
disabled - (optional) True if item is disabled.
style - (optional) HTML "style" attribute value.
icon - (optional) Icon url.

isDisabled

Object isDisabled()

True if option is disabled.

Returns:
True if option is disabled.

setDescription

void setDescription(description)

Sets this option's description.

Parameters:
label - String description or "".

setDisabled

void setDisabled(disabled)

Sets this option as enabled/disabled.

Parameters:
disabled - True to disable, false to enable.

setIcon

void setIcon(icon)

Sets this option's icon url.

Parameters:
icon - Icon url or "".

setLabel

void setLabel(label)

Sets this option's label.

Parameters:
label - String label.

setStyle

void setStyle(style)

Sets this option's inline css style.

Parameters:
style - String inline css style or "".

setStyleClass

void setStyleClass(styleClass)

Sets this option's css class.

Parameters:
styleClass - String css class name or "".

setValue

void setValue(value)

Sets this option's string value.

Parameters:
value - String value.

toString

Object toString()

Custom toString method.

Returns:
String value of model.