Class type Goog.​Geditor.​plugin

class type plugin = object..end

Inherits


method getFieldDomHelper : Goog.Gdom.domHelper Js.t Js.opt Js.meth

Returns The dom helper object associated with the currently active field.

method registerFieldObject : field Js.t -> unit Js.meth

Registers the field object for use with this plugin.

method unregisterFieldObject : field Js.t -> unit Js.meth

Unregisters and disables this plugin for the current field object.

method enable : field Js.t -> unit Js.meth

Enables this plugin for the specified, registered field object. A field object should only be enabled when it is loaded.

method disable : field Js.t -> unit Js.meth

Disables this plugin for the specified, registered field object.

method isEnabled : field Js.t -> bool Js.t Js.meth

Returns whether this plugin is enabled for the field object.

Returns Whether this plugin is enabled for the field object.

method setAutoDispose : bool Js.t -> unit Js.meth

Set if this plugin should automatically be disposed when the registered field is disposed.

method isAutoDispose : bool Js.t Js.meth

Returns Whether or not this plugin should automatically be disposed when it's registered field is disposed.

method activeOnUneditableFields : bool Js.t Js.meth

Returns If true, field will not disable the command when the field becomes uneditable.

method isSilentCommand : Js.js_string Js.t -> bool Js.t Js.meth

Returns If true, field will not dispatch change events for commands of this type. This is useful for "seamless" plugins like dialogs and lorem ipsum.

method disposeInternal : unit Js.meth

Handles execCommand. This default implementation handles dispatching

BEFORECHANGE, CHANGE, and SELECTIONCHANGE events, and calls execCommandInternal to perform the actual command. Plugins that want to do their own event dispatching should override execCommand, otherwise it is preferred to only override execCommandInternal.==

This version of execCommand will only work for single field plugins. Multi-field plugins must override execCommand.

method isSupportedCommand : Js.js_string Js.t -> bool Js.t Js.meth

Whether the string corresponds to a command this plugin handles.

Returns Whether the plugin handles this type of command.