Package com.intellij.openapi.editor.markup

Interface ActiveGutterRenderer

All Superinterfaces:

LineMarkerRenderer, SimpleAccessible

All Known Implementing Classes:

CoverageLineMarkerRenderer

public interface ActiveGutterRenderer
extends LineMarkerRenderer, SimpleAccessible

Interface which should be implemented in order to paint custom markers in the line marker area (over the folding area) and process mouse events on the markers.

Method Summary

Modifier and Type	Method and Description
default java.awt.Rectangle	calcBounds(Editor editor, int lineNum, java.awt.Rectangle preferredBounds) Calculates the rectangular bounds enclosing the marker.
default boolean	canDoAction(Editor editor, java.awt.event.MouseEvent e)
default boolean	canDoAction(java.awt.event.MouseEvent e)
void	doAction(Editor editor, java.awt.event.MouseEvent e) Processes a mouse released event on the marker.
default java.lang.String	getAccessibleName() Returns a human-readable string that designates the purpose of the object.
default java.lang.String	getAccessibleTooltipText() Returns the tooltip text or null when the tooltip is not available
default java.lang.String	getTooltipText() Returns the text of the tooltip displayed when the mouse is over the renderer area.

Methods inherited from interface com.intellij.openapi.editor.markup.LineMarkerRenderer

paint

Method Detail

getTooltipText

default java.lang.String getTooltipText()

Returns the text of the tooltip displayed when the mouse is over the renderer area.

Returns:

the tooltip text, or null if no tooltip is required.

doAction

void doAction(Editor editor,
              java.awt.event.MouseEvent e)

Processes a mouse released event on the marker.

Implementations must extend one of canDoAction(com.intellij.openapi.editor.Editor, java.awt.event.MouseEvent) methods, otherwise the action will never be called.

Parameters:

editor - the editor to which the marker belongs.

e - the mouse event instance.

canDoAction

default boolean canDoAction(Editor editor,
                            java.awt.event.MouseEvent e)

Returns:

true if doAction(Editor, MouseEvent) should be called

canDoAction

default boolean canDoAction(java.awt.event.MouseEvent e)

getAccessibleName

default java.lang.String getAccessibleName()

Description copied from interface: SimpleAccessible

Returns a human-readable string that designates the purpose of the object.

Specified by:

getAccessibleName in interface SimpleAccessible

getAccessibleTooltipText

default java.lang.String getAccessibleTooltipText()

Description copied from interface: SimpleAccessible

Returns the tooltip text or null when the tooltip is not available

Specified by:

getAccessibleTooltipText in interface SimpleAccessible

calcBounds

default java.awt.Rectangle calcBounds(Editor editor,
                                      int lineNum,
                                      java.awt.Rectangle preferredBounds)

Calculates the rectangular bounds enclosing the marker. Returns null if the marker is not rendered for the provided line.

Parameters:

editor - the editor the renderer belongs to

lineNum - the line which the marker should intersect

preferredBounds - the preferred bounds to take into account

Returns:

the new calculated bounds or the preferred bounds or null