IOptionManager

Расширяет IChild, IEventEmitter, IFreezable.

Интерфейс менеджера опций. Менеджер опций позволяет задавать значения опций, строить иерархию наследования опций, а также разрешать значения опций в контексте существующей иерархии наследования.

Конструктор | Поля | События | Методы

Конструктор

IOptionManager()

Поля

Имя

Тип

Описание

events

IEventManager

Менеджер событий объекта.

Унаследовано от IFreezable.

События

Имя

Описание

change

Изменение опций.

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.

Методы

Имя

Возвращает

Описание

freeze()

IFreezable

Переводит объект в "замороженный" режим.

Унаследован от IFreezable.

get(key[, defaultValue])

Возвращает значение заданной опции в контексте существующей иерархии наследования опций. При вызове данного метода сначала происходит поиск значения в текущем менеджере опций, а затем, если значение не определено, поиск продолжается в иерархии родительских менеджеров.

getAll()

Object

Возвращает ссылку на внутренний хэш хранящий значения опций.

getName()

String

Возвращает имя менеджера опций.

getNative(key)

Object

Возвращает значение заданной опции, определенное на данном уровне иерархии опций, т.е. в данном менеджере.

getParent()

IOptionManager|null

Возвращает родительский менеджер опций.

isFrozen()

Boolean

Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.

resolve(key[, name])

Object

Метод, предназначенный для вызова дочерними менеджерами опций.

setName(name)

Задает имя менеджера опций.

setParent(parent)

IChild

Задает родительский менеджер опций.

unfreeze()

IFreezable

Переводит объект в активный режим.

Унаследован от IFreezable.

Описание событий

change

Изменение опций.

Описание методов

get

{} get(key[, defaultValue])

Возвращает значение заданной опции в контексте существующей иерархии наследования опций. При вызове данного метода сначала происходит поиск значения в текущем менеджере опций, а затем, если значение не определено, поиск продолжается в иерархии родительских менеджеров.

Параметры:

Параметр

Значение по умолчанию

Описание

key*

—

Тип: String

Имя опции.

defaultValue

—

Тип: Object

Значение по умолчанию.

* Обязательный параметр/опция.

getAll

{Object} getAll()

Возвращает ссылку на внутренний хэш хранящий значения опций.

getName

{String} getName()

Возвращает имя менеджера опций.

getNative

{Object} getNative(key)

Возвращает значение заданной опции, определенное на данном уровне иерархии опций, т.е. в данном менеджере.

Параметры:

Параметр

Значение по умолчанию

Описание

key*

—

Тип: String

Имя опции.

* Обязательный параметр/опция.

getParent

{IOptionManager|null} getParent()

Возвращает родительский менеджер опций.

resolve

{Object} resolve(key[, name])

Метод, предназначенный для вызова дочерними менеджерами опций.

Возвращает значение опции в родительском контексте.

Параметры:

Параметр

Значение по умолчанию

Описание

key*

—

Тип: String

Имя опции.

name

—

Тип: String

Имя дочернего менеджера опций.

* Обязательный параметр/опция.

setName

{} setName(name)

Задает имя менеджера опций.

Параметры:

Параметр

Значение по умолчанию

Описание

name*

—

Тип: String

Имя менеджера опций.

* Обязательный параметр/опция.

setParent

{IChild} setParent(parent)

Задает родительский менеджер опций.

Возвращает ссылку на себя.

Параметры:

Параметр

Значение по умолчанию

Описание

parent*

—

Тип: IOptionManager|null

Родительский менеджер опций.

* Обязательный параметр/опция.

Предыдущая
IMultiRouterRouteBalloon
Следующая
IOverlay