Package com.intellij.openapi.vcs.annotate

Interface LineAnnotationAspect

All Known Implementing Classes:

LineAnnotationAspectAdapter

public interface LineAnnotationAspect

Represents one part of a line annotation which is shown in the editor when the "Annotate" action is invoked. Classes implementing this interface can also implement EditorGutterAction to handle clicks on the annotation.

See Also:

FileAnnotation.getAspects()

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHOR
static java.lang.String	DATE
static java.lang.String	REVISION

Method Summary

Modifier and Type	Method and Description
default java.awt.Color	getBgColor(int line) Used to override default background color
default ColorKey	getColor(int line) Used to override default text color
java.lang.String	getId() Returns unique identifier, that will be used to show/hide some aspects If null this line aspect won't be configurable in annotation settings
default EditorFontType	getStyle(int line) Used to override default text style
java.lang.String	getTooltipText(int line) Used to show a tooltip for specific line or group of lines
java.lang.String	getValue(int line) Get annotation text for the specific line number
boolean	isShowByDefault() Returns true if this aspect will be shown on Annotate action

Field Detail

AUTHOR

static final java.lang.String AUTHOR

DATE

static final java.lang.String DATE

REVISION

static final java.lang.String REVISION

Method Detail

getValue

java.lang.String getValue(int line)

Get annotation text for the specific line number

Parameters:

line - the line number to query

Returns:

the annotation text

getTooltipText

java.lang.String getTooltipText(int line)

Used to show a tooltip for specific line or group of lines

Parameters:

line - the line number to query

Returns:

the tooltip text for the line

getId

java.lang.String getId()

Returns unique identifier, that will be used to show/hide some aspects If null this line aspect won't be configurable in annotation settings

Returns:

unique id

isShowByDefault

boolean isShowByDefault()

Returns true if this aspect will be shown on Annotate action

Returns:

true if this aspect will be shown on Annotate action

getStyle

default EditorFontType getStyle(int line)

Used to override default text style

getColor

default ColorKey getColor(int line)

Used to override default text color

getBgColor

default java.awt.Color getBgColor(int line)

Used to override default background color