SwitchButton

ICE.UI. SwitchButton

new SwitchButton(model)

A switch input component.
Parameters:
Name Type Description
model ICE.UI.Model The component model.

Extends

Members

$dom :jQuery

Inherited From:
The component's DOM.
Type:

_kids :Array.<ICE.UI.Base>|Object.<String, ICE.UI.Base>

Inherited From:
The children components.
Type:

_locked :Boolean

Inherited From:
The flag whether component is locked.
Type:
  • Boolean

_name :String

Inherited From:
The name of component.
Type:
  • String

_parent :ICE.UI.Base

Inherited From:
The parent component.
Type:

command :ICE.Command

Inherited From:
The command instance.
Type:

content :ICE.UI.Content

Inherited From:
The model of component's content.
Type:

data :*

Inherited From:
The data to pass on command execution.
Type:
  • *

hidden :Boolean

Inherited From:
The flag whether component is hidden.
Type:
  • Boolean

model :ICE.UI.Model

Inherited From:
The component model.
Type:

size :number

The size. Values: ICE.UI.Button.SMALL, ICE.UI.Button.MEDIUM, ICE.UI.Button.NORMAL.
Type:
  • number

style :ICE.UI.SwitchButton.Style

The style.
Type:

suspendedOnce :Boolean

Inherited From:
The flag whether one command activation is suspended.
Type:
  • Boolean

Methods

ancestor(type) → {ICE.UI.Base}

Inherited From:
Returns ancestor of specified type.
Parameters:
Name Type Description
type ICE.UI.Base The type to look for.
Returns:
The UI component or null if there is none.
Type
ICE.UI.Base

(abstract) disable()

Inherited From:
Disables component.

(abstract) enable()

Inherited From:
Enables component.

has(name) → {Boolean}

Inherited From:
Determines whether component has property set.
Parameters:
Name Type Description
name String The property name.
Returns:
true if it has property set, false otherwise.
Type
Boolean

hide()

Inherited From:
Hides component.

html(formopt) → {jQuery}

Overrides:
Returns component's DOM element.
Parameters:
Name Type Attributes Description
form ICE.UI.Form <optional>
 The form.
Returns:
jQuery collection of DOM element.
Type
jQuery

htmlOf(content, formopt) → {jQuery}

Inherited From:
Returns a collection of DOM elements of a content.
Parameters:
Name Type Attributes Description
content ICE.UI.Content The content model.
form ICE.UI.Form <optional>
 The form.
Returns:
jQuery collection of DOM element(s).
Type
jQuery

is(prop)

Inherited From:
Determines value of boolean property.
Parameters:
Name Type Description
prop string The property name.
Returns:
true if property evaluates to true, false otherwise.

isSuspended() → {Boolean}

Inherited From:
Determines whether component has suspended activation.
Returns:
true if activation is suspended, false otherwise.
Type
Boolean

lock()

Inherited From:
Locks root component.

onChange(event)

Invoked when switch changes.
Parameters:
Name Type Description
event jQuery.Event The event.

onClick(event)

Inherited From:
Invoked when click event occurs. Executes command if not overridden.
Parameters:
Name Type Description
event jQuery.Event The event.

postHtml(form)

Inherited From:
Invoked after html method invocation for component during modeling.
Parameters:
Name Type Description
form ICE.UI.Form The form

preHtml(form)

Inherited From:
Invoked before html method invocation for component during modeling.
Parameters:
Name Type Description
form ICE.UI.Form The form

show()

Inherited From:
Shows component.

suspendOnce()

Inherited From:
Suspends one activation of command.

trigger(event)

Inherited From:
Triggers custom event for component and its descendants.
Parameters:
Name Type Description
event String The event name.

unlock()

Inherited From:
Unlocks root component.

update(model)

Inherited From:
Updates component according to a new model.
Parameters:
Name Type Description
model ICE.UI.Model The component model.

updateWith(content)

Inherited From:
Updates content of component.
Parameters:
Name Type Description
content ICE.UI.Content The content model.