Package org.eclipse.jface.text.source

Interface IAnnotationPresentation

  • All Known Implementing Classes:
    DefaultRangeIndicator, ProjectionAnnotation
    public interface IAnnotationPresentation
    Interface for annotations that can take care of their own visible representation.
    Since:
    3.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_LAYER
      The default annotation layer.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getLayer()
      Returns the annotations drawing layer.
      void paint​(GC gc, Canvas canvas, Rectangle bounds)
      Implement this method to draw a graphical representation of this annotation within the given bounds.

    • Field Detail

      • DEFAULT_LAYER

        static final int DEFAULT_LAYER
        The default annotation layer.
        See Also:
        Constant Field Values

    • Method Detail

      • getLayer

        int getLayer()
        Returns the annotations drawing layer.
        Returns:
        the annotations drawing layer

      • paint

        void paint​(GC gc,
           Canvas canvas,
           Rectangle bounds)
        Implement this method to draw a graphical representation of this annotation within the given bounds.

        Note that this method is not used when drawing annotations on the editor's text widget. This is handled trough a AnnotationPainter.IDrawingStrategy.

        Parameters:
        gc - the drawing GC
        canvas - the canvas to draw on
        bounds - the bounds inside the canvas to draw on