IEventManager
Менеджер событий. Большинство объектов API имеют поле events, реализующее данный интерфейс. При помощи менеджера событий можно подписываться и отписываться от событий, а также инициировать сами события.
Конструктор
IEventManager()
Методы
Имя |
Возвращает |
Описание |
Добавляет новую подписку. |
||
fire(type[, eventObject]) |
Бросает событие. |
|
IEventManager|null |
Returns ссылку на родительский менеджер событий. |
|
group() |
Returns контейнер событий, привязанный к данному менеджеру. |
|
Удаляет существующую подписку. |
||
Устанавливает родительский менеджер событий. |
Описание методов
add
{IEventManager} add(types, callback[, context])
Добавляет новую подписку.
Returns ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String|String[] Тип или массив типов события. |
|
— |
Тип: Function Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Может быть либо произвольным объектом, либо реализовывать интерфейс IEvent. |
|
— |
Тип: Object Контекст исполнения обработчика. |
* Обязательный параметр/опция.
fire
{IEventManager} fire(type[, eventObject])
Бросает событие.
Returns ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String|String[] Тип или массив типов события. |
|
— |
Тип: Object|IEvent Объект, описывающий событие. Может быть либо произвольным объектом, либо реализовывать интерфейс IEvent. Во втором случае после вызова каждого обработчика будет проверяться значение метода isImmediatePropagationStopped() - если оно истинно, оповещение о событии немедленно прекращается. |
* Обязательный параметр/опция.
getParent
{IEventManager|null} getParent()
Returns ссылку на родительский менеджер событий.
group
{IEventGroup} group()
Returns контейнер событий, привязанный к данному менеджеру.
remove
{IEventManager} remove(types, callback[, context])
Удаляет существующую подписку.
Returns ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String|String[] Тип или массив типов события. |
|
— |
Тип: Function Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Может быть либо произвольным объектом, либо реализовывать интерфейс IEvent. |
|
— |
Тип: Object Контекст исполнения обработчика. |
* Обязательный параметр/опция.
setParent
{} setParent(parent)
Устанавливает родительский менеджер событий.
Параметры:
Заголовок1 |
Заголовок2 |
Заголовок2 |
|
— |
Тип: IEventManager|null Родительский менеджер событий. |
* Обязательный параметр/опция.
Обязательный параметр/опция.