IOptionManager
Расширяет IChild, IEventEmitter, IFreezable.
Интерфейс менеджера опций. Менеджер опций позволяет задавать значения опций, строить иерархию наследования опций, а также разрешать значения опций в контексте существующей иерархии наследования.
Конструктор
IOptionManager()
Поля
|
Имя |
Тип |
Описание |
|
Менеджер событий объекта. Унаследовано от IFreezable. |
События
|
Имя |
Описание |
|
Изменение опций. |
|
|
Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от IChild. |
Методы
|
Имя |
Возвращает |
Описание |
|
freeze() |
Переводит объект в "замороженный" режим. Унаследован от IFreezable. |
|
|
get(key[, defaultValue]) |
Возвращает значение заданной опции в контексте существующей иерархии наследования опций. При вызове данного метода сначала происходит поиск значения в текущем менеджере опций, а затем, если значение не определено, поиск продолжается в иерархии родительских менеджеров. |
|
|
getAll() |
Object |
Returns ссылку на внутренний хэш хранящий значения опций. |
|
getName() |
String |
Returns имя менеджера опций. |
|
Object |
Returns значение заданной опции, определенное на данном уровне иерархии опций, т.е. в данном менеджере. |
|
|
IOptionManager|null |
Returns родительский менеджер опций. |
|
|
isFrozen() |
Boolean |
Returns true, если объект находится в "замороженном" режиме, иначе false. Унаследован от IFreezable. |
|
Object |
Метод, предназначенный для вызова дочерними менеджерами опций. |
|
|
Задает имя менеджера опций. |
||
|
Задает родительский менеджер опций. |
||
|
unfreeze() |
Переводит объект в активный режим. Унаследован от IFreezable. |
Описание событий
change
Изменение опций.
Описание методов
get
{} get(key[, defaultValue])
Возвращает значение заданной опции в контексте существующей иерархии наследования опций. При вызове данного метода сначала происходит поиск значения в текущем менеджере опций, а затем, если значение не определено, поиск продолжается в иерархии родительских менеджеров.
Returns значение заданной опции, либо defaultValue, если значение опции не определено.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: String Имя опции. |
|
|
— |
Тип: Object Значение по умолчанию. |
* Обязательный параметр/опция.
getAll
{Object} getAll()
Returns ссылку на внутренний хэш хранящий значения опций.
getName
{String} getName()
Returns имя менеджера опций.
getNative
{Object} getNative(key)
Returns значение заданной опции, определенное на данном уровне иерархии опций, т.е. в данном менеджере.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: String Имя опции. |
* Обязательный параметр/опция.
getParent
{IOptionManager|null} getParent()
Returns родительский менеджер опций.
resolve
{Object} resolve(key[, name])
Метод, предназначенный для вызова дочерними менеджерами опций.
Returns значение опции в родительском контексте.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: String Имя опции. |
|
|
— |
Тип: String Имя дочернего менеджера опций. |
* Обязательный параметр/опция.
setName
{} setName(name)
Задает имя менеджера опций.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: String Имя менеджера опций. |
* Обязательный параметр/опция.
setParent
{IChild} setParent(parent)
Задает родительский менеджер опций.
Returns ссылку на себя.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: IOptionManager/null Родительский менеджер опций. |
* Обязательный параметр/опция.
Обязательный параметр/опция.