Class UnifiedDiffCodeMiningProvider.FoldedRegionCodeMining

java.lang.Object

org.eclipse.jface.text.codemining.AbstractCodeMining

org.eclipse.jface.text.codemining.LineHeaderCodeMining

org.eclipse.compare.unifieddiff.internal.UnifiedDiffCodeMiningProvider.FoldedRegionCodeMining

All Implemented Interfaces:

ICodeMining

Enclosing class:

UnifiedDiffCodeMiningProvider

public static class UnifiedDiffCodeMiningProvider.FoldedRegionCodeMining
extends LineHeaderCodeMining

Constructor Summary

Constructors

Constructor	Description
FoldedRegionCodeMining(Position position, ICodeMiningProvider provider, ITextViewer viewer, Annotation foldAnnotation, int foldableLines, boolean collapsed, Color separatorColor, Color buttonColor)

Method Summary

Modifier and Type	Method	Description
Point	draw(GC gc, StyledText textWidget, Color color, int x, int y)	Draw the AbstractCodeMining.getLabel() of mining with gray color.
String	getLabel()	Returns the label may be set early in the class lifecycle, or upon completion of the future provided by ICodeMining.resolve(ITextViewer, IProgressMonitor) operation.
boolean	isExpander()	Whether clicking this band shows the region rather than hiding it again.

Methods inherited from class AbstractCodeMining

dispose, doResolve, getAction, getPosition, getProvider, isResolved, resolve, setLabel

Methods inherited from class Object

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

Methods inherited from interface ICodeMining

getMouseHover, getMouseMove, getMouseOut

Constructor Details

FoldedRegionCodeMining

public FoldedRegionCodeMining(Position position,
 ICodeMiningProvider provider,
 ITextViewer viewer,
 Annotation foldAnnotation,
 int foldableLines,
 boolean collapsed,
 Color separatorColor,
 Color buttonColor)
                       throws BadLocationException

Throws:

BadLocationException

Method Details

isExpander

public boolean isExpander()

Whether clicking this band shows the region rather than hiding it again.

getLabel

public String getLabel()

Description copied from interface: ICodeMining

Returns the label may be set early in the class lifecycle, or upon completion of the future provided by ICodeMining.resolve(ITextViewer, IProgressMonitor) operation.

The returned label can have several values:

• null when mining is not resolved
• null when mining is resolved means that mining was resolved with an error and it will not be displayed.
• empty when mining is resolved means that mining will not be displayed
• non empty when mining must be displayed

Specified by:

getLabel in interface ICodeMining

Overrides:

getLabel in class AbstractCodeMining

Returns:

the label may be set early in the class lifecycle, or upon completion of the future provided by ICodeMining.resolve(ITextViewer, IProgressMonitor) operation.

draw

public Point draw(GC gc,
 StyledText textWidget,
 Color color,
 int x,
 int y)

Description copied from class: AbstractCodeMining

Draw the AbstractCodeMining.getLabel() of mining with gray color. User can override this method to draw anything.

Specified by:

draw in interface ICodeMining

Overrides:

draw in class LineHeaderCodeMining

Parameters:

gc - the graphics context

textWidget - the text widget to draw on

color - the color of the line

x - the x position of the annotation

y - the y position of the annotation

Returns:

the size of the draw of mining.