NOTE: TinyMCE 5 reached End of Support in April 2023. No more bug fixes, security updates, or new features will be introduced to TinyMCE 5. We recommend you upgrade to TinyMCE 6 or consider TinyMCE 5 Long Term Support (LTS) if you need more time.
tinymce.util.Observable
This mixin adds event binding logic to classes. Adapts the EventDispatcher class.
Methods
name | summary | defined by |
---|---|---|
fire() | Fires the specified event by name. Consult the event reference for more details on each event. | tinymce.util.Observable |
hasEventListeners() | Returns true/false if the object has a event of the specified name. | tinymce.util.Observable |
off() | Unbinds an event listener to a specific event by name. Consult the event reference for more details on each event. | tinymce.util.Observable |
on() | Binds an event listener to a specific event by name. Consult the event reference for more details on each event. | tinymce.util.Observable |
once() | Bind the event callback and once it fires the callback is removed. Consult the event reference for more details on each event. | tinymce.util.Observable |
Methods
fire
Fires the specified event by name. Consult the event reference for more details on each event.
Examples
instance.fire('event', {...});
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
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
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();
Parameters
- name (String?) - Name of the event to unbind.
- callback (callback?) - Callback to unbind.
Return value
- Object - Current class instance.
on
Binds an event listener to a specific event by name. Consult the event reference for more details on each event.
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
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 (callback) - Callback to bind only once.
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.