Eclipse Platform
2.0

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.
IDocumentProvider A document provider maps between domain elements and documents.
IDocumentProviderExtension Extension interface for IDocumentProvider.
IElementStateListener Interface for parties interested in standardized element changes.
IElementStateListenerExtension Extension interface for IElementStateListener.
IMarkerUpdater A marker updater is responsible for saving changes to markers.
IReadOnlyDependent Extension interface for actions.
IStatusField Interface of a status field of a text editor.
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.
ITextEditorExtension Extension interface for ITextEditor.
IUpdate Indicates the support of an update method.
IWorkbenchActionDefinitionIds Defines the definitions ids for workbench actions.
 

Class Summary
AbstractDocumentProvider An abstract implementation of a shareable document provider.
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.
BasicMarkerUpdater Updates a marker's positional attributes which are start position, end position, and line number.
BasicTextEditorActionContributor Manages the installation and deinstallation of global actions for the same type of editors.
BookmarkRulerAction Adapter for the managing bookmark action.
ContentAssistAction A content asisst 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.
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 shareable document provider.
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.
IncrementalFindAction An action which enters the incremental find mode a la emacs.
InfoForm A form consisting of a title, a banner, and a info text.
MarkAction An action to handle emacs-like marked regions.
MarkerAnnotation Annotation representing a marker on a resource in the workspace.
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.
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.
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.
SelectMarkerRulerAction A ruler action which can select the textual range of a marker that has a visual representation in the vertical ruler.
SelectMarkerRulerInfoAction Deprecated. use SelectMarkerRulerAction instead
SelectRulerAction Adapter for the select marker action.
ShiftAction Action for shifting code to the right or left by one indentation level.
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 Sekelleton of a standard text editor action.
TextNavigationAction An IAction wrapper for text widget navigational and selection actions.
TextOperationAction An action which gets a text operation target from its text editor.
WorkbenchChainedTextFontFieldEditor This font field editor implements chaining between the workbench's preference store and a given target preference store.
 

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).


Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.