Package com.intellij.codeInsight.highlighting

Class HighlightManagerImpl

java.lang.Object

com.intellij.codeInsight.highlighting.HighlightManager

com.intellij.codeInsight.highlighting.HighlightManagerImpl

public final class HighlightManagerImpl
extends HighlightManager

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.codeInsight.highlighting.HighlightManager

HighlightManager.HideFlags

Field Summary

Fields inherited from class com.intellij.codeInsight.highlighting.HighlightManager

HIDE_BY_ANY_KEY, HIDE_BY_ESCAPE, HIDE_BY_TEXT_CHANGE

Constructor Summary

Constructors

Constructor and Description
HighlightManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	addOccurrenceHighlight(Editor editor, int start, int end, TextAttributes attributes, int flags, java.util.Collection<? super RangeHighlighter> outHighlighters, java.awt.Color scrollMarkColor) Highlights a specified range of text in an editor and optionally adds a mark on the gutter.
void	addOccurrenceHighlights(Editor editor, PsiElement [] elements, TextAttributes attributes, boolean hideByTextChange, java.util.Collection<? super RangeHighlighter> outHighlighters) Highlights the text ranges of the specified elements in the specified editor.
void	addOccurrenceHighlights(Editor editor, PsiReference [] occurrences, TextAttributes attributes, boolean hideByTextChange, java.util.Collection<? super RangeHighlighter> outHighlighters) Highlights the text ranges of the specified references in the specified editor.
void	addRangeHighlight(Editor editor, int startOffset, int endOffset, TextAttributes attributes, boolean hideByTextChange, boolean hideByAnyKey, java.util.Collection<? super RangeHighlighter> highlighters) Highlights a specified range of text in an editor.
void	addRangeHighlight(Editor editor, int startOffset, int endOffset, TextAttributes attributes, boolean hideByTextChange, java.util.Collection<? super RangeHighlighter> highlighters) Highlights a specified range of text in an editor.
RangeHighlighter []	getHighlighters(Editor editor)
boolean	hideHighlights(Editor editor, int mask)
boolean	removeSegmentHighlighter(Editor editor, RangeHighlighter highlighter) Removes a range highlighter added by HighlightManager.addRangeHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, boolean, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>) or another method in this class.

Methods inherited from class com.intellij.codeInsight.highlighting.HighlightManager

getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightManagerImpl

public HighlightManagerImpl(Project project)

Method Detail

getHighlighters

public RangeHighlighter [] getHighlighters(Editor editor)

removeSegmentHighlighter

public boolean removeSegmentHighlighter(Editor editor,
                                        RangeHighlighter highlighter)

Description copied from class: HighlightManager

Removes a range highlighter added by HighlightManager.addRangeHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, boolean, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>) or another method in this class.

Specified by:

removeSegmentHighlighter in class HighlightManager

Parameters:

editor - the editor in which the highlighter should be removed.

highlighter - the highlighter to remove.

Returns:

true if the remove was successful, false if the highlighter was not found in the editor.

addOccurrenceHighlights

public void addOccurrenceHighlights(Editor editor,
                                    PsiReference [] occurrences,
                                    TextAttributes attributes,
                                    boolean hideByTextChange,
                                    java.util.Collection<? super RangeHighlighter> outHighlighters)

Description copied from class: HighlightManager

Highlights the text ranges of the specified references in the specified editor. The highlighting is removed when the user presses the Esc key, and optionally when the editor text is changed.

Specified by:

addOccurrenceHighlights in class HighlightManager

Parameters:

editor - the editor in which the highlighting is performed.

occurrences - the references to highlight.

attributes - the attributes to highlight the text with.

hideByTextChange - if true, the highlighting is removed automatically if the editor text is changed.

outHighlighters - if not null, the created RangeHighlighter objects are added to this collection.

addOccurrenceHighlight

public void addOccurrenceHighlight(Editor editor,
                                   int start,
                                   int end,
                                   TextAttributes attributes,
                                   int flags,
                                   java.util.Collection<? super RangeHighlighter> outHighlighters,
                                   java.awt.Color scrollMarkColor)

Description copied from class: HighlightManager

Highlights a specified range of text in an editor and optionally adds a mark on the gutter. The highlighting is optionally removed when the user presses the Esc key or any key, or when the editor text is changed. If the highlighter added by this method needs to be removed manually, HighlightManager.removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

Specified by:

addOccurrenceHighlight in class HighlightManager

Parameters:

editor - the editor in which the highlighting is performed.

start - the start offset of the text range to highlight.

end - the end offset of the text range to highlight.

attributes - the attributes to highlight the text with.

flags - the flags specifying when the highlighting is removed (a combination of HighlightManager.HIDE_BY_ESCAPE, HighlightManager.HIDE_BY_ANY_KEY and HighlightManager.HIDE_BY_TEXT_CHANGE).

outHighlighters - if not null, the created RangeHighlighter object is added to this collection.

scrollMarkColor - if not null, a gutter mark with the specified color is added in addition to the editor highlight.

addRangeHighlight

public void addRangeHighlight(Editor editor,
                              int startOffset,
                              int endOffset,
                              TextAttributes attributes,
                              boolean hideByTextChange,
                              java.util.Collection<? super RangeHighlighter> highlighters)

Description copied from class: HighlightManager

Highlights a specified range of text in an editor. The highlighting is removed when the user presses the Esc key, and optionally when the editor text is changed. If the highlighter added by this method needs to be removed manually, HighlightManager.removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

Specified by:

addRangeHighlight in class HighlightManager

Parameters:

editor - the editor in which the highlighting is performed.

startOffset - the start offset of the text range to highlight.

endOffset - the end offset of the text range to highlight.

attributes - the attributes to highlight the text with.

hideByTextChange - if true, the highlighting is removed automatically if the editor text is changed.

highlighters - if not null, the created RangeHighlighter object is added to this collection.

addRangeHighlight

public void addRangeHighlight(Editor editor,
                              int startOffset,
                              int endOffset,
                              TextAttributes attributes,
                              boolean hideByTextChange,
                              boolean hideByAnyKey,
                              java.util.Collection<? super RangeHighlighter> highlighters)

Description copied from class: HighlightManager

Highlights a specified range of text in an editor. The highlighting is removed when the user presses the Esc key or (optionally) any other key, and optionally when the editor text is changed. If the highlighter added by this method needs to be removed manually, HighlightManager.removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

Specified by:

addRangeHighlight in class HighlightManager

Parameters:

editor - the editor in which the highlighting is performed.

startOffset - the start offset of the text range to highlight.

endOffset - the end offset of the text range to highlight.

attributes - the attributes to highlight the text with.

hideByTextChange - if true, the highlighting is removed automatically if the editor text is changed.

hideByAnyKey - if true, the highlighting is removed automatically when the user presses any key.

highlighters - if not null, the created RangeHighlighter object is added to this collection.

addOccurrenceHighlights

public void addOccurrenceHighlights(Editor editor,
                                    PsiElement [] elements,
                                    TextAttributes attributes,
                                    boolean hideByTextChange,
                                    java.util.Collection<? super RangeHighlighter> outHighlighters)

Description copied from class: HighlightManager

Highlights the text ranges of the specified elements in the specified editor. The highlighting is removed when the user presses the Esc key, and optionally when the editor text is changed.

Specified by:

addOccurrenceHighlights in class HighlightManager

Parameters:

editor - the editor in which the highlighting is performed.

elements - the elements to highlight.

attributes - the attributes to highlight the text with.

hideByTextChange - if true, the highlighting is removed automatically if the editor text is changed.

outHighlighters - if not null, the created RangeHighlighter objects are added to this collection.

hideHighlights

public boolean hideHighlights(Editor editor,
                              int mask)