tinymce.util.Observable

此 mixin 将事件绑定逻辑添加到类中。适配了 EventDispatcher 类。

摘要

方法

方法

dispatch()

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

按名称派发指定的事件。有关每个事件的更多详细信息，请参阅事件参考。

示例

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

参数

• name (String) - 要派发的事件的名称。

• args (Object?) - 事件参数。

• bubble (Boolean?) - 事件是否要冒泡的 true/false。

返回值

• Object - 传入的事件参数实例。

fire()

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

按名称触发指定的事件。有关每个事件的更多详细信息，请参阅事件参考。

在 TinyMCE 6.0 中已弃用，并标记为将在 TinyMCE 9.0 中移除。请改用 dispatch。

示例

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

参数

• name (String) - 要触发的事件的名称。

• args (Object?) - 事件参数。

• bubble (Boolean?) - 事件是否要冒泡的 true/false。

返回值

• Object - 传入的事件参数实例。

hasEventListeners()

hasEventListeners(name: String): Boolean

如果对象具有指定名称的事件，则返回 true/false。

参数

• name (String) - 要检查的事件的名称。

返回值

• Boolean - 事件是否存在的 true/false。

off()

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

按名称取消绑定特定事件的事件监听器。有关每个事件的更多详细信息，请参阅事件参考。

示例

// 取消绑定特定的回调函数
instance.off('event', handler);

// 按名称取消绑定所有的监听器
instance.off('event');

// 取消绑定所有的事件
instance.off();

参数

• name (String?) - 要取消绑定的事件的名称。

• callback (Function?) - 要取消绑定的回调函数。

返回值

• Object - 当前的类实例。

on()

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

按名称将事件监听器绑定到特定事件。有关每个事件的更多详细信息，请参阅事件参考。

示例

instance.on('event', (e) => {
  // 回调逻辑
});

参数

• name (String) - 要绑定的事件名称或以空格分隔的事件列表。

• callback (Function) - 事件发生时要执行的回调函数。

• prepend (Boolean) - 可选标志，指示是否应将事件前置。请谨慎使用此选项。

返回值

• Object - 当前的类实例。

once()

once(name: String, callback: Function): Object

绑定事件回调，一旦触发，回调将被移除。有关每个事件的更多详细信息，请参阅事件参考。

参数

• name (String) - 要绑定的事件的名称。

• callback (Function) - 只绑定一次的回调函数。

返回值

• Object - 当前类实例。