| Home >> All >> org >> eclipse >> jface >> text >> [ source Javadoc ] |
| • | org.eclipse.jface.text.source.projection.* (10) |
• org.eclipse.jface.text.source: Javadoc index of package org.eclipse.jface.text.source.
Package Samples:
• org.eclipse.jface.text.source.projection
Classes:
• IVerticalRuler: This interface defines a visual component which may serve text viewers as an annotation presentation area. Implementers of this interface have to define the presentation modus. This can either depend on the connected viewer's view port or not. If the modus is view port dependent the ruler only shows those annotations that are attached to document regions that are visible in the view port. If independent, the presented annotations can also be attached to invisible document regions. This interfaces comprises three contracts: The vertical ruler retrieves the annotations it presents from an annotation ...
• ISourceViewer: 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. There are no assumptions about whether this area is different from the viewer's text widget. As the visibility of visual annotations can dynamically be changed, it is assumed that the annotation presentation area can dynamically be hidden if it is different from the text widget. In order to provide ...
• IAnnotationModel: This interface defines the model for managing annotations attached to a document. The model maintains a set of annotations for a given document and notifies registered annotation model listeners about annotation model changes. It also provides methods for querying the current position of an annotation managed by this model. In order to provide backward compatibility for clients of IAnnotationModel , extension interfaces are used to provide a means of evolution. The following extension interfaces exist: IAnnotationModelExtension since version 3.0 introducing the concept of model piggybacking annotation ...
• SourceViewer: SWT based implementation of ISourceViewer and its extension interfaces. The same rules apply as for org.eclipse.jface.text.TextViewer . A source viewer uses an IVerticalRuler as its annotation presentation area. The vertical ruler is a small strip shown left of the viewer's text widget. A source viewer uses an IOverviewRuler as its presentation area for the annotation overview. The overview ruler is a small strip shown right of the viewer's text widget. Clients are supposed to instantiate a source viewer and subsequently to communicate with it exclusively using the ISourceViewer interface. Clients ...
• IOverviewRuler: This interface defines a visual component which may serve text viewers as an overview annotation presentation area. This means, presentation of annotations is independent from the actual view port of the text viewer. The annotations of the viewer's whole document are visible in the overview ruler. This interfaces embodies three contracts: The overview ruler retrieves the annotations it presents from an annotation model. The ruler is a visual component which must be integrated in a hierarchy of SWT controls. The ruler provides interested clients with mapping and interaction information. This covers ...
• IAnnotationAccess: An annotation access provides access to information that is not available via the API of Annotation . With version 3.0 all this information is now available from the annotation itself. In order to provide backward compatibility for clients of IAnnotationAccess , extension interfaces are used as a means of evolution. The following extension interfaces exist: IAnnotationAccessExtension since version 3.0 replacing all methods in that interface Clients usually implement this interface and its extension interfaces.
• IVerticalRulerInfo: A vertical ruler is a visual component which may serve text viewers as an annotation presentation area. The vertical ruler info provides interested clients with the mapping and interaction aspect of the vertical ruler. This covers the mapping between coordinates of the ruler's control and line numbers based on the connected text viewer's document. In order to provide backward compatibility for clients of IVerticalRulerInfo , extension interfaces are used as a means of evolution. The following extension interfaces exist: IVerticalRulerInfoExtension since version 3.0 allowing custom annotation hovers ...
• VisualAnnotationModel: Annotation model for visual annotations. Assume a viewer's input element is annotated with some semantic annotation such as a breakpoint and that it is simultaneously shown in multiple viewers. A source viewer, e.g., supports visual range indication for which it utilizes annotations. The range indicating annotation is specific to the visual presentation of the input element in this viewer and thus should only be visible in this viewer. The breakpoints however are independent from the input element's presentation and thus should be shown in all viewers in which the element is shown. As a viewer ...
• IAnnotationHover: 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. The following extension interfaces exist: IAnnotationHoverExtension since version 3.0 allowing a text hover to provide a creator for the hover control. This allows for sophisticated hovers in a way that information computed by the hover can be displayed in the best possible form. Clients may implement this interface.
• IAnnotationMap: An annotation map is a map specialized for the requirements of an annotation model. The annotation map supports a customizable lock object which is used to synchronize concurrent operations on the map (see org.eclipse.jface.text.ISynchronizable . The map supports two iterator methods, one for the values and one for the keys of the map. The returned iterators are robust, i.e. they work on a copy of the values and keys set that is made at the point in time the iterator methods are called. The returned collections of the methods values , entrySet , and keySet are not synchronized on the annotation ...
• ISourceViewerExtension: Extension interface ISourceViewer . Extends the source viewer with the concept of an annotation overview. The annotation overview differs from the annotation presentation in that it is independent from the viewer's view port, i.e. the annotations of the whole document are visible. There are no assumptions about the area in which the annotation overview is shown. As the visibility of annotation overview can dynamically be changed, it is assumed that the presentation area can dynamically be hidden if it is different from the text widget.
• IAnnotationModelListener: Interface for objects interested in getting informed about annotation model changes. Changes are the addition or removal of annotations managed by the model. Clients may implement this interface. In order to provided backward compatibility for clients of IAnnotationModelListener , extension interfaces are used to provide a means of evolution. The following extension interfaces exist: IAnnotationModelListenerExtension since version 2.0 replacing the change notification mechanisms.
• IVerticalRulerInfoExtension: Extension interface for IVerticalRulerInfo . Introduces the ability to define a custom hover to be used when hovering over the vertical ruler described by this info instance, and to specify the annotation model used by it. It also allows client to register as listeners on the represented vertical ruler and sends out notifications similar to selection events such as that a particular annotation presented in the vertical ruler has been selected.
• ICharacterPairMatcher: A character pair matcher finds to a character at a certain document offset the matching peer character. It is the matchers responsibility to define the concepts of "matching" and "peer". The matching process starts at a given offset. Starting of this offset, the matcher chooses a character close to this offset. The anchor defines whether the chosen character is left or right of the initial offset. The matcher then searches for the matching peer character of the chosen character and if it finds one, delivers the minimal region of the document that contains both characters.
• SourceViewerConfiguration: This class bundles the configuration space of a source viewer. Instances of this class are passed to the configure method of ISourceViewer . Each method in this class get as argument the source viewer for which it should provide a particular configuration setting such as a presentation reconciler. Based on its specific knowledge about the returned object, the configuration might share such objects or compute them according to some rules. Clients should subclass and override just those methods which must be specific to their needs.
• AnnotationModel: Standard implementation of IAnnotationModel and its extension interfaces. This class can directly be used by clients. Subclasses may adapt this annotation model to other existing annotation mechanisms. This class also implements org.eclipse.jface.text.ISynchronizable . All modifications of the model's internal annotation map are synchronized using the model's lock object.
• CompositeRuler: Standard implementation of IVerticalRuler . This ruler does not have a a visual representation of its own. The presentation comes from the configurable list of vertical ruler columns. Such columns must implement the IVerticalRulerColumn . interface. Clients may instantiate and configure this class.
• IAnnotationAccessExtension: Extension interface for 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 .
• ProjectionAnnotation: Annotation used to represent the projection of a master document onto a org.eclipse.jface.text.projection.ProjectionDocument . A projection annotation can be either expanded or collapsed. If expanded it corresponds to a segment of the projection document. If collapsed, it represents a region of the master document that does not have a corresponding segment in the projection document. Clients may subclass or use as is.
• IVerticalRulerColumn: A vertical ruler column is an element that can be added to a composite vertical ruler ( CompositeRuler ). A composite vertical ruler is a vertical ruler with dynamically changing appearance and behavior depending on its actual arrangement of ruler columns. A vertical ruler column supports a subset of the contract of a vertical ruler.
• IAnnotationModelListenerExtension: Extension interface for IAnnotationModelListener . Introduces a notification mechanism that notifies the user by means of AnnotationModelEvent s. Thus, more detailed information can be sent to the listener. This mechanism replaces the original notification mechanism of IAnnotationModelListener .
• ILineDiffer: Protocol that allows direct access to line information. Usually, implementations will also implement IAnnotationModel , which only allows Iterator based access to annotations. ILineDiffer also allows to revert any lines to their original contents as defined by the quick diff reference used by the receiver. This interface may be implemented by clients.
• IAnnotationHoverExtension: Extension interface for IAnnotationHover for providing its own information control creator providing the range of lines for which the hover for a given line is valid providing whether the information control can interact with the mouse cursor
• Annotation: Annotation managed by an IAnnotationModel . Annotations are types, associated text, and can be marked as persistent and deleted. Annotations which are not explicitly initialized with an annotation type are of type "org.eclipse.text.annotation.unknown" .
• VerticalRuler: A vertical ruler which is connected to a text viewer. Single column standard implementation of IVerticalRuler . The same can be achieved by using CompositeRuler configured with an AnnotationRulerColumn . Clients may use this class as is.
| Home | Contact Us | Privacy Policy | Terms of Service |