Package com.intellij.codeInsight.highlighting

Class HighlightManager

java.lang.Object

com.intellij.codeInsight.highlighting.HighlightManager

Direct Known Subclasses:

HighlightManagerImpl

public abstract class HighlightManager
extends java.lang.Object

Allows to highlight areas of text and occurrences of PSI elements in the editor, and to remove the highlighting automatically by some condition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HighlightManager.HideFlags

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIDE_BY_ANY_KEY Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the user presses any key.
static int	HIDE_BY_ESCAPE Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the user presses Esc.
static int	HIDE_BY_TEXT_CHANGE Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the editor text is changed.

Constructor Summary

Constructors

Constructor and Description
HighlightManager()

Method Summary

Modifier and Type	Method and Description
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract void	addRangeHighlight(Editor editor, int startOffset, int endOffset, TextAttributes attributes, boolean hideByTextChange, java.util.Collection<? super RangeHighlighter> outHighlighters) Highlights a specified range of text in an editor.
static HighlightManager	getInstance(Project project)
abstract boolean	removeSegmentHighlighter(Editor editor, RangeHighlighter highlighter) Removes a range highlighter added by 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 java.lang.Object

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

Field Detail

HIDE_BY_ESCAPE

public static final int HIDE_BY_ESCAPE

Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the user presses Esc.

See Also:

Constant Field Values

HIDE_BY_ANY_KEY

public static final int HIDE_BY_ANY_KEY

Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the user presses any key.

See Also:

Constant Field Values

HIDE_BY_TEXT_CHANGE

public static final int HIDE_BY_TEXT_CHANGE

Specifies that a highlighter added with addOccurrenceHighlight(com.intellij.openapi.editor.Editor, int, int, com.intellij.openapi.editor.markup.TextAttributes, int, java.util.Collection<? super com.intellij.openapi.editor.markup.RangeHighlighter>, java.awt.Color) should be removed when the editor text is changed.

See Also:

Constant Field Values

Constructor Detail

HighlightManager

public HighlightManager()

Method Detail

getInstance

public static HighlightManager getInstance(Project project)

addRangeHighlight

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

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, removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

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.

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

addRangeHighlight

public abstract 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. 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, removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

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.

removeSegmentHighlighter

public abstract boolean removeSegmentHighlighter(Editor editor,
                                                 RangeHighlighter highlighter)

Removes a range highlighter added by 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.

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 abstract 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. The highlighting is removed when the user presses the Esc key, and optionally when the editor text is changed.

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.

addOccurrenceHighlights

public abstract 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. The highlighting is removed when the user presses the Esc key, and optionally when the editor text is changed.

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.

addOccurrenceHighlight

public abstract 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. 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, removeSegmentHighlighter(com.intellij.openapi.editor.Editor, com.intellij.openapi.editor.markup.RangeHighlighter) must be used for that.

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 HIDE_BY_ESCAPE, HIDE_BY_ANY_KEY and 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.