|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.ui.texteditor.AbstractTextEditor
org.eclipse.ui.texteditor.StatusTextEditor
Capable of handling input elements that have an associated status with them.
Nested Class Summary |
Nested classes inherited from class org.eclipse.ui.texteditor.AbstractTextEditor |
AbstractTextEditor.AbstractSelectionChangedListener, AbstractTextEditor.LineStartAction |
Nested classes inherited from class org.eclipse.ui.texteditor.ITextEditorExtension3 |
ITextEditorExtension3.InsertMode |
Field Summary |
Fields inherited from interface org.eclipse.ui.IEditorPart |
PROP_DIRTY, PROP_INPUT |
Fields inherited from interface org.eclipse.ui.IWorkbenchPart |
PROP_TITLE |
Fields inherited from interface org.eclipse.ui.texteditor.ITextEditorExtension3 |
INSERT, SMART_INSERT |
Constructor Summary | |
StatusTextEditor()
|
Method Summary | |
void |
createPartControl(Composite parent)
The AbstractTextEditor implementation of this
IWorkbenchPart method creates the vertical ruler and
source viewer.
|
protected Control |
createStatusControl(Composite parent,
IStatus status)
Creates the status control for the given status. |
void |
doRevertToSaved()
The AbstractTextEditor implementation of this
ITextEditor method may be extended by subclasses. |
protected void |
doSetInput(IEditorInput input)
Called directly from setInput and from within a workspace
runnable from init , this method does the actual setting
of the editor input. |
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 boolean |
isErrorStatus(IStatus status)
Returns whether the given status indicates an error. |
protected void |
sanityCheckState(IEditorInput input)
Checks the state of the given editor input. |
void |
updatePartControl(IEditorInput input)
Checks if the status of the given input is OK. |
protected void |
updateStatusField(String category)
Updates the status fields for the given category. |
Methods inherited from class org.eclipse.ui.part.EditorPart |
getEditorInput, getEditorSite, getTitleToolTip, setContentDescription, setInitializationData, setPartName |
Methods inherited from class org.eclipse.ui.part.WorkbenchPart |
addPropertyListener, getConfigurationElement, getContentDescription, getDefaultImage, getPartName, getSite, getTitle, getTitleImage, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy |
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 |
public StatusTextEditor()
Method Detail |
public void createPartControl(Composite parent)
AbstractTextEditor
AbstractTextEditor
implementation of this
IWorkbenchPart
method creates the vertical ruler and
source viewer.
Subclasses may extend this method. Besides extending this method, the
behavior of createPartControl
may be customized by
calling, extending or replacing the following methods:
Subclasses may supply customized implementations for some members using
the following methods before createPartControl
is invoked:
createPartControl
:
createPartControl
:
createPartControl
in interface IWorkbenchPart
createPartControl
in class AbstractTextEditor
parent
- the parent compositepublic void updatePartControl(IEditorInput input)
input
- the input whose status is checkedprotected boolean isErrorStatus(IStatus status)
status
- the status to be checked
true
if the status indicates an error, false
otherwise\protected Control createStatusControl(Composite parent, IStatus status)
parent
- the parent controlstatus
- the status
protected String getStatusHeader(IStatus status)
status
- the status whose message is returned
protected String getStatusBanner(IStatus status)
status
- the status whose message is returned
protected String getStatusMessage(IStatus status)
status
- the status whose message is returned
protected void updateStatusField(String category)
AbstractTextEditor
updateStatusField
in class AbstractTextEditor
category
- protected void doSetInput(IEditorInput input) throws CoreException
AbstractTextEditor
setInput
and from within a workspace
runnable from init
, this method does the actual setting
of the editor input. Closes the editor if input
is
null
. Disconnects from any previous editor input and its
document provider and connects to the new one.
Subclasses may extend.
doSetInput
in class AbstractTextEditor
input
- the input to be set
CoreException
- if input cannot be connected to the document
providerpublic void doRevertToSaved()
AbstractTextEditor
AbstractTextEditor
implementation of this
ITextEditor
method may be extended by subclasses.
doRevertToSaved
in interface ITextEditor
doRevertToSaved
in class AbstractTextEditor
protected void sanityCheckState(IEditorInput input)
AbstractTextEditor
sanityCheckState
in class AbstractTextEditor
input
- the editor input whose state is to be checked
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.