Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

ISelectableControl

Extends IControl.

Interface for a control that can be toggled and selected.

Constructor | Fields | Events | Methods

Constructor

ISelectableControl()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from IControl.

Events

NameDescription
deselect

The control is not selected.

disable

The control is unavailable.

enable

The control is available.

parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

select

The control is selected.

Methods

NameReturnsDescription
deselect()

Cancels selection of the control (turns it off).

disable()

Makes the control unavailable (user actions are not allowed).

enable()

Makes the control available (user actions are allowed).

getParent()

IControlParent|null

Returns link to the parent object, or null if the parent element was not set.

Inherited from IControl.

isEnabled()

Boolean

Returns true if the control is available, or false if it is unavailable.

isSelected()

Boolean

Returns true if the control is selected, or false if it is not selected.

select()

Selects (turns on) the control.

setParent(parent)

IChildOnMap

Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

Inherited from IControl.

Events details

deselect

The control is not selected.

disable

The control is unavailable.

enable

The control is available.

select

The control is selected.

Methods details

deselect

{} deselect()

Cancels selection of the control (turns it off).

disable

{} disable()

Makes the control unavailable (user actions are not allowed).

enable

{} enable()

Makes the control available (user actions are allowed).

isEnabled

{Boolean} isEnabled()

Returns true if the control is available, or false if it is unavailable.

isSelected

{Boolean} isSelected()

Returns true if the control is selected, or false if it is not selected.

select

{} select()

Selects (turns on) the control.