Options
All
  • Public
  • Public/Protected
  • All
Menu

Edit plugins helps editor to do editing operation on top of content model. This includes:

  1. Delete Key
  2. Backspace Key
  3. Tab Key

Hierarchy

  • EditPlugin

Implements

Index

Constructors

constructor

Methods

dispose

  • dispose(): void
  • The last method that editor will call to a plugin before it is disposed. Plugin can take this chance to clear the reference to editor. After this method is called, plugin should not call to any editor method since it will result in error.

    Returns void

getName

  • getName(): string

initialize

  • initialize(editor: IEditor): void
  • The first method that editor will call to a plugin when editor is initializing. It will pass in the editor instance, plugin should take this chance to save the editor reference so that it can call to any editor method or format API later.

    Parameters

    • editor: IEditor

      The editor object

    Returns void

onPluginEvent

  • Core method for a plugin. Once an event happens in editor, editor will call this method of each plugin to handle the event as long as the event is not handled exclusively by another plugin.

    Parameters

    Returns void

willHandleEventExclusively

  • willHandleEventExclusively(event: PluginEvent): boolean
  • Check if the plugin should handle the given event exclusively. Handle an event exclusively means other plugin will not receive this event in onPluginEvent method. If two plugins will return true in willHandleEventExclusively() for the same event, the final result depends on the order of the plugins are added into editor

    Parameters

    Returns boolean

Generated using TypeDoc