Package com.intellij.openapi.vcs.actions

Class AnnotationFieldGutter

java.lang.Object

com.intellij.openapi.vcs.actions.AnnotationFieldGutter

All Implemented Interfaces:

EditorGutterAction, TextAnnotationGutterProvider, ActiveAnnotationGutter

Direct Known Subclasses:

AspectAnnotationFieldGutter, ExtraFieldGutter

public abstract class AnnotationFieldGutter
extends java.lang.Object
implements ActiveAnnotationGutter

Field Summary

Fields

Modifier and Type	Field and Description
protected FileAnnotation	myAnnotation

Method Summary

Modifier and Type	Method and Description
void	doAction(int line) Processes the click on the specified line.
java.awt.Color	getBgColor(int line, Editor editor) Returns the background color for the text
ColorKey	getColor(int line, Editor editor)
java.awt.Cursor	getCursor(int line) Returns the cursor to be shown where the mouse is over the annotation for the specified line.
FileAnnotation	getFileAnnotation()
java.lang.String	getID()
java.util.List<AnAction>	getPopupActions(int line, Editor editor) enables annotation view modifications
TextAnnotationPresentation	getPresentation()
EditorFontType	getStyle(int line, Editor editor)
java.lang.String	getToolTip(int line, Editor editor)
void	gutterClosed() Called when the annotations are removed from the editor gutter.
boolean	isAvailable()
boolean	isGutterAction()
boolean	isShowByDefault()

Methods inherited from class java.lang.Object

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

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

getLineText, useMargin

Field Detail

myAnnotation

protected final FileAnnotation myAnnotation

Method Detail

getFileAnnotation

public FileAnnotation getFileAnnotation()

getPresentation

public TextAnnotationPresentation getPresentation()

isGutterAction

public boolean isGutterAction()

getToolTip

public java.lang.String getToolTip(int line,
                                   Editor editor)

Specified by:

getToolTip in interface TextAnnotationGutterProvider

doAction

public void doAction(int line)

Description copied from interface: EditorGutterAction

Processes the click on the specified line.

Specified by:

doAction in interface EditorGutterAction

Parameters:

line - the number of line in the document the annotation for which was clicked.

getCursor

public java.awt.Cursor getCursor(int line)

Description copied from interface: EditorGutterAction

Returns the cursor to be shown where the mouse is over the annotation for the specified line.

Specified by:

getCursor in interface EditorGutterAction

Parameters:

line - the line number.

Returns:

the cursor to show.

getStyle

public EditorFontType getStyle(int line,
                               Editor editor)

Specified by:

getStyle in interface TextAnnotationGutterProvider

getColor

public ColorKey getColor(int line,
                         Editor editor)

Specified by:

getColor in interface TextAnnotationGutterProvider

getPopupActions

public java.util.List<AnAction> getPopupActions(int line,
                                                Editor editor)

Description copied from interface: TextAnnotationGutterProvider

enables annotation view modifications

Specified by:

getPopupActions in interface TextAnnotationGutterProvider

gutterClosed

public void gutterClosed()

Description copied from interface: TextAnnotationGutterProvider

Called when the annotations are removed from the editor gutter.

Specified by:

gutterClosed in interface TextAnnotationGutterProvider

See Also:

EditorGutter.closeAllAnnotations()

getBgColor

public java.awt.Color getBgColor(int line,
                                 Editor editor)

Description copied from interface: TextAnnotationGutterProvider

Returns the background color for the text

Specified by:

getBgColor in interface TextAnnotationGutterProvider

Parameters:

line - the line for which the background color is requested.

editor - the editor in which the text will be drawn.

Returns:

the text to draw, or null if no text should be drawn.

isShowByDefault

public boolean isShowByDefault()

isAvailable

public boolean isAvailable()

getID

public java.lang.String getID()