Package com.intellij.openapi.vcs.annotate

Class LineAnnotationAspectAdapter

java.lang.Object

com.intellij.openapi.vcs.annotate.LineAnnotationAspectAdapter

All Implemented Interfaces:

EditorGutterAction, LineAnnotationAspect

public abstract class LineAnnotationAspectAdapter
extends java.lang.Object
implements LineAnnotationAspect, EditorGutterAction

Field Summary

Fields inherited from interface com.intellij.openapi.vcs.annotate.LineAnnotationAspect

AUTHOR, DATE, REVISION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LineAnnotationAspectAdapter()
protected	LineAnnotationAspectAdapter(java.lang.String id)
	LineAnnotationAspectAdapter(java.lang.String id, boolean showByDefault)

Method Summary

Modifier and Type	Method and Description
void	doAction(int lineNum) Processes the click on the specified line.
java.awt.Cursor	getCursor(int lineNum) Returns the cursor to be shown where the mouse is over the annotation for the specified line.
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
java.lang.String	getTooltipText(int lineNumber) Used to show a tooltip for specific line or group of lines
boolean	isShowByDefault() Returns true if this aspect will be shown on Annotate action
protected abstract void	showAffectedPaths(int lineNum)

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.vcs.annotate.LineAnnotationAspect

getBgColor, getColor, getStyle, getValue

Constructor Detail

LineAnnotationAspectAdapter

protected LineAnnotationAspectAdapter()

LineAnnotationAspectAdapter

protected LineAnnotationAspectAdapter(java.lang.String id)

LineAnnotationAspectAdapter

public LineAnnotationAspectAdapter(java.lang.String id,
                                   boolean showByDefault)

Method Detail

getTooltipText

public java.lang.String getTooltipText(int lineNumber)

Description copied from interface: LineAnnotationAspect

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

Specified by:

getTooltipText in interface LineAnnotationAspect

Parameters:

lineNumber - the line number to query

Returns:

the tooltip text for the line

getId

public java.lang.String getId()

Description copied from interface: LineAnnotationAspect

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

Specified by:

getId in interface LineAnnotationAspect

Returns:

unique id

isShowByDefault

public boolean isShowByDefault()

Description copied from interface: LineAnnotationAspect

Returns true if this aspect will be shown on Annotate action

Specified by:

isShowByDefault in interface LineAnnotationAspect

Returns:

true if this aspect will be shown on Annotate action

getCursor

public java.awt.Cursor getCursor(int lineNum)

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:

lineNum - the line number.

Returns:

the cursor to show.

doAction

public void doAction(int lineNum)

Description copied from interface: EditorGutterAction

Processes the click on the specified line.

Specified by:

doAction in interface EditorGutterAction

Parameters:

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

showAffectedPaths

protected abstract void showAffectedPaths(int lineNum)