TINY NEWS: TinyMCE 5 Developer Challenge now on.  Find out more

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});

Methods

name summary defined by
fire() Fires the specified event by name. tinymce.util.EventDispatcher
has() Returns true/false if the dispatcher has a event of the specified name. tinymce.util.EventDispatcher
isNative() Returns true/false if the specified event name is a native browser event or not. tinymce.util.EventDispatcher
off() Unbinds an event listener to a specific event by name. tinymce.util.EventDispatcher
on() Binds an event listener to a specific event by name. tinymce.util.EventDispatcher
once() Binds an event listener to a specific event by name and automatically unbind the event once the callback fires. tinymce.util.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, first: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.
  • first (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, first: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.
  • first (Boolean) - Optional flag if the event should be prepended. Use this with care.
Return value
  • Object - Current class instance.

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.