tinymce.dom.EventUtils

This class wraps the browsers native event logic with more convenient methods.

Summary

Methods

Name Summary Defined by

bind()

Binds a callback to an event on the specified target.

EventUtils

clean()

Removes all bound event listeners for the specified target. This will also remove any bound listeners to child nodes within that target.

EventUtils

dispatch()

Dispatches the specified event on the specified target.

EventUtils

fire()

Fires the specified event on the specified target.

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

EventUtils

unbind()

Unbinds the specified event by name, name and callback or all events on the target.

EventUtils

Methods

bind()

bind(target: Object, name: String, callback: Function, scope: Object): Function

Binds a callback to an event on the specified target.

Parameters

  • target (Object) - Target node/window or custom object.

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

  • callback (Function) - Callback function to execute when the event occurs.

  • scope (Object) - Scope to call the callback function on, defaults to target.

Return value

  • Function - Callback function that got bound.

clean()

clean(target: Object): EventUtils

Removes all bound event listeners for the specified target. This will also remove any bound listeners to child nodes within that target.

Parameters

  • target (Object) - Target node/window object.

Return value

  • EventUtils - Event utils instance.

dispatch()

dispatch(target: Node | window, name: String, args: Object): EventUtils

Dispatches the specified event on the specified target.

Parameters

  • target (Node | window) - Target node/window or custom object.

  • name (String) - Event name to dispatch.

  • args (Object) - Optional arguments to send to the observers.

Return value

  • EventUtils - Event utils instance.

fire()

fire(target: Object, name: String, args: Object): EventUtils

Fires the specified event on the specified target.

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

Parameters

  • target (Object) - Target node/window or custom object.

  • name (String) - Event name to fire.

  • args (Object) - Optional arguments to send to the observers.

Return value

  • EventUtils - Event utils instance.

unbind()

unbind(target: Object, name: String, callback: Function): EventUtils

Unbinds the specified event by name, name and callback or all events on the target.

Parameters

  • target (Object) - Target node/window or custom object.

  • name (String) - Optional event name to unbind.

  • callback (Function) - Optional callback function to unbind.

Return value

  • EventUtils - Event utils instance.