tinymce.util.Observable

This mixin adds event binding logic to classes. Adapts the EventDispatcher class.

Summary

Methods

Name Summary Defined by

dispatch()

Dispatches the specified event by name. Consult the event reference for more details on each event.

Observable

fire()

Fires the specified event by name. Consult the event reference for more details on each event.

Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use dispatch instead.

Observable

hasEventListeners()

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

Observable

off()

Unbinds an event listener to a specific event by name. Consult the event reference for more details on each event.

Observable

on()

Binds an event listener to a specific event by name. Consult the event reference for more details on each event.

Observable

once()

Bind the event callback and once it fires the callback is removed. Consult the event reference for more details on each event.

Observable

Methods

dispatch()

dispatch(name: String, args: Object?, bubble: Boolean?): Object
javascript

Dispatches the specified event by name. Consult the event reference for more details on each event.

Examples

instance.dispatch('event', {...});
javascript

Parameters

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

  • args (Object?) - Event arguments.

  • bubble (Boolean?) - True/false if the event is to be bubbled.

Return value

  • Object - Event args instance passed in.

fire()

fire(name: String, args: Object?, bubble: Boolean?): Object
javascript

Fires the specified event by name. Consult the event reference for more details on each event.

Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use dispatch instead.

Examples

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

Parameters

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

  • args (Object?) - Event arguments.

  • bubble (Boolean?) - True/false if the event is to be bubbled.

Return value

  • Object - Event args instance passed in.

hasEventListeners()

hasEventListeners(name: String): Boolean
javascript

Returns true/false if the object 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.

off()

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

Unbinds an event listener to a specific event by name. Consult the event reference for more details on each event.

Examples

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

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

// Unbind all events
instance.off();
javascript

Parameters

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

  • callback (Function?) - Callback to unbind.

Return value

  • Object - Current class instance.

on()

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

Binds an event listener to a specific event by name. Consult the event reference for more details on each event.

Examples

instance.on('event', (e) => {
  // Callback logic
});
javascript

Parameters

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

  • callback (Function) - 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: Function): Object
javascript

Bind the event callback and once it fires the callback is removed. Consult the event reference for more details on each event.

Parameters

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

  • callback (Function) - Callback to bind only once.

Return value

  • Object - Current class instance.