Модуль y5.Events

Функции для создания слушателей событий, изменения свойств и создания событий.

Находится в базовом файле y5.js.

notify

y5.Events.notify(type, element, dispatch, event, permanent) -> y5.Event, y5.Notifier

Создает событие на элементе.

Имя аргументаТипОписание
typeStringтип события: click, mousedown... (если не указан, то используется click)
elementObjectцелевой элемент события (если не указан, то используется document)
dispatchBooleanотправить событие (если не указано, то событие возникает сразу)
eventObjectпараметры события
permanentBoolean"постоянное" событие

Пример:

// создать событие "mousedown" на элементе
y5.Events.notify("mousedown", element);

// создать событие "click" на документе
y5.Events.notify();

// создать событие "click" на элементе
var evt = y5.Events.notify("mousedown", element, false);
// ...
// выполнить его позже
// evt.dispatch()

observe

y5.Events.observe(type, listener, element, add, context, runOnce) -> y5.AEventListener, y5.Observer, Array

Создает один или несколько объектов-слушателей.

Имя аргументаТипОписание
typeString, Arrayтип события: click, load...
listenerFunctioncallback-функция на возникновение события
elementElement, Objectобъект на котором возникает событие
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener
runOnceBooleanобработать событие один раз и удалить обработчик. По умолчанию, false.

Пример:

y5.Events.observe("click", callback, element, true);

observeEvent

y5.Events.observeEvent(type, listener, element, add, context, runOnce)

Создает один объект-слушатель.

Имя аргументаТипОписание
type
listener
element
add
context
runOnce

observeInput

y5.Events.observeInput(listener, element, add, context) -> y5.InputObserver

Слушатель изменения элемента ввода.

Имя аргументаТипОписание
listenerFunctioncallback-функция
elementElementэлемент
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener

Пример:

y5.Events.observeInput("value", callback, element, true);

observeOnce

y5.Events.observeOnce(types, listener, element, add, context) -> y5.AEventListener, y5.Observer, Array

Создает один или несколько одноразовых объектов-слушателей, обработчики удаляются после наступления события.

Имя аргументаТипОписание
typesString, Arrayтип события: click, load...
listenerFunctioncallback-функция на возникновение события
elementElement, Objectобъект на котором возникает событие
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener

Пример:

y5.Events.observe("click", callback, element, true);

observeProperty

y5.Events.observeProperty(property, listener, element, add, context, runOnce) -> y5.AEventListener

Слушатель изменения свойств элемента.

Имя аргументаТипОписание
propertyStringсвойство
listenerFunctioncallback-функция
elementElementэлемент
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener
runOnceBooleanобработать событие один раз и удалить обработчик. По умолчанию, false.

Пример:

y5.Events.observeProperty("value", callback, element, true);

observePropertyOnce

y5.Events.observePropertyOnce(property, listener, element, add, context) -> y5.AEventListener

Одноразовый слушатель изменения свойств элемента. После наступления события обработчик удаляется.

Имя аргументаТипОписание
propertyStringсвойство
listenerFunctioncallback-функция
elementElementэлемент
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener

Пример:

y5.Events.observeProperty("value", callback, element, true);

observeTimer

y5.Events.observeTimer(listener, period, add, context) -> y5.TimerObserver

Вызов функции по таймеру.

Имя аргументаТипОписание
listenerFunctioncallback-функция
periodNumberпериодичность запуска функции (в секундах)
addBooleanначать слушать немедленно (false - по умолчанию)
contextObjectконтекст выполнения функции listener

Пример:

function callback(observer) {
    // ...
    // останавливаем таймер после 10 запусков
    if (observer.tick == 10) {
        observer.remove();
    }
}
y5.Events.observeTimer(callback, 5, true);

make

Устарело, используйте y5.Events.notify.

y5.Events.make()

create

Устарело, используйте y5.Events.observe.

y5.Events.create()

PropertyListener

Устарело, используйте y5.Events.observeProperty.

y5.Events.PropertyListener()