IEventManager

Расширяет IEventTrigger .

Менеджер событий. При помощи менеджера событий можно подписываться на события и отписываться от них, а также инициировать сами события.

Конструктор | Методы

Конструктор

IEventManager()

Методы

Имя Возвращает Описание
add (types, callback[, context[, priority]])

IEventManager

Добавляет новую подписку.

fire (type[, event])

IEventManager

Инициирует событие.

getParent ()

IEventManager |null

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

group ()

IEventGroup

Возвращает группу слушателей событий, ассоциированную с данным менеджером событий.

once (types, callback[, context[, priority]])

IEventManager

Добавляет слушателя, который вызовет функцию-обработчик только 1 раз.

remove (types, callback[, context[, priority]])

IEventManager

Удаляет существующую подписку.

setParent (parent)

Устанавливает родительский менеджер событий.

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

add

Добавляет новую подписку.

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

Параметры:

Параметр Значение по умолчанию Описание
types *

Тип: String|String[]

Тип события или массив типов.

callback *

Тип: Function

Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Может быть либо произвольным объектом, либо реализовывать интерфейс IEvent .

context

Тип: Object

Контекст исполнения обработчика.

priority 0

Тип: Integer

Приоритет подписки.

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

fire

{IEventManager} fire(type[, event])

Инициирует событие.

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

Параметры:

Параметр Значение по умолчанию Описание
type *

Тип: String

Тип события.

event

Тип: Object| Event

Событие. Если передан хэш с данными, то для него будет вызван метод createEventObject, и дальнейшие действия будут производиться с новым созданным событием.

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

getParent

{IEventManager|null} getParent()

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

group

{IEventGroup} group()

Возвращает группу слушателей событий, ассоциированную с данным менеджером событий.

once

Добавляет слушателя, который вызовет функцию-обработчик только 1 раз.

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

Параметры:

Параметр Значение по умолчанию Описание
types *

Тип: String|String[]

Тип события или массив типов.

callback *

Тип: Function

Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Этот объект должен реализовывать интерфейс IEvent .

context

Тип: Object

Контекст исполнения обработчика.

priority 0

Тип: Integer

Приоритет подписки.

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

remove

Удаляет существующую подписку.

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

Параметры:

Параметр Значение по умолчанию Описание
types *

Тип: String|String[]

Тип события или массив типов.

callback *

Тип: Function

Функция-обработчик события. В качестве параметра в функцию передается объект, описывающий событие. Этот объект должен реализовывать интерфейс IEvent .

context

Тип: Object

Контекст исполнения обработчика.

priority 0

Тип: Integer

Приоритет подписки.

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

setParent

{} setParent(parent)

Устанавливает родительский менеджер событий.

Параметры:

Параметр Значение по умолчанию Описание
parent *

Тип: IEventManager |null

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

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