tinymce.util.EventDispatcher

This class lets you add/remove and fire events by name on the specified scope. This makes it easy to add event listener logic to any class.

Examples

var eventDispatcher = new EventDispatcher();

 eventDispatcher.on('click', function() {console.log('data');});
 eventDispatcher.fire('click', {data: 123});

Summary

Methods

Name Summary Defined by

fire()

Fires the specified event by name.

EventDispatcher

has()

Returns true/false if the dispatcher has a event of the specified name.

EventDispatcher

isNative()

Returns true/false if the specified event name is a native browser event or not.

EventDispatcher

off()

Unbinds an event listener to a specific event by name.

EventDispatcher

on()

Binds an event listener to a specific event by name.

EventDispatcher

once()

Binds an event listener to a specific event by name and automatically unbind the event once the callback fires.

EventDispatcher

Methods

fire()

fire(name: String, args: Object?): Object

Fires the specified event by name.

Examples

instance.fire('event', {...});

Parameters

  • name (String) - Name of the event to fire.

  • args (Object?) - Event arguments.

Return value

  • Object - Event args instance passed in.

has()

has(name: String): Boolean

Returns true/false if the dispatcher has a event of the specified name.

Parameters

  • name (String) - Name of the event to check for.

Return value

  • Boolean - true/false if the event exists or not.

isNative()

isNative(name: String): Boolean

Returns true/false if the specified event name is a native browser event or not.

Parameters

  • name (String) - Name to check if it’s native.

Return value

  • Boolean - true/false if the event is native or not.

off()

off(name: String?, callback: callback?): Object

Unbinds an event listener to a specific event by name.

Examples

// Unbind specific callback
instance.off('event', handler);

// Unbind all listeners by name
instance.off('event');

// Unbind all events
instance.off();

Parameters

  • name (String?) - Name of the event to unbind.

  • callback (callback?) - Callback to unbind.

Return value

  • Object - Current class instance.

on()

on(name: String, callback: callback, prepend: Boolean): Object

Binds an event listener to a specific event by name.

Examples

instance.on('event', function(e) {
    // Callback logic
});

Parameters

  • name (String) - Event name or space separated list of events to bind.

  • callback (callback) - Callback to be executed when the event occurs.

  • prepend (Boolean) - Optional flag if the event should be prepended. Use this with care.

Return value

  • Object - Current class instance.

once()

once(name: String, callback: callback, prepend: Boolean): Object

Binds an event listener to a specific event by name and automatically unbind the event once the callback fires.

Examples

instance.once('event', function(e) {
    // Callback logic
});

Parameters

  • name (String) - Event name or space separated list of events to bind.

  • callback (callback) - Callback to be executed when the event occurs.

  • prepend (Boolean) - Optional flag if the event should be prepended. Use this with care.

Return value

  • Object - Current class instance.