| org.eclipse.jface.text.source |
Package-level Javadoc
Provides a framework for connecting document regions
with annotations and for displaying those annotations in combination with
an ITextViewer. ISourceViewer combines annotation support
and all text viewer add-ons.
Package Specification
ISourceViewer defines the concept of a document based, editable
viewer supporting visual annotations. ISourceViewer supports document-specific
and viewer-specific annotations attached to the viewer's input document.
An ISourceViewer uses an IAnnotationModel to manage annotations
and to inform implementers of IAnnotationModelListener about changes
in respect to annotations. An IVerticalRuler represents an IAnnotationModel
access adapter for an SWT widget capapble of display annotations.
This package also provides default implementations for all defined interfaces.
|
| Java Source File Name | Type | Comment |
| AbstractRulerColumn.java | Class | Abstract implementation of a
IVerticalRulerColumn that
uses a
Canvas to draw the ruler contents and which
handles scrolling and mouse selection.
Painting
Subclasses can hook into the paint loop at three levels:
Invalidation
Subclasses may call
AbstractRulerColumn.redraw() to mark the entire ruler as needing to be redrawn.
Alternatively, use
AbstractRulerColumn.redraw(ILineRange) to only invalidate a certain line range, for
example due to changes to the display model.
Configuration
Subclasses can set the following properties. |
| AnnotationBarHoverManager.java | Class | This manager controls the layout, content, and visibility of an information
control in reaction to mouse hover events issued by the vertical ruler of a
source viewer. |
| AnnotationColumn.java | Class | |
| AnnotationPainter.java | Class | 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. |
| AnnotationRulerColumn.java | Class | A vertical ruler column showing graphical representations of annotations. |
| ChangeRulerColumn.java | Class | A vertical ruler column displaying line numbers and serving as a UI for quick diff. |
| CompositeRuler.java | Class | Standard implementation of
org.eclipse.jface.text.source.IVerticalRuler .
This ruler does not have a a visual representation of its own. |
| DefaultAnnotationHover.java | Class | Standard implementation of
org.eclipse.jface.text.source.IAnnotationHover . |
| DefaultCharacterPairMatcher.java | Class | A character pair matcher that matches a specified set of character
pairs against each other. |
| IAnnotationAccess.java | Interface | An annotation access provides access to information that is not available via
the API of
org.eclipse.jface.text.source.Annotation . |
| IAnnotationAccessExtension.java | Interface | Extension interface for
org.eclipse.jface.text.source.IAnnotationAccess .
This interface replaces the methods of IAnnotationAccess.
This interface provides
- a label for the annotation type of a given annotation
- the paint layer of a given annotation
- means to paint a given annotation
- information about the type hierarchy of the annotation type of a given annotation
|
| IAnnotationAccessExtension2.java | Interface | Extension interface for
org.eclipse.jface.text.source.IAnnotationAccess .
This interface allows clients to set a quick assist assistant. |
| IAnnotationHover.java | Interface | Provides the information to be displayed in a hover popup window which
appears over the presentation area of annotations.
In order to provide backward compatibility for clients of
IAnnotationHover, extension interfaces are used as a means of
evolution. |
| IAnnotationHoverExtension.java | Interface | |
| IAnnotationHoverExtension2.java | Interface | |
| IAnnotationPresentation.java | Interface | Interface for annotations that can take care of their own visible representation. |
| IChangeRulerColumn.java | Interface | An IChangeRulerColumn can display quick diff information. |
| ICharacterPairMatcher.java | Interface | A character pair matcher finds to a character at a certain document offset
the matching peer character. |
| ILineDiffer.java | Interface | Protocol that allows direct access to line information. |
| ILineDifferExtension.java | Interface | Extension interface for
ILineDiffer .
Introduces the concept of suspending a differ. |
| ILineDifferExtension2.java | Interface | Extension interface for
ILineDiffer . |
| ILineDiffInfo.java | Interface | Describes the change state of one line, which consists of the state of the line itself, which
can be UNCHANGED, CHANGED or ADDED, and the number of
deleted lines before and after this line. |
| ILineRange.java | Interface | Describes a range of lines.
Note that the number of lines is 1-based, e.g. |
| ImageUtilities.java | Class | Provides methods for drawing images onto a canvas. |
| IOverviewRuler.java | Interface | This interface defines a visual component which may serve
text viewers as an overview annotation presentation area. |
| ISharedTextColors.java | Interface | Manages SWT color objects. |
| ISourceViewer.java | Interface | In addition to the text viewer functionality a source viewer supports:
- visual annotations based on an annotation model
- visual range indication
- management of text viewer add-ons
- explicit configuration
It is assumed that range indication and visual annotations are shown inside
the same presentation area. |
| ISourceViewerExtension.java | Interface | Extension interface
org.eclipse.jface.text.source.ISourceViewer .
Extends the source viewer with the concept of an annotation overview. |
| ISourceViewerExtension2.java | Interface | Extension interface for
org.eclipse.jface.text.source.ISourceViewer .
Allows the source viewer to roll back a previous configuration process and allows
clients access to the viewer's visual annotation model. |
| ISourceViewerExtension3.java | Interface | Extension interface for
org.eclipse.jface.text.source.ISourceViewer .
It introduces the concept of a quick assist assistant and provides access
to the quick assist invocation context. |
| IVerticalRuler.java | Interface | This interface defines a visual component which may serve text viewers as an
annotation presentation area. |
| IVerticalRulerColumn.java | Interface | A vertical ruler column is an element that can be added to a composite
vertical ruler (
org.eclipse.jface.text.source.CompositeRuler ). |
| IVerticalRulerExtension.java | Interface | Extension interface for
IVerticalRuler . |
| IVerticalRulerInfo.java | Interface | A vertical ruler is a visual component which may serve text viewers as an
annotation presentation area. |
| IVerticalRulerInfoExtension.java | Interface | Extension interface for
org.eclipse.jface.text.source.IVerticalRulerInfo . |
| IVerticalRulerListener.java | Interface | Interface for listening to annotation related events happening on a vertical ruler. |
| JFaceTextMessages.java | Class | Accessor for the JFaceTextMessages.properties file in
package org.eclipse.jface.text. |
| LineChangeHover.java | Class | A hover for line oriented diffs. |
| LineNumberChangeRulerColumn.java | Class | A vertical ruler column displaying line numbers and serving as a UI for quick diff. |
| LineNumberRulerColumn.java | Class | A vertical ruler column displaying line numbers. |
| LineRange.java | Class | Default implementation of
ILineRange . |
| MatchingCharacterPainter.java | Class | Highlights the peer character matching the character near the caret position. |
| OverviewRuler.java | Class | Ruler presented next to a source viewer showing all annotations of the
viewer's annotation model in a compact format. |
| OverviewRulerHoverManager.java | Class | This manager controls the layout, content, and visibility of an information
control in reaction to mouse hover events issued by the overview ruler of a
source viewer. |
| SourceViewer.java | Class | SWT based implementation of
org.eclipse.jface.text.source.ISourceViewer and its extension
interfaces. |
| SourceViewerConfiguration.java | Class | This class bundles the configuration space of a source viewer. |
| TextInvocationContext.java | Class | Text quick assist invocation context. |
| VerticalRuler.java | Class | A vertical ruler which is connected to a text viewer. |
| VerticalRulerEvent.java | Class | An event sent to
org.eclipse.jface.text.source.IVerticalRulerListener instances when annotation
related event occurs on the vertical ruler. |
| VisualAnnotationModel.java | Class | Annotation model for visual annotations. |