Package com.intellij.openapi.editor.impl

Class MarkupModelImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.editor.impl.MarkupModelImpl

All Implemented Interfaces:

MarkupModelEx, MarkupModel, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

EditorMarkupModelImpl

public class MarkupModelImpl
extends UserDataHolderBase
implements MarkupModelEx

Method Summary

Modifier and Type	Method and Description
RangeHighlighter	addLineHighlighter(int lineNumber, int layer, TextAttributes textAttributes) Adds a highlighter covering the specified line in the document.
void	addMarkupModelListener(Disposable parentDisposable, MarkupModelListener listener)
RangeHighlighterEx	addPersistentLineHighlighter(int lineNumber, int layer, TextAttributes textAttributes)
RangeHighlighter	addRangeHighlighter(int startOffset, int endOffset, int layer, TextAttributes textAttributes, HighlighterTargetArea targetArea) Adds a highlighter covering the specified range of the document, which can modify the attributes used for text rendering, add a gutter marker and so on.
void	addRangeHighlighter(RangeHighlighterEx marker, int start, int end, boolean greedyToLeft, boolean greedyToRight, int layer)
RangeHighlighterEx	addRangeHighlighterAndChangeAttributes(int startOffset, int endOffset, int layer, TextAttributes textAttributes, HighlighterTargetArea targetArea, boolean isPersistent, Consumer<? super RangeHighlighterEx> changeAttributesAction)
void	changeAttributesInBatch(RangeHighlighterEx highlighter, Consumer<? super RangeHighlighterEx> changeAttributesAction)
boolean	containsHighlighter(RangeHighlighter highlighter)
void	dispose()
void	fireAfterAdded(RangeHighlighterEx segmentHighlighter)
void	fireAttributesChanged(RangeHighlighterEx segmentHighlighter, boolean renderersChanged, boolean fontStyleOrColorChanged)
void	fireBeforeRemoved(RangeHighlighterEx segmentHighlighter)
RangeHighlighter []	getAllHighlighters() Returns all highlighter instances contained in the model.
Document	getDocument() Returns the document to which the markup model is attached.
MarkupIterator<RangeHighlighterEx>	overlappingIterator(int startOffset, int endOffset)
MarkupIterator<RangeHighlighterEx>	overlappingIterator(int startOffset, int endOffset, boolean onlyRenderedInGutter, boolean onlyRenderedInScrollBar)
boolean	processRangeHighlightersOutside(int start, int end, Processor<? super RangeHighlighterEx> processor)
boolean	processRangeHighlightersOverlappingWith(int start, int end, Processor<? super RangeHighlighterEx> processor)
void	removeAllHighlighters() Removes all highlighter instances.
void	removeHighlighter(RangeHighlighter segmentHighlighter) Removes the specified highlighter instance.
static TextRangeInterval	roundToLineBoundaries(Document document, int startOffset, int endOffset)
void	setRangeHighlighterAttributes(RangeHighlighter highlighter, TextAttributes textAttributes)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface MarkupModelEx

addLineHighlighter

public RangeHighlighter addLineHighlighter(int lineNumber,
                                           int layer,
                                           TextAttributes textAttributes)

Description copied from interface: MarkupModel

Adds a highlighter covering the specified line in the document.

Specified by:

addLineHighlighter in interface MarkupModel

Parameters:

lineNumber - the line number of the line to highlight.

layer - relative priority of the highlighter (highlighters with higher layer number override highlighters with lower layer number; layer number values for standard IDE highlighters are defined in HighlighterLayer)

textAttributes - the attributes to use for highlighting, or null if the highlighter does not modify the text attributes.

Returns:

the highlighter instance.

addPersistentLineHighlighter

public RangeHighlighterEx addPersistentLineHighlighter(int lineNumber,
                                                       int layer,
                                                       TextAttributes textAttributes)

Specified by:

addPersistentLineHighlighter in interface MarkupModelEx

getAllHighlighters

public RangeHighlighter [] getAllHighlighters()

Description copied from interface: MarkupModel

Returns all highlighter instances contained in the model.

Specified by:

getAllHighlighters in interface MarkupModel

Returns:

the array of highlighter instances.

addRangeHighlighterAndChangeAttributes

public RangeHighlighterEx addRangeHighlighterAndChangeAttributes(int startOffset,
                                                                 int endOffset,
                                                                 int layer,
                                                                 TextAttributes textAttributes,
                                                                 HighlighterTargetArea targetArea,
                                                                 boolean isPersistent,
                                                                 Consumer<? super RangeHighlighterEx> changeAttributesAction)

Specified by:

addRangeHighlighterAndChangeAttributes in interface MarkupModelEx

changeAttributesInBatch

public void changeAttributesInBatch(RangeHighlighterEx highlighter,
                                    Consumer<? super RangeHighlighterEx> changeAttributesAction)

Specified by:

changeAttributesInBatch in interface MarkupModelEx

addRangeHighlighter

public void addRangeHighlighter(RangeHighlighterEx marker,
                                int start,
                                int end,
                                boolean greedyToLeft,
                                boolean greedyToRight,
                                int layer)

Specified by:

addRangeHighlighter in interface MarkupModelEx

addRangeHighlighter

public RangeHighlighter addRangeHighlighter(int startOffset,
                                            int endOffset,
                                            int layer,
                                            TextAttributes textAttributes,
                                            HighlighterTargetArea targetArea)

Description copied from interface: MarkupModel

Adds a highlighter covering the specified range of the document, which can modify the attributes used for text rendering, add a gutter marker and so on. Range highlighters are RangeMarker instances and use the same rules for tracking the range after document changes.

Specified by:

addRangeHighlighter in interface MarkupModel

Parameters:

startOffset - the start offset of the range to highlight.

endOffset - the end offset of the range to highlight.

layer - relative priority of the highlighter (highlighters with higher layer number override highlighters with lower layer number; layer number values for standard IDE highlighters are defined in HighlighterLayer)

textAttributes - the attributes to use for highlighting, or null if the highlighter does not modify the text attributes.

targetArea - type of highlighting (specific range or all full lines covered by the range).

Returns:

the highlighter instance.

removeHighlighter

public void removeHighlighter(RangeHighlighter segmentHighlighter)

Description copied from interface: MarkupModel

Removes the specified highlighter instance.

Specified by:

removeHighlighter in interface MarkupModel

Parameters:

segmentHighlighter - the highlighter to remove.

removeAllHighlighters

public void removeAllHighlighters()

Description copied from interface: MarkupModel

Removes all highlighter instances.

Specified by:

removeAllHighlighters in interface MarkupModel

getDocument

public Document getDocument()

Description copied from interface: MarkupModel

Returns the document to which the markup model is attached.

Specified by:

getDocument in interface MarkupModel

Returns:

the document instance.

addMarkupModelListener

public void addMarkupModelListener(Disposable parentDisposable,
                                   MarkupModelListener listener)

Specified by:

addMarkupModelListener in interface MarkupModelEx

setRangeHighlighterAttributes

public void setRangeHighlighterAttributes(RangeHighlighter highlighter,
                                          TextAttributes textAttributes)

Specified by:

setRangeHighlighterAttributes in interface MarkupModelEx

fireAttributesChanged

public void fireAttributesChanged(RangeHighlighterEx segmentHighlighter,
                                  boolean renderersChanged,
                                  boolean fontStyleOrColorChanged)

Specified by:

fireAttributesChanged in interface MarkupModelEx

fireAfterAdded

public void fireAfterAdded(RangeHighlighterEx segmentHighlighter)

Specified by:

fireAfterAdded in interface MarkupModelEx

fireBeforeRemoved

public void fireBeforeRemoved(RangeHighlighterEx segmentHighlighter)

Specified by:

fireBeforeRemoved in interface MarkupModelEx

containsHighlighter

public boolean containsHighlighter(RangeHighlighter highlighter)

Specified by:

containsHighlighter in interface MarkupModelEx

processRangeHighlightersOverlappingWith

public boolean processRangeHighlightersOverlappingWith(int start,
                                                       int end,
                                                       Processor<? super RangeHighlighterEx> processor)

Specified by:

processRangeHighlightersOverlappingWith in interface MarkupModelEx

processRangeHighlightersOutside

public boolean processRangeHighlightersOutside(int start,
                                               int end,
                                               Processor<? super RangeHighlighterEx> processor)

Specified by:

processRangeHighlightersOutside in interface MarkupModelEx

overlappingIterator

public MarkupIterator<RangeHighlighterEx> overlappingIterator(int startOffset,
                                                              int endOffset)

Specified by:

overlappingIterator in interface MarkupModelEx

overlappingIterator

public MarkupIterator<RangeHighlighterEx> overlappingIterator(int startOffset,
                                                              int endOffset,
                                                              boolean onlyRenderedInGutter,
                                                              boolean onlyRenderedInScrollBar)

Specified by:

overlappingIterator in interface MarkupModelEx

roundToLineBoundaries

public static TextRangeInterval roundToLineBoundaries(Document document,
                                                      int startOffset,
                                                      int endOffset)