Plugin

class Plugin

Instance Methods

executeMethod(name, params, callback): boolean

Defines the method used to execute certain editor methods using the plugin.

resizeWindow(width, height, minW, minH, maxW, maxH)

Defines the method used to change the window size updating the minimum/maximum sizes.

callCommand(func, isClose, isCalc, callback)

Defines the method used to send the data back to the editor.

callModule(url, callback, isClose)

Defines the method used to execute a remotely located script following a link.

loadModule(url, callback)

Defines the method used to load a remotely located text resource.

attachEvent(id, action)

Defines the method to add an event listener, a function that will be called whenever the specified event is delivered to the target.

attachContextMenuClickEvent(id, action)

Defines the method to add an event listener, a function that will be called whenever the specified event is clicked in the context menu.

createInputHelper()

Defines the method used to create an {@link inputhelper input helper} - a window that appears and disappears when you type text.

getInputHelper(): InputHelper

Defines the method used to get the {@link inputhelper InputHelper object}.

sendToPlugin(name, data): boolean

Sends a message from the modal window to the plugin.

Events

init(text)

The function called when the plugin is launched.

button(buttonIndex)

The function called when any of the plugin buttons is clicked.

onTargetPositionChanged()

The function called when the target position in the editor is changed.

onDocumentContentReady()

The function called when the document is completely loaded.

onClick(isSelectionUse)

The function called when the user clicks on the element.

inputHelper_onSelectItem(item)

The function called when the user is trying to select an item from the input helper.

onInputHelperClear()

The function called when the user is trying to clear the text and the input helper disappears.

onInputHelperInput(data)

The function called when the user is trying to input the text and the input helper appears.

onTranslate()

The function called right after the plugin startup or later in case the plugin language is changed.

onEnableMouseEvent(isEnabled)

The function called to turn the mouse or touchpad events on/off.

onExternalMouseUp()

The function called when the mouse button is released outside the plugin iframe.

onExternalPluginMessage(data)

The function called to show the editor integrator message.

onFocusContentControl(control)

The function called to show which content control has been focused.

onBlurContentControl(control)

The function called to show which content control has been blurred.

onChangeContentControl(control)

The function called to show which content control has been changed.

onContextMenuShow(options)

The function called when the context menu has been shown.

onContextMenuClick(id)

The function called when the context menu item has been clicked.

onToolbarMenuClick(id)

The function called when the toolbar menu item has been clicked.

onCommandCallback()

The function called to return the result of the previously executed command.

onMethodReturn(returnValue)

The function called to return the result of the previously executed method.

onAddComment(comment)

The function called when a comment is added to the document with the {@link /plugin/executeMethod/text/addcomment AddComment} method.

onChangeCommentData(comment)

The function called when the specified comment is changed with the {@link /plugin/executeMethod/text/changecomment ChangeComment} method.

onRemoveComment(comment)

The function called when the specified comment is removed with the {@link /plugin/executeMethod/text/removecomments RemoveComments} method.