public interface ITextEditor extends IEditorPart
IEditorPart
as well as the configuration capabilities of a text editor.
Text editors are configured with an IDocumentProvider
which delivers a textual
presentation (IDocument
) of the editor's input. The editor works on the document and
forwards all input element related calls, such as save
, to the document provider.
The provider also delivers the input's annotation model which is used by the editor's vertical
ruler.
Clients may implement this interface from scratch, but the recommended way is to subclass the
abstract base class AbstractTextEditor
.
In order to provided backward compatibility for clients of ITextEditor
, extension
interfaces are used to provide a means of evolution. The following extension interfaces exist:
ITextEditorExtension
since version 2.0 introducing status
fields, read-only state and ruler context menu listeners.ITextEditorExtension2
since version 2.1 introducing
modifiable state for the editor input and validate state handling.ITextEditorExtension3
since version 3.0 adding input state
and change information control.ITextEditorExtension4
since version 3.2 adding annotation
navigation and revision information display.ITextEditorExtension5
since version 3.5 adding block
selection mode.PROP_DIRTY, PROP_INPUT
PROP_TITLE
Modifier and Type | Method and Description |
---|---|
void |
close(boolean save)
Closes this text editor after optionally saving changes.
|
void |
doRevertToSaved()
Abandons all modifications applied to this text editor's input element's
textual presentation since the last save operation.
|
IAction |
getAction(String actionId)
Returns the action installed under the given action id.
|
IDocumentProvider |
getDocumentProvider()
Returns this text editor's document provider.
|
IRegion |
getHighlightRange()
Returns the highlighted range of this text editor.
|
ISelectionProvider |
getSelectionProvider()
Returns this text editor's selection provider.
|
boolean |
isEditable()
Returns whether the text in this text editor can be changed by the user.
|
void |
removeActionActivationCode(String actionId)
Removes any installed activation code for the specified action.
|
void |
resetHighlightRange()
Resets the highlighted range of this text editor.
|
void |
selectAndReveal(int offset,
int length)
Selects and reveals the specified range in this text editor.
|
void |
setAction(String actionID,
IAction action)
Installs the given action under the given action id.
|
void |
setActionActivationCode(String actionId,
char activationCharacter,
int activationKeyCode,
int activationStateMask)
Sets the given activation code for the specified action.
|
void |
setHighlightRange(int offset,
int length,
boolean moveCursor)
Sets the highlighted range of this text editor to the specified region.
|
void |
showHighlightRangeOnly(boolean showHighlightRangeOnly)
Configures this text editor to show only the highlighted range of the
text.
|
boolean |
showsHighlightRangeOnly()
Returns whether this text editor is configured to show only the
highlighted range of the text.
|
getEditorInput, getEditorSite, init
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
getAdapter
doSave, doSaveAs, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded
IDocumentProvider getDocumentProvider()
null
if none, e.g. after closing the editorvoid close(boolean save)
save
- true
if unsaved changed should be saved, and
false
if unsaved changed should be discardedboolean isEditable()
true
if it can be edited, and false
if it is read-onlyvoid doRevertToSaved()
void setAction(String actionID, IAction action)
actionID
- the action idaction
- the action, or null
to clear itgetAction(String)
IAction getAction(String actionId)
actionId
- the action idnull
if nonesetAction(String, IAction)
void setActionActivationCode(String actionId, char activationCharacter, int activationKeyCode, int activationStateMask)
KeyEvent
. If the activation code is triggered
and the associated action is enabled, the action is performed
and the triggering KeyEvent
is considered consumed.
If the action is disabled, the KeyEvent
is passed
on unmodified. Thus, action activation codes and action accelerators
differ in their model of event consumption. The key code parameter
can be -1
to indicate a wild card. The state mask
parameter can be SWT.DEFAULT to indicate a wild card.actionId
- the action idactivationCharacter
- the activation code characteractivationKeyCode
- the activation code key code or -1
for wild cardactivationStateMask
- the activation code state mask or SWT.DEFAULT
for wild cardvoid removeActionActivationCode(String actionId)
actionId
- the action idboolean showsHighlightRangeOnly()
true
if only the highlighted range is shown, and
false
if this editor shows the entire text of the documentshowHighlightRangeOnly(boolean)
void showHighlightRangeOnly(boolean showHighlightRangeOnly)
showHighlightRangeOnly
- true
if only the highlighted
range is shown, and false
if this editor shows the entire
text of the documentshowsHighlightRangeOnly()
void setHighlightRange(int offset, int length, boolean moveCursor)
offset
- the offset of the highlighted rangelength
- the length of the highlighted rangemoveCursor
- true
if the cursor should be moved to the start of the
highlighted range, and false
to leave the cursor unaffected - has no
effect if the range to highlight is already the highlighted onegetHighlightRange()
IRegion getHighlightRange()
setHighlightRange(int, int, boolean)
void resetHighlightRange()
ISelectionProvider getSelectionProvider()
void selectAndReveal(int offset, int length)
offset
- the offset of the selectionlength
- the length of the selection
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.