Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package org.eclipse.ui.texteditor

Provides a framework for text editors obeying to the desktop rules.

See:
Description

Interface Summary
IAbstractTextEditorHelpContextIds | Help context ids for the text editor.
IAnnotationImageProvider | Provides an image for a given annotation.
IDocumentProvider | A document provider maps between domain elements and documents.
IDocumentProviderExtension | Extension interface for `IDocumentProvider`.
IDocumentProviderExtension2 | Extension interface for `IDocumentProvider`.
IDocumentProviderExtension3 | Extension interface for `IDocumentProvider`.
IEditorStatusLine | An interface to use the status line of an editor.
IElementStateListener | Interface for parties interested in standardized element changes.
IElementStateListenerExtension | Extension interface for `IElementStateListener`.
IFindReplaceTargetExtension2 | Extension interface for `IFindReplaceTarget`.
IMarkerUpdater | A marker updater is responsible for saving changes to markers.
IReadOnlyDependent | Extension interface for actions.
ISchedulingRuleProvider | A scheduling rule provider provides a scheduling rule which can be used when running operations.
IStatusField | Interface of a status field of a text editor.
IStatusFieldExtension | Extends `IStatusField` with the following concepts: set error text and image set tool tip control visibility
ITextEditor | Interface to a text editor.
ITextEditorActionConstants | Defines the names of those actions which are preregistered with the `AbstractTextEditor`.
ITextEditorActionDefinitionIds | Defines the definitions ids for the text editor actions.
ITextEditorDropTargetListener | Interface to be implemented by SWT drop target listeners to be used with `AbstractTextEditor`.
ITextEditorExtension | Extension interface for `ITextEditor`.
ITextEditorExtension2 | Extension interface for `ITextEditor`.
ITextEditorExtension3 | Extension interface for `ITextEditor`.
IUpdate | Indicates the support of an update method.
IWorkbenchActionDefinitionIds | Defines the definitions ids for workbench actions.

Class Summary
AbstractDecoratedTextEditor | An intermediate editor comprising functionality not present in the leaner `AbstractTextEditor`, but used in many heavy weight (and especially source editing) editors, such as line numbers, change ruler, overview ruler, print margins, current line highlighting, etc.
AbstractDecoratedTextEditorPreferenceConstants | Preference constants used in the extended text editor preference store.
AbstractDocumentProvider | An abstract implementation of a sharable document provider.
AbstractDocumentProvider.DocumentProviderOperation | Operation created by the document provider and to be executed by the providers runnable context.
AbstractMarkerAnnotationModel | Abstract implementation of a marker-based annotation model.
AbstractRulerActionDelegate | This class serves as an adapter for actions contributed to the vertical ruler's context menu.
AbstractTextEditor | Abstract base implementation of a text editor.
AddMarkerAction | Action for creating a marker of a specified type for the editor's input element based on the editor's selection.
AddTaskAction | Creates a new task marker.
AnnotationPreference | An annotation preference provides all the information required for handing the preferences for the presentation of annotations of a specified type.
AnnotationPreferenceLookup | Provides the strategy for finding the annotation preference for a given annotation.
AnnotationTypeLookup | Provides the strategy for determining annotation types for given markers.
BasicMarkerUpdater | Updates a marker's positional attributes which are start position, end position, and line number.
BasicTextEditorActionContributor | Manages the installation and uninstallation of global actions for the same type of editors.
BookmarkRulerAction | Adapter for the managing bookmark action.
CaseAction | Action that converts the current selection to lower case or upper case.
ChainedPreferenceStore | Preference store that composes multiple preference stores in a chain and serves a preference value from the first preference store in the chain that contains the preference.
ConfigurationElementSorter | Allows to sort an array based on their elements' configuration elements according to the prerequisite relation of their defining plug-ins.
ContentAssistAction | A content assist action which gets its target from its text editor.
ConvertLineDelimitersAction | An action to convert line delimiters of a text editor document to a particular line delimiter.
DefaultMarkerAnnotationAccess | Default class for accessing marker annotation properties.
DefaultRangeIndicator | Specialized annotation to indicate a particular range of text lines.
DeleteLineAction | An action to delete a whole line, the fraction of the line that is left from the cursor or the fraction that is right from the cursor.
DocumentProviderRegistry | This registry manages shared document providers.
FindNextAction | An action which finds the next/previous occurrence of the last search or the current selection if present.
FindReplaceAction | An action which opens a Find/Replace dialog.
GotoLineAction | Action for jumping to a particular line if the editor's text viewer.
ImageUtilities | Deprecated. As of 3.0, replaced by `ImageUtilities`
IncrementalFindAction | An action which enters the incremental find mode a la emacs.
InfoForm | Deprecated. since 3.0. there is no replacement, use org.eclipse.ui.forms to define a component with a similar look and function.
InsertLineAction | This action implements smart return.
ITextEditorExtension3.InsertMode | Constitutes entities to enumerate the editor insert modes.
MarkAction | An action to handle emacs-like marked regions.
MarkerAnnotation | Annotation representing a marker on a resource in the workspace.
MarkerAnnotationPreferences | Objects of this class provide access to all extensions declared for the `markerAnnotationSpecification` extension point.
MarkerRulerAction | A ruler action which can add and remove markers which have a visual representation in the ruler.
MarkerRulerInfoAction | Deprecated. use `MarkerRulerAction` instead
MarkerUtilities | Utility class for accessing marker attributes.
MarkRegionTarget | Default implementation of `IMarkRegionTarget` using `ITextViewer` and `IStatusLineManager`.
MoveLinesAction | Action for moving selected lines in an editor.
PropagatingFontFieldEditor | Deprecated. use WorkbenchChainedTextFontFieldEditor
ResourceAction | An action which configures its label, image, tooltip, and description from a resource bundle using known keys.
ResourceMarkerAnnotationModel | A marker annotation model whose underlying source of markers is a resource in the workspace.
ResourceMarkerAnnotationModelFactory | An annotation model factory for resource marker annotation models.
RetargetTextEditorAction | Action used by an editor action bar contributor to establish placeholders in menus or action bars which can be retargeted to dynamically changing actions, for example, those which come from the active editor.
RevertToSavedAction | Action for abandoning changes made in the text editor since the last save operation.
SaveAction | Action for saving recent changes made in the text editor.
SelectAnnotationRulerAction | A ruler action which can select the textual range of an annotation that has a visual representation in a vertical ruler.
SelectMarkerRulerAction | A ruler action which can select the textual range of a marker that has a visual representation in a vertical ruler.
SelectMarkerRulerInfoAction | Deprecated. As of 2.1, replaced by `SelectMarkerRulerAction`
SelectRulerAction | Adapter for the select marker action.
ShiftAction | Action for shifting code to the right or left by one indentation level.
SimpleMarkerAnnotation | An annotation representing a marker.
SourceViewerDecorationSupport | Support class used by text editors to draw and update decorations on the source viewer and its rulers.
StatusLineContributionItem | Contribution item for the status line.
StatusTextEditor | Capable of handling input elements that have an associated status with them.
TaskRulerAction | Adapter for the marker ruler action creating/removing tasks.
TextEditorAction | Skeleton of a standard text editor action.
TextNavigationAction | An `Action` wrapper for text widget navigational and selection actions.
TextOperationAction | An action which gets a text operation target from its text editor.
TextSelectionNavigationLocation | Represents the text selection context marked for the user in the navigation history.
WorkbenchChainedTextFontFieldEditor | Deprecated. since 3.0 not longer in use, no longer supported

Exception Summary
ValidateStateException | Deprecated.

## Package org.eclipse.ui.texteditor Description

Provides a framework for text editors obeying to the desktop rules.

## Package Specification

`ITextEditor` extends `IEditorPart` with text editor specific functionality. Text editors use source viewers (`ISourceViewer`) for displaying and editing the given editor input. In order to translate the editor input into a document and vice versa (e.g., for saving a change), a text editor uses document providers (`IDocumentProvider`). A document provider is responsible not just for providing the document for a given editor input but for the complete translation between the domain model and the editor's internal document-based model. Document provider can be shared between editors.
The package provides a default implementation of `ITextEditor` (`AbstractTextEditor`). This default implementation also covers the editor's complete action management and activation. The package contains a number of configurable and predefined actions. `AbstractMarkerAnnotationModel` establishs a link between text annotations (`Annotation`) and desktop markers (`IMarker`).

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.