oracle.javatools.editor

Interface EditorSelection

All Known Implementing Classes:

EditorSelectionColumns, EditorSelectionWrap

public interface EditorSelection

An EditorSelection is a mechanism to determine the selection behaviour of an BasicEditorPane. This means determining the state of the selection (i.e. from where to where), What test is actually selected, and the shape of the selection. EditorSelections would also usually implement custom cut, copy, paste, delete, etc actions when triggered on the editor.

Method Summary

Modifier and Type	Method and Description
boolean	canSupportEditor(BasicEditorPane editorPane) Indicates whether the EditorSelection can support its selection type on te given editor pane
void	clearSelectionHighlights(HighlightLayer selectionLayer) Clear the selection by removing any selection highlighting and permorming any other internal clear operations.
void	deinstall() Disassociate the editor selection from an editor
void	deleteSelection() Remove the currently selected text (if any) from the document
default Selection	determineMoveDot(int dot, int mark) The caret has been asked to move the dot to the given location.
default int	determineSetDot(int dot) The caret has been asked to set the dot to the given location.
void	duplicate() Duplicate the current selection.
int	getDot()
int	getMark()
java.lang.String	getSelectedText()
void	insertText(int offset, java.lang.String text) Insert the given text at the given offset (Different selections will handle things like newline characters differently).
void	install(BasicEditorPane editor) Associate the editor selection with an editor
boolean	isInSelection(int offset) Returns whether the given offset lies within the current selection bounds
void	mouseDragged(java.awt.Point point, int offset) The mouse was dragged to the given point and offset
void	selectAll() Selects all characters in the document
void	setDotPoint(java.awt.Point p) Let the selection know the point (in editor coordinates) where the selection end is designated.
void	setMarkPoint(java.awt.Point p) Let the selection know the point (in editor coordinates) where the selection start is designated.
void	updateSelectionHighlight(HighlightLayer layer, HighlightStyle caretStyle) Update the Editors selection highlight layer in response to a possible change in selection

Method Detail

getMark

int getMark()

Returns:

The offset of selection start (the mark)

getDot

int getDot()

Returns:

The offset of selection end. May be identical to selection start which may indicate no selection.

getSelectedText

java.lang.String getSelectedText()

Returns:

The text currently covered by selection

updateSelectionHighlight

void updateSelectionHighlight(HighlightLayer layer,
                              HighlightStyle caretStyle)

Update the Editors selection highlight layer in response to a possible change in selection

Parameters:

layer - The selection highlight layer

caretStyle -

install

void install(BasicEditorPane editor)

Associate the editor selection with an editor

Parameters:

editor -

deinstall

void deinstall()

Disassociate the editor selection from an editor

setMarkPoint

void setMarkPoint(java.awt.Point p)

Let the selection know the point (in editor coordinates) where the selection start is designated. We can't just rely on editor.getCaret() as this will return an offset, sometimes the selection start point will be past the end of the row and not specifically identified by an offset

Parameters:

p - the Point where the selection begin

setDotPoint

void setDotPoint(java.awt.Point p)

Let the selection know the point (in editor coordinates) where the selection end is designated. We can't just rely on editor.getCaret() as this will return an offset, sometimes the selection end point will be past the end of the row and not specifically identified by an offset

Parameters:

p - the Point where the selection bounds ends

clearSelectionHighlights

void clearSelectionHighlights(HighlightLayer selectionLayer)

Clear the selection by removing any selection highlighting and permorming any other internal clear operations.

Parameters:

selectionLayer -

deleteSelection

void deleteSelection()
              throws javax.swing.text.BadLocationException

Remove the currently selected text (if any) from the document

Throws:

javax.swing.text.BadLocationException

insertText

void insertText(int offset,
                java.lang.String text)
         throws javax.swing.text.BadLocationException

Insert the given text at the given offset (Different selections will handle things like newline characters differently).

Parameters:

offset -

text -

Throws:

javax.swing.text.BadLocationException

isInSelection

boolean isInSelection(int offset)

Returns whether the given offset lies within the current selection bounds

Parameters:

offset -

Returns:

selectAll

void selectAll()

Selects all characters in the document

duplicate

void duplicate()

Duplicate the current selection.

canSupportEditor

boolean canSupportEditor(BasicEditorPane editorPane)

Indicates whether the EditorSelection can support its selection type on te given editor pane

Parameters:

editorPane -

Returns:

true if the selection is suitable for the given editor

determineSetDot

default int determineSetDot(int dot)

The caret has been asked to set the dot to the given location. The selection can modify this location if it wishes. The return value is the location the selection determines the dot should be placed at. The caret may then continue to set the dot in that location.

Parameters:

dot - location dot is requesting to be placed at

Returns:

the location the selection determines the dot should be placed at.

determineMoveDot

default Selection determineMoveDot(int dot,
                                   int mark)

The caret has been asked to move the dot to the given location. The selection can modify this location if it wishes. The return value is the location the selection determines the dot should be placed at. The caret may then continue to move the dot in that location.

Parameters:

dot - location dot is requesting to be moved to

Returns:

the location the selection determines the dot should be placed at.

mouseDragged

void mouseDragged(java.awt.Point point,
                  int offset)

The mouse was dragged to the given point and offset

Parameters:

point - the point of the drag

offset -