SelectionModel (Unofficial IntelliJ Community Edition API docs)

All Known Implementing Classes:

SelectionModelImpl
```
public interface SelectionModel
```
Provides services for selecting text in the IDE's text editor and retrieving information about the selection. Most of the methods here exist for compatibility reasons, corresponding functionality is also provided by CaretModel now.
In editors supporting multiple carets, each caret has its own associated selection range. Unless mentioned explicitly, methods of this interface operate on the current caret (see CaretModel.runForEachCaret(CaretAction)), or 'primary' caret if current caret is not defined.

See Also:

Editor.getSelectionModel(), CaretModel

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addSelectionListener(SelectionListener listener)` Adds a listener for receiving information about selection changes.
`default void`	`addSelectionListener(SelectionListener listener, Disposable parentDisposable)` Adds a listener for receiving information about selection changes, which is removed when the given disposable is disposed.
`void`	`copySelectionToClipboard()` Copies the currently selected text to the clipboard.
`int []`	`getBlockSelectionEnds()` Returns an array of end offsets in the document for ranges selected in the document currently.
`int []`	`getBlockSelectionStarts()` Returns an array of start offsets in the document for ranges selected in the document currently.
`Editor`	`getEditor()`
`default int`	`getLeadSelectionOffset()` Returns the offset from which the user started to extend the selection (the selection start if the selection was extended in forward direction, or the selection end if it was extended backward).
`default VisualPosition`	`getLeadSelectionPosition()`
`default java.lang.String`	`getSelectedText()` Returns the text selected in the editor.
`default java.lang.String`	`getSelectedText(boolean allCarets)` If `allCarets` is `true`, returns the concatenation of selections for all carets, or `null` if there are no selections.
`default int`	`getSelectionEnd()` Returns the end offset in the document of the selected text range, or the caret position if there is currently no selection.
`default VisualPosition`	`getSelectionEndPosition()`
`default int`	`getSelectionStart()` Returns the start offset in the document of the selected text range, or the caret position if there is currently no selection.
`default VisualPosition`	`getSelectionStartPosition()`
`TextAttributes`	`getTextAttributes()` Returns visual representation of selection.
`default boolean`	`hasSelection()` Checks if a range of text is currently selected.
`default boolean`	`hasSelection(boolean anyCaret)` Checks if a range of text is currently selected.
`default void`	`removeSelection()` Removes the selection in the editor.
`default void`	`removeSelection(boolean allCarets)` Removes the selection in the editor.
`void`	`removeSelectionListener(SelectionListener listener)` Removes a listener for receiving information about selection changes.
`default void`	`selectLineAtCaret()` Selects the entire line of text at the caret position.
`default void`	`selectWordAtCaret(boolean honorCamelWordsSettings)` Selects the entire word at the caret position, optionally using camel-case rules to determine word boundaries.
`void`	`setBlockSelection(LogicalPosition blockStart, LogicalPosition blockEnd)` Creates a multi-caret selection for the rectangular block of text with specified start and end positions.
`default void`	`setSelection(int startOffset, int endOffset)` Selects the specified range of text.
`default void`	`setSelection(int startOffset, VisualPosition endPosition, int endOffset)` Selects target range providing information about visual boundary of selection end.
`default void`	`setSelection(VisualPosition startPosition, int startOffset, VisualPosition endPosition, int endOffset)` Selects target range based on its visual boundaries.

- Method Detail
  - getEditor
```
Editor getEditor()
```
    Returns:
    
    the editor this selection model belongs to
  - getSelectionStart
```
default int getSelectionStart()
```
    Returns the start offset in the document of the selected text range, or the caret position if there is currently no selection.
    
    Returns:
    
    the selection start offset.
  - getSelectionStartPosition
```
default VisualPosition getSelectionStartPosition()
```
    Returns:
    
    object that encapsulates information about visual position of selected text start if any
  - getSelectionEnd
```
default int getSelectionEnd()
```
    Returns the end offset in the document of the selected text range, or the caret position if there is currently no selection.
    
    Returns:
    
    the selection end offset.
  - getSelectionEndPosition
```
default VisualPosition getSelectionEndPosition()
```
    Returns:
    
    object that encapsulates information about visual position of selected text end if any;
  - getSelectedText
```
default java.lang.String getSelectedText()
```
    Returns the text selected in the editor.
    
    Returns:
    
    the selected text, or null if there is currently no selection.
  - getSelectedText
```
default java.lang.String getSelectedText(boolean allCarets)
```
    If allCarets is true, returns the concatenation of selections for all carets, or null if there are no selections. If allCarets is false, works just like getSelectedText().
  - getLeadSelectionOffset
```
default int getLeadSelectionOffset()
```
    Returns the offset from which the user started to extend the selection (the selection start if the selection was extended in forward direction, or the selection end if it was extended backward).
    
    Returns:
    
    the offset from which the selection was started, or the caret offset if there is currently no selection.
  - getLeadSelectionPosition
```
default VisualPosition getLeadSelectionPosition()
```
    Returns:
    
    object that encapsulates information about visual position from which the user started to extend the selection if any
  - hasSelection
```
default boolean hasSelection()
```
    Checks if a range of text is currently selected.
    
    Returns:
    
    true if a range of text is selected, false otherwise.
  - hasSelection
```
default boolean hasSelection(boolean anyCaret)
```
    Checks if a range of text is currently selected. If anyCaret is true, check all existing carets in the document, and returns true if any of them has selection, otherwise checks only the current caret.
    
    Returns:
    
    true if a range of text is selected, false otherwise.
  - setSelection
```
default void setSelection(int startOffset,
                          int endOffset)
```
    Selects the specified range of text.
    
    Parameters:
    
    startOffset - the start offset of the text range to select.
    
    endOffset - the end offset of the text range to select.
  - setSelection
```
default void setSelection(int startOffset,
                          VisualPosition endPosition,
                          int endOffset)
```
    Selects target range providing information about visual boundary of selection end.
    That is the case for soft wraps-aware processing where the whole soft wraps virtual space is matched to the same offset.
    
    Parameters:
    
    startOffset - start selection offset
    
    endPosition - end visual position of the text range to select (null argument means that no specific visual position should be used)
    
    endOffset - end selection offset
  - setSelection
```
default void setSelection(VisualPosition startPosition,
                          int startOffset,
                          VisualPosition endPosition,
                          int endOffset)
```
    Selects target range based on its visual boundaries.
    That is the case for soft wraps-aware processing where the whole soft wraps virtual space is matched to the same offset.
    
    Parameters:
    
    startPosition - start visual position of the text range to select (null argument means that no specific visual position should be used)
    
    endPosition - end visual position of the text range to select (null argument means that no specific visual position should be used)
    
    startOffset - start selection offset
    
    endOffset - end selection offset
  - removeSelection
```
default void removeSelection()
```
    Removes the selection in the editor.
  - removeSelection
```
default void removeSelection(boolean allCarets)
```
    Removes the selection in the editor. If allCarets is true, removes selections from all carets in the editor, otherwise, does this just for the current caret.
  - addSelectionListener
```
void addSelectionListener(SelectionListener listener)
```
    Adds a listener for receiving information about selection changes.
    
    Parameters:
    
    listener - the listener instance.
  - addSelectionListener
```
default void addSelectionListener(SelectionListener listener,
                                  Disposable parentDisposable)
```
    Adds a listener for receiving information about selection changes, which is removed when the given disposable is disposed.
    
    Parameters:
    
    listener - the listener instance.
  - removeSelectionListener
```
void removeSelectionListener(SelectionListener listener)
```
    Removes a listener for receiving information about selection changes.
    
    Parameters:
    
    listener - the listener instance.
  - selectLineAtCaret
```
default void selectLineAtCaret()
```
    Selects the entire line of text at the caret position.
  - selectWordAtCaret
```
default void selectWordAtCaret(boolean honorCamelWordsSettings)
```
    Selects the entire word at the caret position, optionally using camel-case rules to determine word boundaries.
    
    Parameters:
    
    honorCamelWordsSettings - if true and "Use CamelHumps words" is enabled, upper-case letters within the word are considered as boundaries for the range of text to select.
  - copySelectionToClipboard
```
void copySelectionToClipboard()
```
    Copies the currently selected text to the clipboard. When multiple selections exist in the document, all of them are copied, as a single piece of text.
  - setBlockSelection
```
void setBlockSelection(LogicalPosition blockStart,
                       LogicalPosition blockEnd)
```
    Creates a multi-caret selection for the rectangular block of text with specified start and end positions.
    
    Parameters:
    
    blockStart - the start of the rectangle to select.
    
    blockEnd - the end of the rectangle to select.
    
    See Also:
    
    setSelection(int, int)
  - getBlockSelectionStarts
```
int [] getBlockSelectionStarts()
```
    Returns an array of start offsets in the document for ranges selected in the document currently. Works both for a single-caret and a multiple-caret selection (for carets not having a selection, caret position is returned).
    
    Returns:
    
    an array of start offsets, array size is equal to the number of carets existing in the editor currently.
  - getBlockSelectionEnds
```
int [] getBlockSelectionEnds()
```
    Returns an array of end offsets in the document for ranges selected in the document currently. Works both for a single-caret and a multiple-caret selection (for carets not having a selection, caret position is returned).
    
    Returns:
    
    an array of start offsets, array size is equal to the number of carets existing in the editor currently.
  - getTextAttributes
```
TextAttributes getTextAttributes()
```
    Returns visual representation of selection.
    
    Returns:
    
    Selection attributes.

Interface SelectionModel

Method Summary

Method Detail

getEditor

getSelectionStart

getSelectionStartPosition

getSelectionEnd

getSelectionEndPosition

getSelectedText

getSelectedText

getLeadSelectionOffset

getLeadSelectionPosition

hasSelection

hasSelection

setSelection

setSelection

setSelection

removeSelection

removeSelection

addSelectionListener

addSelectionListener

removeSelectionListener

selectLineAtCaret

selectWordAtCaret

copySelectionToClipboard

setBlockSelection

getBlockSelectionStarts

getBlockSelectionEnds

getTextAttributes