|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.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.ColumnSupport, AbstractTextEditor.IdMapEntry, AbstractTextEditor.LineEndAction, AbstractTextEditor.LineStartAction, AbstractTextEditor.TextEditorSavable |
| 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 void |
handleEditorInputChanged()
Handles an external change of the editor's input element. |
protected void |
handleElementContentReplaced()
Performs any additional action necessary to perform after the input document's content has been replaced. |
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. |
boolean |
validateEditorInputState()
Validates the state of the given editor input. |
| Methods inherited from class org.eclipse.ui.part.EditorPart |
|---|
checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setPartName |
| Methods inherited from class org.eclipse.ui.part.WorkbenchPart |
|---|
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| 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 |
| Methods inherited from interface org.eclipse.ui.ISaveablePart |
|---|
isSaveOnCloseNeeded |
| Constructor Detail |
public StatusTextEditor()
| Method Detail |
public void createPartControl(Composite parent)
AbstractTextEditorAbstractTextEditor 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 IWorkbenchPartcreatePartControl in class AbstractTextEditorparent - the parent compositepublic void updatePartControl(IEditorInput input)
input - the input whose status is checkedpublic boolean validateEditorInputState()
ITextEditorExtension2
validateEditorInputState in interface ITextEditorExtension2validateEditorInputState in class AbstractTextEditorprotected 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 AbstractTextEditorcategory -
protected void doSetInput(IEditorInput input)
throws CoreException
AbstractTextEditorsetInput 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 AbstractTextEditorinput - the input to be set
CoreException - if input cannot be connected to the document
providerpublic void doRevertToSaved()
AbstractTextEditorAbstractTextEditor implementation of this
ITextEditor method may be extended by subclasses.
doRevertToSaved in interface ITextEditordoRevertToSaved in class AbstractTextEditorprotected void sanityCheckState(IEditorInput input)
AbstractTextEditor
sanityCheckState in class AbstractTextEditorinput - the editor input whose state is to be checkedprotected void handleEditorInputChanged()
AbstractTextEditor
handleEditorInputChanged in class AbstractTextEditorprotected void handleElementContentReplaced()
AbstractTextEditorClients may extended this method.
handleElementContentReplaced in class AbstractTextEditor
|
Eclipse Platform Release 3.3 |
|||||||||||
| 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, 2007. All rights reserved.