Package com.intellij.openapi.editor.markup

Class GutterIconRenderer

java.lang.Object

com.intellij.openapi.editor.markup.GutterIconRenderer

All Implemented Interfaces:

GutterMark, PossiblyDumbAware, SimpleAccessible

Direct Known Subclasses:

BoundIconRenderer, DiffGutterRenderer, GutterActionRenderer, LineMarkerInfo.LineMarkerGutterIconRenderer, NavigationGutterIconRenderer, XBreakpointBase.BreakpointGutterIconRenderer

public abstract class GutterIconRenderer
extends java.lang.Object
implements GutterMark, PossiblyDumbAware, SimpleAccessible

Interface which should be implemented in order to draw icons in the gutter area and handle events for them. Gutter icons are drawn to the left of the folding area and can be used, for example, to mark implemented or overridden methods.

Daemon code analyzer checks newly arrived gutter icon renderer against the old one and if they are equal, does not redraw the icon. So it is highly advisable to override hashCode()/equals() methods to avoid icon flickering when old gutter renderer gets replaced with the new. Proper implementation of equals is also important for instances used to specify gutter icons for inlays (see EditorCustomElementRenderer.calcGutterIconRenderer(Inlay))

During indexing, methods are only invoked for renderers implementing DumbAware.

See Also:

RangeHighlighter.setGutterIconRenderer(GutterIconRenderer), Inlay.getGutterIconRenderer(), EditorCustomElementRenderer.calcGutterIconRenderer(Inlay)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GutterIconRenderer.Alignment

Constructor Summary

Constructors

Constructor and Description
GutterIconRenderer()

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(java.lang.Object obj)
java.lang.String	getAccessibleName() Returns a human-readable string that designates the purpose of the object.
java.lang.String	getAccessibleTooltipText() Returns the tooltip text or null when the tooltip is not available
GutterIconRenderer.Alignment	getAlignment() Defines positioning of the icon inside gutter's icon area.
AnAction	getClickAction() Returns the action executed when the icon is left-clicked.
GutterDraggableObject	getDraggableObject() Returns the callback which can be used to handle drag and drop of the gutter icon.
java.lang.String	getFeatureId()
AnAction	getMiddleButtonClickAction() Returns the action executed when the icon is middle-clicked.
ActionGroup	getPopupMenuActions() Returns the action group actions from which are used to fill the context menu displayed when the icon is right-clicked.
AnAction	getRightButtonClickAction() Returns the action executed when the icon is right-clicked.
java.lang.String	getTooltipText() Returns the text of the tooltip displayed when the mouse is over the icon.
abstract int	hashCode()
boolean	isNavigateAction() Returns the value indicating whether the hand cursor should be displayed when the mouse is hovering over the icon.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.daemon.GutterMark

getIcon

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

GutterIconRenderer

public GutterIconRenderer()

Method Detail

getPopupMenuActions

public ActionGroup getPopupMenuActions()

Returns the action group actions from which are used to fill the context menu displayed when the icon is right-clicked.

Returns:

the group of actions for the context menu, or null if no context menu is required.

See Also:

getRightButtonClickAction()

getTooltipText

public java.lang.String getTooltipText()

Returns the text of the tooltip displayed when the mouse is over the icon.

Specified by:

getTooltipText in interface GutterMark

Returns:

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

getClickAction

public AnAction getClickAction()

Returns the action executed when the icon is left-clicked.

Returns:

the action instance, or null if no action is required.

getMiddleButtonClickAction

public AnAction getMiddleButtonClickAction()

Returns the action executed when the icon is middle-clicked.

Returns:

the action instance, or null if no action is required.

getRightButtonClickAction

public AnAction getRightButtonClickAction()

Returns the action executed when the icon is right-clicked.

Returns:

the action instance, or null to show the popup menu

See Also:

getPopupMenuActions()

isNavigateAction

public boolean isNavigateAction()

Returns the value indicating whether the hand cursor should be displayed when the mouse is hovering over the icon.

Returns:

true if the hand cursor should be displayed, false if the regular cursor is displayed.

getAlignment

public GutterIconRenderer.Alignment getAlignment()

Defines positioning of the icon inside gutter's icon area. The order, in which icons with the same alignment values are displayed, is not specified (it can be influenced using GutterMarkPreprocessor).

getDraggableObject

public GutterDraggableObject getDraggableObject()

Returns the callback which can be used to handle drag and drop of the gutter icon.

Returns:

the drag handler callback, or null if no drag and drop of the icon is required.

getAccessibleName

public 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

getFeatureId

public final java.lang.String getFeatureId()

getAccessibleTooltipText

public 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

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object