| org.eclipse.jface.text |
Package-level Javadoc
Provides a framework for editing text documents.
Package Specification
The packages defines and implements a viewer for text documents.
ITextViewer defines the concept of a document based, editiable viewer.
ITextViewer offers the following functionality:
-
present a document
-
event consumption (IEventConsumer)
-
viewport tracking and notification (IIViewportListener)
-
change notification (ITextListener, ITextInputListener)
-
listeners (combined view/model notification, input document)
-
standard text editing functions plus text hover support
-
visual region support
An ITextViewer supports the following plugins
-
IUndoManager for the undo/redo mechanism
-
IDoubleClickStrategy for partition type specific behavior on mouse
double click
-
IAutoIndentStrategy for content type specific behavior on
inserting a line break
-
ITextHover for content type specific behavior when overing over
text
The package provides default implementations for all these interfaces.
|
| Java Source File Name | Type | Comment |
| AbstractHoverInformationControlManager.java | Class | An information control manager that shows information in response to mouse
hover events. |
| AbstractInformationControlManager.java | Class | Manages the life cycle, visibility, layout, and contents of an
org.eclipse.jface.text.IInformationControl . |
| AbstractReusableInformationControlCreator.java | Class | Abstract class for a reusable information control creators. |
| CursorLinePainter.java | Class | A painter the draws the background of the caret line in a configured color. |
| DefaultAutoIndentStrategy.java | Class | Default implementation of
org.eclipse.jface.text.IAutoIndentStrategy . |
| DefaultDocumentAdapter.java | Class | Default implementation of
org.eclipse.jface.text.IDocumentAdapter . |
| DefaultIndentLineAutoEditStrategy.java | Class | This strategy always copies the indentation of the previous line. |
| DefaultInformationControl.java | Class | Default implementation of
org.eclipse.jface.text.IInformationControl .
Displays textual information in a
org.eclipse.swt.custom.StyledText widget. |
| DefaultTextDoubleClickStrategy.java | Class | Standard implementation of
org.eclipse.jface.text.ITextDoubleClickStrategy . |
| DefaultTextHover.java | Class | Standard implementation of
org.eclipse.jface.text.ITextHover . |
| DefaultUndoManager.java | Class | Standard implementation of
org.eclipse.jface.text.IUndoManager .
It registers with the connected text viewer as text input listener and
document listener and logs all changes. |
| DocumentClone.java | Class | An
org.eclipse.jface.text.IDocument that is a read-only clone of another document. |
| DocumentCommand.java | Class | Represents a text modification as a document replace command. |
| IAutoEditStrategy.java | Interface | An auto edit strategy can adapt changes that will be applied to
a text viewer's document. |
| IAutoIndentStrategy.java | Interface | Exists for backward compatibility. |
| IDocumentAdapter.java | Interface | Adapts an
org.eclipse.jface.text.IDocument to the
org.eclipse.swt.custom.StyledTextContent interface. |
| IDocumentAdapterExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IDocumentAdapter .
Introduces the concepts of batching a series of document changes into a
single styled text content change notification. |
| IEditingSupport.java | Interface | Implemented by tools supporting the editing process.
Clients may ask an IEditingSupport whether it is currently
displaying a shell that has focus, and whether it is the origin of a document
event. |
| IEditingSupportRegistry.java | Interface | A registry for IEditingSupports. |
| IEventConsumer.java | Interface | Implementers can register with a text viewer and receive
VerifyEvents before the text viewer they are registered with.
If the event consumer marks events as processed by turning their
doit field to false the text viewer
subsequently ignores them.
Clients may implement this interface.
org.eclipse.jface.text.ITextViewerExtension2 allows clients to manage
the
org.eclipse.swt.events.VerifyListener s of a text viewer. |
| IFindReplaceTarget.java | Interface | Defines the target for finding and replacing strings.
The two main methods are findAndSelect and
replaceSelection. |
| IFindReplaceTargetExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IFindReplaceTarget . |
| IFindReplaceTargetExtension3.java | Interface | Extension interface for
org.eclipse.jface.text.IFindReplaceTarget . |
| IInformationControl.java | Interface | Interface of a control presenting information. |
| IInformationControlCreator.java | Interface | Interface of a factory for information controls (
org.eclipse.jface.text.IInformationControl ).
In order to provide backward compatibility for clients of
IInformationControlCreator, extension interfaces are used as
a means of evolution. |
| IInformationControlCreatorExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IInformationControlCreator
Introduces tests whether information controls can be reused and whether information
control creators can replace each other. |
| IInformationControlExtension.java | Interface | Extension interface
org.eclipse.jface.text.IInformationControl . |
| IInformationControlExtension2.java | Interface | Extension interface for
org.eclipse.jface.text.IInformationControl .
Replaces the concept of textual information to be displayed with the more
general concept of an input of the information control. |
| IInformationControlExtension3.java | Interface | Extension interface for
org.eclipse.jface.text.IInformationControl . |
| IInformationControlExtension4.java | Interface | Extension interface for
org.eclipse.jface.text.IInformationControl . |
| IMarkRegionTarget.java | Interface | A mark region target to support marked regions as found in emacs. |
| IMarkSelection.java | Interface | A mark selection. |
| IPainter.java | Interface | A painter is responsible for creating, managing, updating, and removing
visual decorations on an ITextViewer's text widget. |
| IPaintPositionManager.java | Interface | Manages and updates positions used by
IPainter s. |
| IRewriteTarget.java | Interface | A target publishing the required functions to modify a document that is displayed
in a text viewer. |
| ISelectionValidator.java | Interface | A selection validator allows clients to test whether the selection they
received during selection changed notification is valid. |
| ITextDoubleClickStrategy.java | Interface | A text double click strategy defines the reaction of a text viewer to mouse
double click events. |
| ITextHover.java | Interface | Computes the information to be shown in a hover popup which appears on top of
the text viewer's text widget when a hover event occurs. |
| ITextHoverExtension.java | Interface | Extension interface for
org.eclipse.jface.text.ITextHover . |
| ITextInputListener.java | Interface | Text input listeners registered with an
org.eclipse.jface.text.ITextViewer are informed if the document
serving as the text viewer's model is replaced. |
| ITextListener.java | Interface | Text listeners registered with a text viewer are informed about all
modifications of an
org.eclipse.jface.text.ITextViewer by means of
text events. |
| ITextOperationTarget.java | Interface | Defines the target for text operations. |
| ITextOperationTargetExtension.java | Interface | Extension interface for
org.eclipse.jface.text.ITextOperationTarget . |
| ITextPresentationListener.java | Interface | Text presentation listeners registered with an
org.eclipse.jface.text.ITextViewer are informed when a
org.eclipse.jface.text.TextPresentation is about to be applied to the
text viewer. |
| ITextSelection.java | Interface | This interface represents a textual selection. |
| ITextViewer.java | Interface | A text viewer connects a text widget with an
org.eclipse.jface.text.IDocument . |
| ITextViewerExtension.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer .
This extension interface replaces the event consumer mechanism (
org.eclipse.jface.text.ITextViewer.setEventConsumer(IEventConsumer) )
with a set of methods that allow to manage a sequence of
org.eclipse.swt.custom.VerifyKeyListener objects. |
| ITextViewerExtension2.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer .
It provides
- text presentation invalidation enhancements
- text hover management enhancements
- a replacement for auto indent strategies
- support for custom painters
It extends the means for text presentation invalidation by allowing a
specific region of the presentation to get invalidated. |
| ITextViewerExtension3.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer . |
| ITextViewerExtension4.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer .
Introduces the concept of text presentation listeners and improves focus
handling among widget token keepers.
A
org.eclipse.jface.text.ITextPresentationListener is a listener that
is informed by the viewer that a text presentation is about to be applied.
During this callback the listener is allowed to modify the presentation. |
| ITextViewerExtension5.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer . |
| ITextViewerExtension6.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer . |
| ITextViewerExtension7.java | Interface | Extension interface for
org.eclipse.jface.text.ITextViewer . |
| IUndoManager.java | Interface | An undo manager is connected to at most one
org.eclipse.jface.text.ITextViewer .
It monitors the text viewer and keeps a history of the changes applied to the
viewer. |
| IUndoManagerExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IUndoManager . |
| IViewportListener.java | Interface | Registered with a text viewer, view port listeners are informed about changes
of a text viewer's view port. |
| IWidgetTokenKeeper.java | Interface | A widget token keeper may require a widget token from an
org.eclipse.jface.text.IWidgetTokenOwner and release the token to the
owner after usage. |
| IWidgetTokenKeeperExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IWidgetTokenKeeper .
Replaces the original requestWidgetToken functionality with a
new priority based approach. |
| IWidgetTokenOwner.java | Interface | In order to display information in a temporary window, a widget token must be
acquired. |
| IWidgetTokenOwnerExtension.java | Interface | Extension interface for
org.eclipse.jface.text.IWidgetTokenOwner . |
| JFaceTextMessages.java | Class | |
| JFaceTextUtil.java | Class | A collection of JFace Text functions. |
| MarginPainter.java | Class | Paints a vertical line (margin line) after a given column respecting the text
viewer's font. |
| MarkSelection.java | Class | Default implementation of
org.eclipse.jface.text.IMarkSelection . |
| PaintManager.java | Class | Manages the
org.eclipse.jface.text.IPainter object registered with an
org.eclipse.jface.text.ITextViewer . |
| PropagatingFontFieldEditor.java | Class | This font field editor implements chaining between a source preference
store and a target preference store. |
| TabsToSpacesConverter.java | Class | Auto edit strategy that converts tabs into spaces. |
| TextAttribute.java | Class | Description of textual attributes such as color and style. |
| TextEvent.java | Class | This event is sent to implementers of
org.eclipse.jface.text.ITextListener . |
| TextPresentation.java | Class | Describes the presentation styles for a section of an indexed text such as a
document or string. |
| TextSelection.java | Class | Standard implementation of
org.eclipse.jface.text.ITextSelection .
Makes advantage of the weak contract of correctness of its interface. |
| TextViewer.java | Class | SWT based implementation of
ITextViewer and its extension interfaces.
Once the viewer and its SWT control have been created the viewer can only
indirectly be disposed by disposing its SWT control.
Clients are supposed to instantiate a text viewer and subsequently to
communicate with it exclusively using the
org.eclipse.jface.text.ITextViewer interface or any of the
implemented extension interfaces.
A text viewer serves as text operation target. |
| TextViewerHoverManager.java | Class | This manager controls the layout, content, and visibility of an information
control in reaction to mouse hover events issued by the text widget of a
text viewer. |
| TextViewerUndoManager.java | Class | Implementation of
org.eclipse.jface.text.IUndoManager using the shared
shared document undo manager.
It registers with the connected text viewer as text input listener, and obtains
its undo manager from the current document. |
| WhitespaceCharacterPainter.java | Class | A painter for drawing visible characters for (invisible) whitespace
characters. |