RangeHighlighter (Unofficial IntelliJ Community Edition API docs)

All Superinterfaces:

RangeMarker, Segment, UserDataHolder

All Known Subinterfaces:

RangeHighlighterEx
```
public interface RangeHighlighter
extends RangeMarker
```
Represents a range of text in the document which has specific markup (special text attributes, line marker, gutter icon, error stripe marker or line separator).

See Also:

MarkupModel.addRangeHighlighter(int, int, int, TextAttributes, HighlighterTargetArea), MarkupModel.addLineHighlighter(int, int, TextAttributes), Annotation

Field Summary

Fields
Modifier and Type Field and Description

static RangeHighlighter[] EMPTY_ARRAY
- Fields inherited from interface com.intellij.openapi.editor.RangeMarker
  BY_START_OFFSET
- Fields inherited from interface com.intellij.openapi.util.Segment
  BY_START_OFFSET_THEN_END_OFFSET

Fields
Modifier and Type	Field and Description
`static RangeHighlighter[]`	`EMPTY_ARRAY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CustomHighlighterRenderer`	`getCustomRenderer()`
`MarkupEditorFilter`	`getEditorFilter()` Gets the filter which can disable the highlighter in specific editor instances.
`java.awt.Color`	`getErrorStripeMarkColor()` Returns the color of the marker drawn in the error stripe in the area covered by the highlighter.
`java.lang.Object`	`getErrorStripeTooltip()` Returns the object whose `toString()` method is called to get the text of the tooltip for the error stripe marker added by the highlighter.
`GutterIconRenderer`	`getGutterIconRenderer()` Returns the renderer used for drawing gutter icons in the area covered by the highlighter.
`int`	`getLayer()` Returns the relative priority of the highlighter (higher priority highlighters can override lower priority ones; layer number values for standard IDE highlighters are defined in `HighlighterLayer`).
`LineMarkerRenderer`	`getLineMarkerRenderer()` Returns the renderer used for drawing line markers in the area covered by the highlighter, and optionally for processing mouse events over the markers.
`java.awt.Color`	`getLineSeparatorColor()` Returns the color of the separator drawn above or below the range covered by the highlighter.
`SeparatorPlacement`	`getLineSeparatorPlacement()` Returns the placement of the separator drawn by the range highlighter (above or below the range).
`LineSeparatorRenderer`	`getLineSeparatorRenderer()`
`HighlighterTargetArea`	`getTargetArea()` Returns the value indicating whether the highlighter affects a range of text or a sequence of of entire lines in the specified range.
`TextAttributes`	`getTextAttributes()` Returns the text attributes used for highlighting.
`boolean`	`isThinErrorStripeMark()` Returns the value indicating whether the error stripe marker has reduced width (like the markers used to highlight changed lines).
`void`	`setCustomRenderer(CustomHighlighterRenderer renderer)`
`void`	`setEditorFilter(MarkupEditorFilter filter)` Sets the filter which can disable the highlighter in specific editor instances.
`void`	`setErrorStripeMarkColor(java.awt.Color color)` Sets the color of the marker drawn in the error stripe in the area covered by the highlighter.
`void`	`setErrorStripeTooltip(java.lang.Object tooltipObject)` Sets the object whose `toString()` method is called to get the text of the tooltip for the error stripe marker added by the highlighter.
`void`	`setGutterIconRenderer(GutterIconRenderer renderer)` Sets the renderer used for drawing gutter icons in the area covered by the highlighter.
`void`	`setLineMarkerRenderer(LineMarkerRenderer renderer)` Sets the renderer used for drawing line markers in the area covered by the highlighter, and optionally for processing mouse events over the markers.
`void`	`setLineSeparatorColor(java.awt.Color color)` Sets the color of the separator drawn above or below the range covered by the highlighter.
`void`	`setLineSeparatorPlacement(SeparatorPlacement placement)` Sets the placement of the separator drawn by the range highlighter (above or below the range).
`void`	`setLineSeparatorRenderer(LineSeparatorRenderer renderer)`
`void`	`setThinErrorStripeMark(boolean value)` Sets the value indicating whether the error stripe marker has reduced width (like the markers used to highlight changed lines).

Methods inherited from interface com.intellij.openapi.editor.RangeMarker
dispose, getDocument, getEndOffset, getStartOffset, isGreedyToLeft, isGreedyToRight, isValid, setGreedyToLeft, setGreedyToRight

Methods inherited from interface com.intellij.openapi.util.UserDataHolder
getUserData, putUserData

- Field Detail
  - EMPTY_ARRAY
```
static final RangeHighlighter[] EMPTY_ARRAY
```
- Method Detail
  - getLayer
```
int getLayer()
```
    Returns the relative priority of the highlighter (higher priority highlighters can override lower priority ones; layer number values for standard IDE highlighters are defined in HighlighterLayer).
    
    Returns:
    
    the highlighter priority.
  - getTargetArea
```
HighlighterTargetArea getTargetArea()
```
    Returns the value indicating whether the highlighter affects a range of text or a sequence of of entire lines in the specified range.
    
    Returns:
    
    the highlighter target area.
  - getTextAttributes
```
TextAttributes getTextAttributes()
```
    Returns the text attributes used for highlighting.
    
    Returns:
    
    the attributes to use for highlighting, or null if the highlighter does not modify the text attributes.
  - getLineMarkerRenderer
```
LineMarkerRenderer getLineMarkerRenderer()
```
    Returns the renderer used for drawing line markers in the area covered by the highlighter, and optionally for processing mouse events over the markers. Line markers are drawn over the folding area and are used, for example, to highlight modified lines in files under source control.
    
    Returns:
    
    the renderer instance, or null if the highlighter does not add any line markers.
    
    See Also:
    
    ActiveGutterRenderer
  - setLineMarkerRenderer
```
void setLineMarkerRenderer(LineMarkerRenderer renderer)
```
    Sets the renderer used for drawing line markers in the area covered by the highlighter, and optionally for processing mouse events over the markers. Line markers are drawn over the folding area and are used, for example, to highlight modified lines in files under source control.
    
    Parameters:
    
    renderer - the renderer instance, or null if the highlighter does not add any line markers.
    
    See Also:
    
    ActiveGutterRenderer
  - getCustomRenderer
```
CustomHighlighterRenderer getCustomRenderer()
```
  - setCustomRenderer
```
void setCustomRenderer(CustomHighlighterRenderer renderer)
```
  - getGutterIconRenderer
```
GutterIconRenderer getGutterIconRenderer()
```
    Returns the renderer used for drawing gutter icons in the area covered by the highlighter. Gutter icons are drawn to the left of the folding area and can be used, for example, to mark implemented or overridden methods.
    
    Returns:
    
    the renderer instance, or null if the highlighter does not add any gutter icons.
  - setGutterIconRenderer
```
void setGutterIconRenderer(GutterIconRenderer renderer)
```
    Sets the renderer used for drawing gutter icons in the area covered by the highlighter. Gutter icons are drawn to the left of the folding area and can be used, for example, to mark implemented or overridden methods.
    
    Parameters:
    
    renderer - the renderer instance, or null if the highlighter does not add any gutter icons.
  - getErrorStripeMarkColor
```
java.awt.Color getErrorStripeMarkColor()
```
    Returns the color of the marker drawn in the error stripe in the area covered by the highlighter.
    
    Returns:
    
    the error stripe marker color, or null if the highlighter does not add any error stripe markers.
  - setErrorStripeMarkColor
```
void setErrorStripeMarkColor(java.awt.Color color)
```
    Sets the color of the marker drawn in the error stripe in the area covered by the highlighter.
    
    Parameters:
    
    color - the error stripe marker color, or null if the highlighter does not add any error stripe markers.
  - getErrorStripeTooltip
```
java.lang.Object getErrorStripeTooltip()
```
    Returns the object whose toString() method is called to get the text of the tooltip for the error stripe marker added by the highlighter.
    
    Returns:
    
    the error stripe tooltip objects, or null if the highlighter does not add any error stripe markers or the marker has no tooltip.
  - setErrorStripeTooltip
```
void setErrorStripeTooltip(java.lang.Object tooltipObject)
```
    Sets the object whose toString() method is called to get the text of the tooltip for the error stripe marker added by the highlighter.
    
    Parameters:
    
    tooltipObject - the error stripe tooltip objects, or null if the highlighter does not add any error stripe markers or the marker has no tooltip.
  - isThinErrorStripeMark
```
boolean isThinErrorStripeMark()
```
    Returns the value indicating whether the error stripe marker has reduced width (like the markers used to highlight changed lines).
    
    Returns:
    
    true if the marker has reduced width, false otherwise.
  - setThinErrorStripeMark
```
void setThinErrorStripeMark(boolean value)
```
    Sets the value indicating whether the error stripe marker has reduced width (like the markers used to highlight changed lines).
    
    Parameters:
    
    value - true if the marker has reduced width, false otherwise.
  - getLineSeparatorColor
```
java.awt.Color getLineSeparatorColor()
```
    Returns the color of the separator drawn above or below the range covered by the highlighter.
    
    Returns:
    
    the separator color, or null if the highlighter does not add a line separator.
  - setLineSeparatorColor
```
void setLineSeparatorColor(java.awt.Color color)
```
    Sets the color of the separator drawn above or below the range covered by the highlighter.
    
    Parameters:
    
    color - the separator color, or null if the highlighter does not add a line separator.
  - setLineSeparatorRenderer
```
void setLineSeparatorRenderer(LineSeparatorRenderer renderer)
```
  - getLineSeparatorRenderer
```
LineSeparatorRenderer getLineSeparatorRenderer()
```
  - getLineSeparatorPlacement
```
SeparatorPlacement getLineSeparatorPlacement()
```
    Returns the placement of the separator drawn by the range highlighter (above or below the range).
    
    Returns:
    
    the separator placement, or null if the highlighter does not add a line separator.
  - setLineSeparatorPlacement
```
void setLineSeparatorPlacement(SeparatorPlacement placement)
```
    Sets the placement of the separator drawn by the range highlighter (above or below the range).
    
    Parameters:
    
    placement - the separator placement, or null if the highlighter does not add a line separator.
  - setEditorFilter
```
void setEditorFilter(MarkupEditorFilter filter)
```
    Sets the filter which can disable the highlighter in specific editor instances.
    
    Parameters:
    
    filter - the filter controlling the highlighter availability, or MarkupEditorFilter.EMPTY if highlighter is available in all editors.
  - getEditorFilter
```
MarkupEditorFilter getEditorFilter()
```
    Gets the filter which can disable the highlighter in specific editor instances.
    
    Returns:
    
    the filter controlling the highlighter availability. Default availability is controlled by MarkupEditorFilter.EMPTY.

Interface RangeHighlighter

Field Summary

Fields inherited from interface com.intellij.openapi.editor.RangeMarker

Fields inherited from interface com.intellij.openapi.util.Segment

Method Summary

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

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

Field Detail

EMPTY_ARRAY

Method Detail

getLayer

getTargetArea

getTextAttributes

getLineMarkerRenderer

setLineMarkerRenderer

getCustomRenderer

setCustomRenderer

getGutterIconRenderer

setGutterIconRenderer

getErrorStripeMarkColor

setErrorStripeMarkColor

getErrorStripeTooltip

setErrorStripeTooltip

isThinErrorStripeMark

setThinErrorStripeMark

getLineSeparatorColor

setLineSeparatorColor

setLineSeparatorRenderer

getLineSeparatorRenderer

getLineSeparatorPlacement

setLineSeparatorPlacement

setEditorFilter

getEditorFilter