oracle.jdeveloper.java.browse
Class AbstractEditorPeekPlugin

java.lang.Object
  oracle.jdeveloper.java.browse.AbstractEditorPeekPlugin

All Implemented Interfaces:

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

Deprecated. superceeded by AbstractEditorHoverPlugin

@Deprecated
public abstract class AbstractEditorPeekPlugin
extends java.lang.Object
implements EditorPlugin

The AbstractEditorPeekPlugin is an abstract plugin implementation that helps in performing code peek for Java-like languages (basically, languages with descendants from C).

Constructor Summary

AbstractEditorPeekPlugin()
Deprecated.

Method Summary

void	deinstall(BasicEditorPane editor) Deprecated. 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 abstract oracle.ide.peek.Peek	getPeek(BasicEditorPane editor, int offset, java.awt.Rectangle rect) Deprecated. Get the Peek object if the installPeekableEditor(BasicEditorPane) is true, and getRectangleOffsets has returned a valid value.
protected abstract NumberRange	getRectangleOffsets(BasicEditorPane editor, int offset) Deprecated. Get the offsets in the code editor for which a rectangle needs to be shown, when a Ctrl is pressed during a mouse hover.
void	install(BasicEditorPane editor) Deprecated. Called when this plugin is being installed into the BasicEditorPane.
protected abstract boolean	installPeekableEditor(BasicEditorPane editor) Deprecated. Check whether the code peek functionality should be added to the given editor.
void	propertyChange(java.beans.PropertyChangeEvent evt) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEditorPeekPlugin

public AbstractEditorPeekPlugin()

Deprecated.

Method Detail

install

public void install(BasicEditorPane editor)

Deprecated.

Description copied from interface: EditorPlugin

Called when this plugin is being installed into the BasicEditorPane.

Specified by:

install in interface EditorPlugin

Parameters:

editor - the editor pane

deinstall

public void deinstall(BasicEditorPane editor)

Deprecated.

Description copied from interface: EditorPlugin

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 void propertyChange(java.beans.PropertyChangeEvent evt)

Deprecated.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

installPeekableEditor

protected abstract boolean installPeekableEditor(BasicEditorPane editor)

Deprecated.

Check whether the code peek functionality should be added to the given editor.

Parameters:

editor - The editor pane

Returns:

boolean True if a code peek functionality should be added to the given editor, false otherwise

getRectangleOffsets

protected abstract NumberRange getRectangleOffsets(BasicEditorPane editor,
                                                   int offset)

Deprecated.

Get the offsets in the code editor for which a rectangle needs to be shown, when a Ctrl is pressed during a mouse hover.

Parameters:

editor - The editor pane

offset - The cursor position

Returns:

NumberRange The offsets for which a rectangle needs to be shown. Null if offsets cannot be computed, or if rectangle and peek should not be shown

getPeek

protected abstract oracle.ide.peek.Peek getPeek(BasicEditorPane editor,
                                                int offset,
                                                java.awt.Rectangle rect)

Deprecated.

Get the Peek object if the installPeekableEditor(BasicEditorPane) is true, and getRectangleOffsets has returned a valid value.

Parameters:

editor - The editor pane

offset - The cursor position

rect - The rectangle representing the offset's area

Returns:

Peek The Peek object