org.eclipse.ui.editors.text
Class TextEditor

java.lang.Object
  |
  +--org.eclipse.ui.part.WorkbenchPart
        |
        +--org.eclipse.ui.part.EditorPart
              |
              +--org.eclipse.ui.texteditor.AbstractTextEditor
                    |
                    +--org.eclipse.ui.texteditor.StatusTextEditor
                          |
                          +--org.eclipse.ui.editors.text.TextEditor

All Implemented Interfaces:

IAdaptable, IEditorPart, IExecutableExtension, IReusableEditor, ITextEditor, ITextEditorExtension, IWorkbenchPart

public class TextEditor

extends StatusTextEditor

The standard text editor for file resources (IFile).

This editor has id "com.ibm.eclipse.ui.DefaultTextEditor". The editor's context menu has id #TextEditorContext. The editor's ruler context menu has id #TextRulerContext.

The workbench will automatically instantiate this class when the default editor is needed for a workbench window.

Field Summary

Fields inherited from class org.eclipse.ui.texteditor.AbstractTextEditor

ACTION_MAP, DEFAULT_EDITOR_CONTEXT_MENU_ID, DEFAULT_RULER_CONTEXT_MENU_ID, fErrorLabel, PREFERENCE_COLOR_BACKGROUND, PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, PREFERENCE_COLOR_FIND_SCOPE, PREFERENCE_COLOR_FOREGROUND, PREFERENCE_COLOR_FOREGROUND_SYSTEM_DEFAULT, PREFERENCE_FONT, VERTICAL_RULER_WIDTH

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

TextEditor()
Creates a new text editor.

Method Summary

protected void	createActions() Creates this editor's standard actions and connects them with the global workbench actions.
void	dispose() The AbstractTextEditor implementation of this IWorkbenchPart method may be extended by subclasses.
protected void	doSetInput(IEditorInput input) Internal setInput method.
protected void	editorContextMenuAboutToShow(IMenuManager menu) Sets up this editor's context menu before it is made visible.
Object	getAdapter(Class adapter) Returns an object which is an instance of the given class associated with this object.
protected String	getStatusBanner(IStatus status) Returns a banner for the given status.
protected String	getStatusHeader(IStatus status) Returns a header for the given status
protected String	getStatusMessage(IStatus status) Returns a message for the given status.
protected void	initializeEditor() Initializes this editor.
boolean	isSaveAsAllowed() The AbstractTextEditor implementation of this IEditorPart method returns false.
protected void	performSaveAs(IProgressMonitor progressMonitor) The TextEditor implementation of this AbstractTextEditor method asks the user for the workspace path of a file resource and saves the document there.
protected void	updatePropertyDependentActions() Updates all property dependent actions.

Methods inherited from class org.eclipse.ui.texteditor.StatusTextEditor

createPartControl, createStatusControl, doRevertToSaved, sanityCheckState, updatePartControl, updateStatusField

Methods inherited from class org.eclipse.ui.texteditor.AbstractTextEditor

addAction, addAction, addGroup, addRulerContextMenuListener, adjustHighlightRange, affectsTextPresentation, canHandleMove, close, createNavigationActions, createSaveOperation, createSourceViewer, createVerticalRuler, doSave, doSaveAs, enableSanityChecking, firePropertyChange, getAction, getContextMenuListener, getCursorListener, getCursorPosition, getDocumentProvider, getEditorContextMenuId, getHelpContextId, getHighlightRange, getPreferenceStore, getRangeIndicator, getRulerContextMenuId, getRulerMouseListener, getSelectionChangedListener, getSelectionProvider, getSourceViewer, getSourceViewerConfiguration, getStatusField, getVerticalRuler, gotoMarker, handleCursorPositionChanged, handleEditorInputChanged, handleExceptionOnSave, handleInsertModeChanged, handlePreferenceStoreChanged, init, isDirty, isEditable, isEditorInputReadOnly, isInInsertMode, isSaveOnCloseNeeded, markAsContentDependentAction, markAsPropertyDependentAction, markAsSelectionDependentAction, markAsStateDependentAction, performSaveOperation, rememberSelection, removeActionActivationCode, removeRulerContextMenuListener, resetHighlightRange, restoreSelection, rulerContextMenuAboutToShow, safelySanityCheckState, selectAndReveal, setAction, setActionActivationCode, setCompatibilityMode, setDocumentProvider, setEditorContextMenuId, setFocus, setHelpContextId, setHighlightRange, setInput, setPreferenceStore, setRangeIndicator, setRulerContextMenuId, setSourceViewerConfiguration, setStatusField, showHighlightRangeOnly, showsHighlightRangeOnly, updateContentDependentActions, updateSelectionDependentActions, updateState, updateStateDependentActions, updateStatusFields, validateState

Methods inherited from class org.eclipse.ui.part.EditorPart

getEditorInput, getEditorSite, getTitleToolTip

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPropertyListener, getConfigurationElement, getDefaultImage, getSite, getTitle, getTitleImage, removePropertyListener, setInitializationData, setSite, setTitle, setTitleImage, setTitleToolTip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IEditorPart

getEditorInput, getEditorSite

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Constructor Detail

TextEditor

public TextEditor()

Creates a new text editor.

Method Detail

initializeEditor

protected void initializeEditor()

Initializes this editor.

dispose

public void dispose()

Description copied from class: AbstractTextEditor

The AbstractTextEditor implementation of this IWorkbenchPart method may be extended by subclasses. Subclasses must call super.dispose().

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class AbstractTextEditor

performSaveAs

protected void performSaveAs(IProgressMonitor progressMonitor)

The TextEditor implementation of this AbstractTextEditor method asks the user for the workspace path of a file resource and saves the document there.

Overrides:

performSaveAs in class AbstractTextEditor

Parameters:

progressMonitor - the progress monitor to be used

isSaveAsAllowed

public boolean isSaveAsAllowed()

Description copied from class: AbstractTextEditor

The AbstractTextEditor implementation of this IEditorPart method returns false. Subclasses may override.

Specified by:

isSaveAsAllowed in interface IEditorPart

Overrides:

isSaveAsAllowed in class AbstractTextEditor

Returns:

true if "save as" is supported, and false if "save as" is not supported

createActions

protected void createActions()

Description copied from class: AbstractTextEditor

Creates this editor's standard actions and connects them with the global workbench actions.

Subclasses may extend.

Overrides:

createActions in class AbstractTextEditor

getStatusHeader

protected String getStatusHeader(IStatus status)

Description copied from class: StatusTextEditor

Returns a header for the given status

Overrides:

getStatusHeader in class StatusTextEditor

Parameters:

status - the status whose message is returned

Returns:

a header for the given status

getStatusBanner

protected String getStatusBanner(IStatus status)

Description copied from class: StatusTextEditor

Returns a banner for the given status.

Overrides:

getStatusBanner in class StatusTextEditor

Parameters:

status - the status whose message is returned

Returns:

a banner for the given status

getStatusMessage

protected String getStatusMessage(IStatus status)

Description copied from class: StatusTextEditor

Returns a message for the given status.

Overrides:

getStatusMessage in class StatusTextEditor

Parameters:

status - the status whose message is returned

Returns:

a message for the given status

doSetInput

protected void doSetInput(IEditorInput input)
                   throws CoreException

Description copied from class: AbstractTextEditor

Internal setInput method.

Overrides:

doSetInput in class StatusTextEditor

Parameters:

input - the input to be set

Throws:

CoreException - if input cannot be connected to the document provider

getAdapter

public Object getAdapter(Class adapter)

Description copied from interface: IAdaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface IAdaptable

Overrides:

getAdapter in class AbstractTextEditor

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

editorContextMenuAboutToShow

protected void editorContextMenuAboutToShow(IMenuManager menu)

Description copied from class: AbstractTextEditor

Sets up this editor's context menu before it is made visible.

Subclasses may extend to add other actions.

Overrides:

editorContextMenuAboutToShow in class AbstractTextEditor

Parameters:

menu - the menu

updatePropertyDependentActions

protected void updatePropertyDependentActions()

Description copied from class: AbstractTextEditor

Updates all property dependent actions.

Overrides:

updatePropertyDependentActions in class AbstractTextEditor