IEventManager
Расширяет IEventTrigger.
Менеджер событий. При помощи менеджера событий можно подписываться на события и отписываться от них, а также инициировать сами события.
Конструктор
IEventManager()
Методы
Имя |
Возвращает |
Описание |
Добавляет новую подписку. |
||
Инициирует событие. |
||
IEventManager|null |
Возвращает ссылку на родительский менеджер событий. |
|
group() |
Возвращает группу слушателей событий, ассоциированную с данным менеджером событий. |
|
Добавляет слушателя, который вызовет функцию-обработчик только 1 раз. |
||
Удаляет существующую подписку. |
||
Устанавливает родительский менеджер событий. |
Описание методов
add
{IEventManager} add(types, callback[, context[, priority]])
Добавляет новую подписку.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String|String[] Тип события или массив типов. |
|
— |
Тип: Function Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Может быть либо произвольным объектом, либо реализовывать интерфейс IEvent. |
|
— |
Тип: Object Контекст исполнения обработчика. |
|
0 |
Тип: Integer Приоритет подписки. |
* Обязательный параметр/опция.
fire
{IEventManager} fire(type[, event])
Инициирует событие.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
|
— |
Тип: String Тип события. |
|
— |
Тип: Object |
Событие. Если передан хэш с данными, то для него будет вызван метод createEventObject, и дальнейшие действия будут производиться с новым созданным событием. |
* Обязательный параметр/опция.
getParent
{IEventManager|null} getParent()
Возвращает ссылку на родительский менеджер событий.
group
{IEventGroup} group()
Возвращает группу слушателей событий, ассоциированную с данным менеджером событий.
once
{IEventManager} once(types, callback[, context[, priority]])
Добавляет слушателя, который вызовет функцию-обработчик только 1 раз.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String|String[] Тип события или массив типов. |
|
— |
Тип: Function Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Этот объект должен реализовывать интерфейс IEvent. |
|
— |
Тип: Object Контекст исполнения обработчика. |
|
0 |
Тип: Integer Приоритет подписки. |
* Обязательный параметр/опция.
remove
{IEventManager} remove(types, callback[, context[, priority]])
Удаляет существующую подписку.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String|String[] Тип события или массив типов. |
|
— |
Тип: Function Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Этот объект должен реализовывать интерфейс IEvent. |
|
— |
Тип: Object Контекст исполнения обработчика. |
|
0 |
Тип: Integer Приоритет подписки. |
* Обязательный параметр/опция.
setParent
{} setParent(parent)
Устанавливает родительский менеджер событий.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IEventManager|null Родительский менеджер событий. |
* Обязательный параметр/опция.
Обязательный параметр.