Class AnnotationPainter
- java.lang.Object
-
- org.eclipse.jface.text.source.AnnotationPainter
-
- All Implemented Interfaces:
EventListener,IPainter,ITextPresentationListener,IAnnotationModelListener,IAnnotationModelListenerExtension,PaintListener,SWTEventListener
public class AnnotationPainter extends Object implements IPainter, PaintListener, IAnnotationModelListener, IAnnotationModelListenerExtension, ITextPresentationListener
Paints decorations for annotations provided by an annotation model and/or highlights them in the associated source viewer.The annotation painter can be configured with drawing strategies. A drawing strategy defines the visual presentation of a particular type of annotation decoration.
Clients usually instantiate and configure objects of this class.
- Since:
- 2.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAnnotationPainter.BoxStrategyBox text style strategy.static classAnnotationPainter.HighlightingStrategystatic interfaceAnnotationPainter.IDrawingStrategyA drawing strategy draws the decoration for an annotation onto the text widget.static interfaceAnnotationPainter.ITextStyleStrategyA text style painting strategy draws the decoration for an annotation onto the text widget by applying aTextStyleon a givenStyleRange.static classAnnotationPainter.NullStrategyDrawing strategy that does nothing.static classAnnotationPainter.SquigglesStrategyDeprecated.As of 3.4, replaced byAnnotationPainter.UnderlineStrategystatic classAnnotationPainter.UnderlineStrategyUnderline text style strategy.
-
Field Summary
-
Fields inherited from interface org.eclipse.jface.text.IPainter
CONFIGURATION, INTERNAL, KEY_STROKE, MOUSE_BUTTON, SELECTION, TEXT_CHANGE
-
-
Constructor Summary
Constructors Constructor Description AnnotationPainter(ISourceViewer sourceViewer, IAnnotationAccess access)Creates a new annotation painter for the given source viewer and with the given annotation access.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddAnnotationType(Object annotationType)Deprecated.As of 3.4 replaced byaddTextStyleStrategy(Object, AnnotationPainter.ITextStyleStrategy)andAnnotationPainter.UnderlineStrategyvoidaddAnnotationType(Object annotationType, Object strategyID)Adds the given annotation type to the list of annotation types whose annotations should be painted by this painter using the given strategy.voidaddDrawingStrategy(Object id, AnnotationPainter.IDrawingStrategy strategy)Registers a new drawing strategy under the given ID.voidaddHighlightAnnotationType(Object annotationType)Adds the given annotation type to the list of annotation types whose annotations should be highlighted this painter.voidaddTextStyleStrategy(Object id, AnnotationPainter.ITextStyleStrategy strategy)Registers a new drawing strategy under the given ID.voidapplyTextPresentation(TextPresentation tp)This method is called when a text presentation is about to be applied to the text viewer.voiddeactivate(boolean redraw)Deactivates this painter.voiddispose()Disposes this painter.protected IAnnotationModelfindAnnotationModel(ISourceViewer sourceViewer)Retrieves the annotation model from the given source viewer.booleanisPaintingAnnotations()Returns whether the list of annotation types whose annotations are painted by this painter contains at least on element.protected booleanisRepaintReason(int reason)Returns whether the given reason causes a repaint.voidmodelChanged(AnnotationModelEvent event)Called if a model change occurred on the given model.voidmodelChanged(IAnnotationModel model)Called if a model change occurred on the given model.voidpaint(int reason)Requests this painter to repaint because of the given reason.voidpaintControl(PaintEvent event)Sent when a paint event occurs for the control.voidremoveAllAnnotationTypes()Clears the list of annotation types whose annotations are painted by this painter.voidremoveAnnotationType(Object annotationType)Removes the given annotation type from the list of annotation types whose annotations are painted by this painter.voidremoveHighlightAnnotationType(Object annotationType)Removes the given annotation type from the list of annotation types whose annotations are highlighted by this painter.voidsetAnnotationTypeColor(Object annotationType, Color color)Sets the color in which the squiggly for the given annotation type should be drawn.voidsetPositionManager(IPaintPositionManager manager)Sets the paint position manager that can be used by this painter or removes any previously set paint position manager.protected booleanskip(Annotation annotation)Should the given annotation be skipped when handling draw requests?
-
-
-
Constructor Detail
-
AnnotationPainter
public AnnotationPainter(ISourceViewer sourceViewer, IAnnotationAccess access)
Creates a new annotation painter for the given source viewer and with the given annotation access. The painter is not initialized, i.e. no annotation types are configured to be painted.- Parameters:
sourceViewer- the source viewer for this painteraccess- the annotation access for this painter
-
-
Method Detail
-
applyTextPresentation
public void applyTextPresentation(TextPresentation tp)
Description copied from interface:ITextPresentationListenerThis method is called when a text presentation is about to be applied to the text viewer. The receiver is allowed to change the text presentation during that call.- Specified by:
applyTextPresentationin interfaceITextPresentationListener- Parameters:
tp- the current text presentation
-
modelChanged
public void modelChanged(IAnnotationModel model)
Description copied from interface:IAnnotationModelListenerCalled if a model change occurred on the given model.Replaced by
IAnnotationModelListenerExtension.modelChanged(AnnotationModelEvent).- Specified by:
modelChangedin interfaceIAnnotationModelListener- Parameters:
model- the changed annotation model
-
modelChanged
public void modelChanged(AnnotationModelEvent event)
Description copied from interface:IAnnotationModelListenerExtensionCalled if a model change occurred on the given model.- Specified by:
modelChangedin interfaceIAnnotationModelListenerExtension- Parameters:
event- the event to be sent out
-
setAnnotationTypeColor
public void setAnnotationTypeColor(Object annotationType, Color color)
Sets the color in which the squiggly for the given annotation type should be drawn.- Parameters:
annotationType- the annotation typecolor- the color
-
addAnnotationType
@Deprecated public void addAnnotationType(Object annotationType)
Deprecated.As of 3.4 replaced byaddTextStyleStrategy(Object, AnnotationPainter.ITextStyleStrategy)andAnnotationPainter.UnderlineStrategyAdds the given annotation type to the list of annotation types whose annotations should be painted by this painter using squiggly drawing. If the annotation type is already in this list, this method is without effect.- Parameters:
annotationType- the annotation type
-
addAnnotationType
public void addAnnotationType(Object annotationType, Object strategyID)
Adds the given annotation type to the list of annotation types whose annotations should be painted by this painter using the given strategy. If the annotation type is already in this list, the old strategy gets replaced.- Parameters:
annotationType- the annotation typestrategyID- the id of the drawing or text style strategy that should be used for this annotation type- Since:
- 3.0
-
addDrawingStrategy
public void addDrawingStrategy(Object id, AnnotationPainter.IDrawingStrategy strategy)
Registers a new drawing strategy under the given ID. If there is already a strategy registered underid, the old strategy gets replaced.The given id can be referenced when adding annotation types, see
addAnnotationType(Object, Object).- Parameters:
id- the identifier under which the strategy can be referenced, notnullstrategy- the new strategy- Since:
- 3.0
-
addTextStyleStrategy
public void addTextStyleStrategy(Object id, AnnotationPainter.ITextStyleStrategy strategy)
Registers a new drawing strategy under the given ID. If there is already a strategy registered underid, the old strategy gets replaced.The given id can be referenced when adding annotation types, see
addAnnotationType(Object, Object).Note: The annotations will only be painted if this painter has been registered as text presentation listener on the viewer.
- Parameters:
id- the identifier under which the strategy can be referenced, notnullstrategy- the new strategy- Since:
- 3.4
- See Also:
ITextViewerExtension4.addTextPresentationListener(ITextPresentationListener)
-
addHighlightAnnotationType
public void addHighlightAnnotationType(Object annotationType)
Adds the given annotation type to the list of annotation types whose annotations should be highlighted this painter. If the annotation type is already in this list, this method is without effect.Note: The annotations will only be painted if this painter has been registered as text presentation listener on the viewer.
- Parameters:
annotationType- the annotation type- Since:
- 3.0
- See Also:
ITextViewerExtension4.addTextPresentationListener(ITextPresentationListener)
-
removeAnnotationType
public void removeAnnotationType(Object annotationType)
Removes the given annotation type from the list of annotation types whose annotations are painted by this painter. If the annotation type is not in this list, this method is without effect.- Parameters:
annotationType- the annotation type
-
removeHighlightAnnotationType
public void removeHighlightAnnotationType(Object annotationType)
Removes the given annotation type from the list of annotation types whose annotations are highlighted by this painter. If the annotation type is not in this list, this method is without effect.- Parameters:
annotationType- the annotation type- Since:
- 3.0
-
removeAllAnnotationTypes
public void removeAllAnnotationTypes()
Clears the list of annotation types whose annotations are painted by this painter.
-
isPaintingAnnotations
public boolean isPaintingAnnotations()
Returns whether the list of annotation types whose annotations are painted by this painter contains at least on element.- Returns:
trueif there is an annotation type whose annotations are painted
-
dispose
public void dispose()
Description copied from interface:IPainterDisposes this painter. Prior to disposing, a painter should be deactivated. A disposed painter can not be reactivated.- Specified by:
disposein interfaceIPainter- See Also:
IPainter.deactivate(boolean)
-
paintControl
public void paintControl(PaintEvent event)
Description copied from interface:PaintListenerSent when a paint event occurs for the control.- Specified by:
paintControlin interfacePaintListener- Parameters:
event- an event containing information about the paint
-
skip
protected boolean skip(Annotation annotation)
Should the given annotation be skipped when handling draw requests?- Parameters:
annotation- the annotation- Returns:
trueiff the given annotation should be skipped when handling draw requests- Since:
- 3.0
-
deactivate
public void deactivate(boolean redraw)
Description copied from interface:IPainterDeactivates this painter. If the painter is inactive, this call does not have any effect.redrawindicates whether the painter should remove any decoration it previously applied. A deactivated painter can be reactivated by callingpaint.- Specified by:
deactivatein interfaceIPainter- Parameters:
redraw-trueif any previously applied decoration should be removed- See Also:
IPainter.paint(int)
-
isRepaintReason
protected boolean isRepaintReason(int reason)
Returns whether the given reason causes a repaint.- Parameters:
reason- the reason- Returns:
trueif repaint reason,falseotherwise- Since:
- 3.0
-
findAnnotationModel
protected IAnnotationModel findAnnotationModel(ISourceViewer sourceViewer)
Retrieves the annotation model from the given source viewer.- Parameters:
sourceViewer- the source viewer- Returns:
- the source viewer's annotation model or
nullif none can be found - Since:
- 3.0
-
paint
public void paint(int reason)
Description copied from interface:IPainterRequests this painter to repaint because of the given reason. Based on the given reason the painter can decide whether it will repaint or not. If it repaints and is inactive, it will activate itself.
-
setPositionManager
public void setPositionManager(IPaintPositionManager manager)
Description copied from interface:IPainterSets the paint position manager that can be used by this painter or removes any previously set paint position manager.- Specified by:
setPositionManagerin interfaceIPainter- Parameters:
manager- the paint position manager ornull
-
-