oracle.ide.ceditor

Class SelectionSurroundPlugin

java.lang.Object

oracle.ide.ceditor.SelectionSurroundPlugin

All Implemented Interfaces:

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

public class SelectionSurroundPlugin
extends java.lang.Object
implements EditorPlugin

Plugin to listen for defined key presses when there is a selection in the editor. The selection may then be surrounded. e.g. Pressing the quote key with some text selected will add matching quotes to the start and end of the selection.

Constructor Summary

Constructors

Constructor and Description
SelectionSurroundPlugin()

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.
protected char[][]	getSurrounds() Return an array of char pairs.
void	install(BasicEditorPane editor) Called when this plugin is being installed into the BasicEditorPane.
void	propertyChange(java.beans.PropertyChangeEvent evt)

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionSurroundPlugin

public SelectionSurroundPlugin()

Method Detail

install

public void install(BasicEditorPane editor)

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)

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)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

getSurrounds

protected char[][] getSurrounds()

Return an array of char pairs. The first char of each pair is the activation key for that surround and will also be placed at the start of selection. The second char of each pair will be placed at the end of the selection.

Returns:

surrounds