oracle.javatools.editor.plugins

Interface EditorPlugin

All Superinterfaces:

java.util.EventListener, java.beans.PropertyChangeListener

All Known Subinterfaces:

Insight

All Known Implementing Classes:

AbstractBrowseClickPlugin, AbstractClickPlugin, AbstractCodeFoldingPlugin, AbstractEditingPlugin, AbstractEditorHoverPlugin, AbstractEditorPlugin, AbstractFoldingMargin, AbstractInsight, BraceMatchingPlugin, BreadcrumbsPlugin, CodeEditorGutter, DragDropPlugin, DropHandlerPlugin, DropTargetPlugin, EditorStatusBar, EmacsAction.Tracker, FileOverviewMargin, FindHighlightPlugin, GuardedHighlightPlugin, HtmlPopup, InlineCodeHighlighter, LineGutterPlugin, LineHighlightPlugin, PopupWindowManager, ScrollTipPlugin, SelectionSurroundPlugin, StatusBarPlugin, TrailingSpacePlugin, ZoomTextPlugin

public interface EditorPlugin
extends java.beans.PropertyChangeListener

The EditorPlugin interface describes the routines that an editor plugin must implement to integrate with the editor framework. An editor plugin is any module which is not a required part of the editor that provides some added feature or benefit to the user. An example of this is the plugin which provides Brace Matching highlighting.

The install and deinstall routines are provided as a convenient time for plugins to add or remove themselves as listeners to the various pieces of the editor, such as the caret or document. The property change notification allows the editor pane to notify plugins of important property changes, such as a document change, caret change, language support change, and so on.

See Also:

BasicEditorPane

Method Summary

Methods

Modifier and Type	Method and Description
void	deinstall(BasicEditorPane editor) Called when the plugin is being removed from the BasicEditorPane (for example when the editor is closed.) This is used to notify plugins that they should unregister any listeners that were attached.
void	install(BasicEditorPane editor) Called when this plugin is being installed into the BasicEditorPane.

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Method Detail

install

void install(BasicEditorPane editor)

Called when this plugin is being installed into the BasicEditorPane.

Parameters:

editor - the editor pane

deinstall

void deinstall(BasicEditorPane editor)

Called when the plugin is being removed from the BasicEditorPane (for example when the editor is closed.) This is used to notify plugins that they should unregister any listeners that were attached.

Parameters:

editor - the editor pane