public class CommonSourceNotFoundEditor extends EditorPart implements IReusableEditor
This editor's id is IDebugUIConstants.ID_COMMON_SOURCE_NOT_FOUND_EDITOR
(value org.eclipse.debug.ui.sourcelookup.CommonSourceNotFoundEditor
).
This class may be instantiated and subclassed.
AbstractSourceLookupDirector
,
CommonSourceNotFoundEditorInput
PROP_DIRTY, PROP_INPUT
PROP_TITLE
Constructor and Description |
---|
CommonSourceNotFoundEditor() |
Modifier and Type | Method and Description |
---|---|
protected void |
closeEditor()
Closes this editor.
|
protected void |
createButtons(Composite parent)
Create buttons to be displayed in this editor
|
void |
createPartControl(Composite parent)
Creates the SWT controls for this workbench part.
|
void |
dispose()
The
WorkbenchPart implementation of this
IWorkbenchPart method disposes the title image
loaded by setInitializationData . |
void |
doSave(IProgressMonitor monitor)
Saves the contents of this part.
|
void |
doSaveAs()
Saves the contents of this part to another object.
|
protected void |
editSourceLookupPath()
Edits the source lookup path associated with the active debug context.
|
protected Object |
getArtifact()
Returns the artifact this editor was opened for (i.e. the artifact that source
was not found for), or
null |
protected String |
getText()
Return the text to be displayed in this editor.
|
void |
init(IEditorSite site,
IEditorInput input)
Initializes this editor with the given editor site and input.
|
protected void |
initialize()
Initialize this editor.
|
boolean |
isDirty()
Returns whether the contents of this part have changed since the last save
operation.
|
boolean |
isSaveAsAllowed()
Returns whether the "Save As" operation is supported by this part.
|
void |
setFocus()
Asks this part to take focus within the workbench.
|
void |
setInput(IEditorInput input)
Sets the input to this editor.
|
checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInputWithNotify, setPartName
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEditorInput, getEditorSite
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
getAdapter
isSaveOnCloseNeeded
public void doSave(IProgressMonitor monitor)
ISaveablePart
If the save is successful, the part should fire a property changed event
reflecting the new dirty state (PROP_DIRTY
property).
If the save is cancelled through user action, or for any other reason, the
part should invoke setCancelled
on the IProgressMonitor
to inform the caller.
This method is long-running; progress and cancellation are provided by the given progress monitor.
doSave
in interface ISaveablePart
doSave
in class EditorPart
monitor
- the progress monitorpublic void doSaveAs()
ISaveablePart
Implementors are expected to open a "Save As" dialog where the user will
be able to select a new name for the contents. After the selection is made,
the contents should be saved to that new name. During this operation a
IProgressMonitor
should be used to indicate progress.
If the save is successful, the part fires a property changed event
reflecting the new dirty state (PROP_DIRTY
property).
doSaveAs
in interface ISaveablePart
doSaveAs
in class EditorPart
public void init(IEditorSite site, IEditorInput input) throws PartInitException
IEditorPart
This method is automatically called shortly after the part is instantiated.
It marks the start of the part's lifecycle. The
IWorkbenchPart.dispose
method will be called
automically at the end of the lifecycle. Clients must not call this method.
Implementors of this method must examine the editor input object type to
determine if it is understood. If not, the implementor must throw
a PartInitException
init
in interface IEditorPart
init
in class EditorPart
site
- the editor siteinput
- the editor inputPartInitException
- if this editor was not initialized successfullypublic boolean isDirty()
ISaveablePart
PROP_DIRTY
.
Note: this method is called often on a part open or part activation switch, for example by actions to determine their enabled status.
isDirty
in interface ISaveablePart
isDirty
in class EditorPart
true
if the contents have been modified and need
saving, and false
if they have not changed since the last
savepublic boolean isSaveAsAllowed()
ISaveablePart
isSaveAsAllowed
in interface ISaveablePart
isSaveAsAllowed
in class EditorPart
true
if "Save As" is supported, and false
if not supportedpublic void createPartControl(Composite parent)
IWorkbenchPart
Clients should not call this method (the workbench calls this method when it needs to, which may be never).
For implementors this is a multi-step process:
IActionBars
.ISelectionService
(optional). createPartControl
in interface IWorkbenchPart
createPartControl
in class WorkbenchPart
parent
- the parent controlprotected void createButtons(Composite parent)
parent
- composite to create the buttons in.protected void editSourceLookupPath()
public void setFocus()
IWorkbenchPart
Clients should not call this method (the workbench calls this method at
appropriate times). To have the workbench activate a part, use
IWorkbenchPage.activate(IWorkbenchPart) instead
.
setFocus
in interface IWorkbenchPart
setFocus
in class WorkbenchPart
public void setInput(IEditorInput input)
EditorPart
Unlike most of the other set methods on this class, this method does not fire a property change. Clients that call this method from a subclass must ensure that they fire an IWorkbenchPartConstants.PROP_INPUT property change after calling this method but before leaving whatever public method they are in. Clients that expose this method as public API must fire the property change within their implementation of setInput.
Note that firing a property change may cause listeners to immediately reach back and call methods on this editor. Care should be taken not to fire the property change until the editor has fully updated its internal state to reflect the new input.
setInput
in interface IReusableEditor
setInput
in class EditorPart
input
- the editor inputEditorPart.setInputWithNotify(IEditorInput)
protected String getText()
protected void closeEditor()
public void dispose()
WorkbenchPart
WorkbenchPart
implementation of this
IWorkbenchPart
method disposes the title image
loaded by setInitializationData
. Subclasses may extend.dispose
in interface IWorkbenchPart
dispose
in class WorkbenchPart
protected Object getArtifact()
null
null
protected void initialize()
init(IEditorSite, IEditorInput)
. By default, a launch
listener is added to close this editor when the associated launch terminates.
Subclasses may override.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.