oracle.javatools.editor.plugins
Class AbstractEditorPlugin

java.lang.Object
  oracle.javatools.editor.plugins.AbstractEditorPlugin

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, EditorPlugin

Direct Known Subclasses:

AbstractCodeFoldingPlugin

public abstract class AbstractEditorPlugin
extends java.lang.Object
implements EditorPlugin

The AbstractEditorPlugin provides a starting point implementation for an editor plugin that provides many of the common methods and fields used by plugins.

See Also:

EditorPlugin, BasicEditorPane

Field Summary

protected BasicEditorPane

_editor The current installed editor (if any).

Constructor Summary

AbstractEditorPlugin()

Method Summary

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.
protected void	deinstallImpl(BasicEditorPane editor) Deinstall routine for subclasses that have added deinstallation code to execute.
protected BasicDocument	getDocument() Fetch the document for the current installed editor apen.
protected BasicEditorPane	getEditorPane() Fetch the current installed editor pane.
void	install(BasicEditorPane editor) Called when this plugin is being installed into the BasicEditorPane.
protected void	installImpl(BasicEditorPane editor) Install routine for subclasses that have added installation code to execute.
void	propertyChange(java.beans.PropertyChangeEvent event) This method gets called when a bound property is changed.
protected void	propertyChangeImpl(java.beans.PropertyChangeEvent event) Property change notification routine for subclasses that have want to respond to property changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_editor

protected BasicEditorPane _editor

The current installed editor (if any).

Constructor Detail

AbstractEditorPlugin

public AbstractEditorPlugin()

Method Detail

install

public final void install(BasicEditorPane editor)

Called when this plugin is being installed into the BasicEditorPane.

Specified by:

install in interface EditorPlugin

Parameters:

editor - the editor pane

deinstall

public final 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.

Specified by:

deinstall in interface EditorPlugin

Parameters:

editor - the editor pane

propertyChange

public final void propertyChange(java.beans.PropertyChangeEvent event)

This method gets called when a bound property is changed.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

event - A PropertyChangeEvent object describing the event source and the property that has changed.

getEditorPane

protected BasicEditorPane getEditorPane()

Fetch the current installed editor pane.

Returns:

the installed editor pane, or null if not installed

getDocument

protected BasicDocument getDocument()

Fetch the document for the current installed editor apen.

Returns:

the document for the current editor, or null if not installed

installImpl

protected void installImpl(BasicEditorPane editor)

Install routine for subclasses that have added installation code to execute. This is performed after the abstract implementation performs its install tasks.

Parameters:

editor - the editor pane

deinstallImpl

protected void deinstallImpl(BasicEditorPane editor)

Deinstall routine for subclasses that have added deinstallation code to execute. This is performed before the abstract implementation performs its deinstall tasks.

Parameters:

editor - the editor pane

propertyChangeImpl

protected void propertyChangeImpl(java.beans.PropertyChangeEvent event)

Property change notification routine for subclasses that have want to respond to property changes. This is performed before the abstract implementation responds to property changes.

Parameters:

event - A PropertyChangeEvent object describing the event source and the property that has changed.