Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

IFreezable

Interface for an object with a state change event that can be disabled. Object that implements IFreezable; it can function in one of the following modes:

  • 1. Active. In this mode, each change to the internal state of the object generates an IFreezable.change event.
  • 2. Frozen. In this mode, changes to the object state do not cause an IFreezable.change event, but if changes occurred, the IFreezable.change event will be generated once when switching to active mode.

Constructor | Fields | Events | Methods

Constructor

IFreezable()

Fields

NameTypeDescription
eventsIEventManager

Event manager for the object.

Events

NameDescription
change

Change to the internal state of the object.

Methods

NameReturnsDescription
freeze()

IFreezable

Switches the object to "frozen" mode.

isFrozen()

Boolean

Returns true if the object is in "frozen" mode, otherwise false.

unfreeze()

IFreezable

Switches the object to active mode.

Fields details

events

{IEventManager} events

Event manager for the object.

Events details

change

Change to the internal state of the object.

Methods details

freeze

{IFreezable} freeze()

Switches the object to "frozen" mode.

Returns self-reference.

isFrozen

{Boolean} isFrozen()

Returns true if the object is in "frozen" mode, otherwise false.

unfreeze

{IFreezable} unfreeze()

Switches the object to active mode.

Returns self-reference.