Package com.intellij.openapi.editor.impl

Class CaretModelImpl

java.lang.Object

com.intellij.openapi.editor.impl.CaretModelImpl

All Implemented Interfaces:

Dumpable, Disposable, CaretModel, DocumentListener, PrioritizedDocumentListener, InlayModel.Listener, java.util.EventListener

public class CaretModelImpl
extends java.lang.Object
implements CaretModel, PrioritizedDocumentListener, Disposable, Dumpable, InlayModel.Listener

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.openapi.editor.ex.PrioritizedDocumentListener

COMPARATOR

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CaretModelImpl(EditorImpl editor)

Method Summary

Modifier and Type	Method and Description
Caret	addCaret(LogicalPosition pos, boolean makePrimary) Adds a new caret at the given position, and returns corresponding Caret instance.
Caret	addCaret(VisualPosition pos, boolean makePrimary) Adds a new caret at the given position, and returns corresponding Caret instance.
void	addCaretActionListener(CaretActionListener listener, Disposable disposable) Adds a listener which will be notified before and after all-caret operations are performed by CaretModel.runForEachCaret(CaretAction) and CaretModel.runForEachCaret(CaretAction, boolean).
void	addCaretListener(CaretListener listener) Adds a listener for receiving notifications about caret movement and caret addition/removal
void	beforeDocumentChange(DocumentEvent e) Called before the text of the document is changed.
void	dispose() Usually not invoked directly, see class javadoc.
void	documentChanged(DocumentEvent e) Called after the text of the document has been changed.
java.lang.String	dumpState()
java.util.List<Caret>	getAllCarets() Returns all carets currently existing in the document, ordered by their visual position in editor.
Caret	getCaretAt(VisualPosition pos) Returns a caret at the given position in the document, or null, if there's no caret there.
int	getCaretCount() Returns number of carets currently existing in the document
java.util.List<CaretState>	getCaretsAndSelections() Returns the current positions of all carets and their selections.
CaretImpl	getCurrentCaret() Returns current caret - the one, query and update methods in the model operate at the moment.
CaretImpl	getPrimaryCaret() Returns the 'primary' caret.
int	getPriority()
TextAttributes	getTextAttributes() Returns visual representation of caret (e.g.
boolean	isIteratingOverCarets()
void	onAdded(Inlay inlay)
void	onBatchModeFinish(Editor editor)
void	onRemoved(Inlay inlay)
void	onUpdated(Inlay inlay, int changeFlags)
void	reinitSettings()
boolean	removeCaret(Caret caret) Removes a given caret if it's recognized by the model and is not the only existing caret in the document, returning true.
void	removeCaretListener(CaretListener listener) Removes a listener for receiving notifications about caret movement and caret addition/removal
void	removeSecondaryCarets() Removes all carets except the 'primary' one from the document.
void	runBatchCaretOperation(java.lang.Runnable runnable) Executes the given task, performing caret merging afterwards.
void	runForEachCaret(CaretAction action) Same as CaretModel.runForEachCaret(CaretAction, boolean) with reverseOrder set to false
void	runForEachCaret(CaretAction action, boolean reverseOrder) Executes the given task for each existing caret.
void	setCaretsAndSelections(java.util.List<? extends CaretState> caretStates) Sets the number of carets, their positions and selection ranges according to the provided data.
void	setCaretsAndSelections(java.util.List<? extends CaretState> caretStates, boolean updateSystemSelection) Sets the number of carets, their positions and selection ranges according to the provided data.
boolean	supportsMultipleCarets() Tells whether multiple coexisting carets are supported by this CaretModel instance.
void	updateVisualPosition()
void	validateState()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.CaretModel

addCaret, addCaretListener, getLogicalPosition, getOffset, getVisualLineEnd, getVisualLineStart, getVisualPosition, isUpToDate, moveCaretRelatively, moveToLogicalPosition, moveToOffset, moveToOffset, moveToVisualPosition

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

bulkUpdateFinished, bulkUpdateStarting

Methods inherited from interface com.intellij.openapi.editor.InlayModel.Listener

onBatchModeStart, onUpdated

Constructor Detail

CaretModelImpl

public CaretModelImpl(EditorImpl editor)

Method Detail

documentChanged

public void documentChanged(DocumentEvent e)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

e - the event containing the information about the change.

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent e)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

e - the event containing the information about the change.

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedDocumentListener

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

updateVisualPosition

public void updateVisualPosition()

addCaretListener

public void addCaretListener(CaretListener listener)

Description copied from interface: CaretModel

Adds a listener for receiving notifications about caret movement and caret addition/removal

Specified by:

addCaretListener in interface CaretModel

Parameters:

listener - the listener instance.

removeCaretListener

public void removeCaretListener(CaretListener listener)

Description copied from interface: CaretModel

Removes a listener for receiving notifications about caret movement and caret addition/removal

Specified by:

removeCaretListener in interface CaretModel

Parameters:

listener - the listener instance.

getTextAttributes

public TextAttributes getTextAttributes()

Description copied from interface: CaretModel

Returns visual representation of caret (e.g. background color).

Specified by:

getTextAttributes in interface CaretModel

Returns:

Caret attributes.

reinitSettings

public void reinitSettings()

supportsMultipleCarets

public boolean supportsMultipleCarets()

Description copied from interface: CaretModel

Tells whether multiple coexisting carets are supported by this CaretModel instance. Multiple carets are not supported when the corresponding Editor instance is a facade over a Swing JTextArea component.

Specified by:

supportsMultipleCarets in interface CaretModel

getCurrentCaret

public CaretImpl getCurrentCaret()

Description copied from interface: CaretModel

Returns current caret - the one, query and update methods in the model operate at the moment. In the current implementation this is either an iteration-current caret within the context of CaretModel.runForEachCaret(CaretAction) method, or the 'primary' caret without that context. Users CaretModel.runForEachCaret(CaretAction) method should use caret parameter passed to CaretAction.perform(Caret) method instead of this method, as the definition of current caret (as well as caret instance operated on by model methods) can potentially change.

Specified by:

getCurrentCaret in interface CaretModel

getPrimaryCaret

public CaretImpl getPrimaryCaret()

Description copied from interface: CaretModel

Returns the 'primary' caret.

Specified by:

getPrimaryCaret in interface CaretModel

getCaretCount

public int getCaretCount()

Description copied from interface: CaretModel

Returns number of carets currently existing in the document

Specified by:

getCaretCount in interface CaretModel

getAllCarets

public java.util.List<Caret> getAllCarets()

Description copied from interface: CaretModel

Returns all carets currently existing in the document, ordered by their visual position in editor.

Specified by:

getAllCarets in interface CaretModel

getCaretAt

public Caret getCaretAt(VisualPosition pos)

Description copied from interface: CaretModel

Returns a caret at the given position in the document, or null, if there's no caret there.

Specified by:

getCaretAt in interface CaretModel

addCaret

public Caret addCaret(VisualPosition pos,
                      boolean makePrimary)

Description copied from interface: CaretModel

Adds a new caret at the given position, and returns corresponding Caret instance. Locations outside of possible values for the given document are trimmed automatically. Newly added caret will become a primary caret if and only if makePrimary value is true. Does nothing if multiple carets are not supported, a caret already exists at specified location or selection of existing caret includes the specified location, null is returned in this case.

Specified by:

addCaret in interface CaretModel

addCaret

public Caret addCaret(LogicalPosition pos,
                      boolean makePrimary)

Description copied from interface: CaretModel

Adds a new caret at the given position, and returns corresponding Caret instance. Locations outside of possible values for the given document are trimmed automatically. Newly added caret will become a primary caret if and only if makePrimary value is true. Does nothing if multiple carets are not supported, a caret already exists at specified location or selection of existing caret includes the specified location, null is returned in this case.

Specified by:

addCaret in interface CaretModel

removeCaret

public boolean removeCaret(Caret caret)

Description copied from interface: CaretModel

Removes a given caret if it's recognized by the model and is not the only existing caret in the document, returning true. false is returned if any of the above condition doesn't hold, and the removal cannot happen.

Specified by:

removeCaret in interface CaretModel

removeSecondaryCarets

public void removeSecondaryCarets()

Description copied from interface: CaretModel

Removes all carets except the 'primary' one from the document.

Specified by:

removeSecondaryCarets in interface CaretModel

runForEachCaret

public void runForEachCaret(CaretAction action)

Description copied from interface: CaretModel

Same as CaretModel.runForEachCaret(CaretAction, boolean) with reverseOrder set to false

Specified by:

runForEachCaret in interface CaretModel

runForEachCaret

public void runForEachCaret(CaretAction action,
                            boolean reverseOrder)

Description copied from interface: CaretModel

Executes the given task for each existing caret. Set of carets to iterate over is determined in the beginning and is not affected by the potential carets addition or removal by the task being executed. At the end, merging of carets and selections is performed, so that no two carets will occur at the same logical position and no two selection will overlap after this method is finished.

Carets are iterated in position order (top-to-bottom) if reverseOrder is false, and in reverse order if it's true.

It's possible to call this method not from EDT (for read-only operations). Caret merging is not performed in this case, and no notifications to CaretActionListener-s are sent.

Specified by:

runForEachCaret in interface CaretModel

addCaretActionListener

public void addCaretActionListener(CaretActionListener listener,
                                   Disposable disposable)

Description copied from interface: CaretModel

Adds a listener which will be notified before and after all-caret operations are performed by CaretModel.runForEachCaret(CaretAction) and CaretModel.runForEachCaret(CaretAction, boolean). Listeners will be notified only if those methods are invoked from EDT (non-EDT invocations are not allowed to change caret state anyway).

Specified by:

addCaretActionListener in interface CaretModel

runBatchCaretOperation

public void runBatchCaretOperation(java.lang.Runnable runnable)

Description copied from interface: CaretModel

Executes the given task, performing caret merging afterwards. Caret merging will not happen until the operation is finished.

Specified by:

runBatchCaretOperation in interface CaretModel

setCaretsAndSelections

public void setCaretsAndSelections(java.util.List<? extends CaretState> caretStates)

Description copied from interface: CaretModel

Sets the number of carets, their positions and selection ranges according to the provided data. Null values for caret position or selection boundaries will mean that corresponding caret's position and/or selection won't be changed.

System selection will be updated, if such feature is supported by current editor.

Specified by:

setCaretsAndSelections in interface CaretModel

See Also:

CaretModel.supportsMultipleCarets(), CaretModel.getCaretsAndSelections(), CaretModel.setCaretsAndSelections(List, boolean)

setCaretsAndSelections

public void setCaretsAndSelections(java.util.List<? extends CaretState> caretStates,
                                   boolean updateSystemSelection)

Description copied from interface: CaretModel

Sets the number of carets, their positions and selection ranges according to the provided data. Null values for caret position or selection boundaries will mean that corresponding caret's position and/or selection won't be changed.

System selection will be updated, if such feature is supported by current editor and corresponding invocation parameter is set to true.

Specified by:

setCaretsAndSelections in interface CaretModel

See Also:

CaretModel.supportsMultipleCarets(), CaretModel.getCaretsAndSelections()

getCaretsAndSelections

public java.util.List<CaretState> getCaretsAndSelections()

Description copied from interface: CaretModel

Returns the current positions of all carets and their selections. The order of entries in the returned list does not necessarily correspond to the order of CaretModel.getAllCarets() method results. Passing the result of this method to CaretModel.setCaretsAndSelections(List) will restore the state of carets, including the internal caret order, in particular, the caret, that was primary when this method was called, will be the primary one after corresponding CaretModel.setCaretsAndSelections(List) invocation.

Specified by:

getCaretsAndSelections in interface CaretModel

See Also:

CaretModel.setCaretsAndSelections(List)

isIteratingOverCarets

public boolean isIteratingOverCarets()

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable

onAdded

public void onAdded(Inlay inlay)

Specified by:

onAdded in interface InlayModel.Listener

onRemoved

public void onRemoved(Inlay inlay)

Specified by:

onRemoved in interface InlayModel.Listener

onUpdated

public void onUpdated(Inlay inlay,
                      int changeFlags)

Specified by:

onUpdated in interface InlayModel.Listener

changeFlags - see InlayModel.ChangeFlags

onBatchModeFinish

public void onBatchModeFinish(Editor editor)

Specified by:

onBatchModeFinish in interface InlayModel.Listener

See Also:

InlayModel.execute(boolean, Runnable)

validateState

public void validateState()