oracle.javatools.editor.plugins

Class TrailingSpacePlugin

java.lang.Object

oracle.javatools.editor.plugins.TrailingSpacePlugin

All Implemented Interfaces:

java.awt.event.HierarchyListener, java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.event.ChangeListener, EditorPlugin

public class TrailingSpacePlugin
extends java.lang.Object
implements EditorPlugin, javax.swing.event.ChangeListener, java.awt.event.HierarchyListener

The TrailingSpacePlugin is an for an EditorPlugin implementation which provides support for performing some action when the user clicks over certain text in an editor, usually with a modifier key held down. It also supports displaying some hint text in the status bar, when the user hovers (moves the mouse) over that text with modifier key held down, and underlines it for additional feedback.

Constructor Summary

Constructors

Constructor and Description
TrailingSpacePlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateTrailingColumns(int viewportWidth) Fetch the number of trailing columns that should be used for the given viewport width.
protected int	calculateTrailingRows(int viewportHeight) Fetch the number of trailing rows that should be used for the given viewport height.
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 BasicEditorPane	getEditorPane() Fetch the BasicEditorPane associated with this plugin, or null if this plugin is not currently installed.
void	hierarchyChanged(java.awt.event.HierarchyEvent event) Called when the hierarchy has been changed.
void	install(BasicEditorPane editor) Called when this plugin is being installed into the BasicEditorPane.
void	propertyChange(java.beans.PropertyChangeEvent event) This method gets called when a bound property is changed.
void	stateChanged(javax.swing.event.ChangeEvent event) Invoked when the target of the listener has changed its state.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrailingSpacePlugin

public TrailingSpacePlugin()

Method Detail

install

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

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent event)

Invoked when the target of the listener has changed its state.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

Parameters:

event - the change event

hierarchyChanged

public void hierarchyChanged(java.awt.event.HierarchyEvent event)

Called when the hierarchy has been changed. To discern the actual type of change, call HierarchyEvent.getChangeFlags().

Specified by:

hierarchyChanged in interface java.awt.event.HierarchyListener

getEditorPane

protected BasicEditorPane getEditorPane()

Fetch the BasicEditorPane associated with this plugin, or null if this plugin is not currently installed.

Returns:

the associated editor pane (if any)

calculateTrailingRows

protected int calculateTrailingRows(int viewportHeight)

Fetch the number of trailing rows that should be used for the given viewport height.

Parameters:

viewportHeight - the height of the viewport area

Returns:

the number of trailing rows to use

calculateTrailingColumns

protected int calculateTrailingColumns(int viewportWidth)

Fetch the number of trailing columns that should be used for the given viewport width.

Parameters:

viewportWidth - the width of the viewport area

Returns:

the number of trailing columns to use