Class CommonSourceNotFoundEditor
- All Implemented Interfaces:
IAdaptable,IExecutableExtension,IEditorPart,IReusableEditor,ISaveablePart,IWorkbenchPart,IWorkbenchPart2,IWorkbenchPart3,IWorkbenchPartOrientation
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.
- Since:
- 3.2
- See Also:
-
Field Summary
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUTFields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidCloses this editor.protected voidcreateButtons(Composite parent) Create buttons to be displayed in this editorvoidcreatePartControl(Composite parent) Creates the SWT controls for this workbench part.voiddispose()TheWorkbenchPartimplementation of thisIWorkbenchPartmethod disposes the title image loaded bysetInitializationData.voiddoSave(IProgressMonitor monitor) Saves the contents of this part.voiddoSaveAs()Saves the contents of this part to another object.protected voidEdits the source lookup path associated with the active debug context.protected ObjectReturns the artifact this editor was opened for (i.e. the artifact that source was not found for), ornullprotected StringgetText()Return the text to be displayed in this editor.voidinit(IEditorSite site, IEditorInput input) Initializes this editor with the given editor site and input.protected voidInitialize this editor.booleanisDirty()Returns whether the contents of this part have changed since the last save operation.booleanReturns whether the "Save As" operation is supported by this part.voidsetFocus()Asks this part to take focus within the workbench.voidsetInput(IEditorInput input) Sets the input to this editor.Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInputWithNotify, setPartNameMethods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusyMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.ui.IEditorPart
getEditorInput, getEditorSiteMethods inherited from interface org.eclipse.ui.ISaveablePart
isSaveOnCloseNeededMethods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
-
Constructor Details
-
CommonSourceNotFoundEditor
public CommonSourceNotFoundEditor()
-
-
Method Details
-
doSave
Description copied from interface:ISaveablePartSaves the contents of this part.If the save is successful, the part should fire a property changed event reflecting the new dirty state (
PROP_DIRTYproperty).If the save is cancelled through user action, or for any other reason, the part should invoke
setCancelledon theIProgressMonitorto inform the caller.This method is long-running; progress and cancellation are provided by the given progress monitor.
- Specified by:
doSavein interfaceISaveablePart- Specified by:
doSavein classEditorPart- Parameters:
monitor- the progress monitor
-
doSaveAs
public void doSaveAs()Description copied from interface:ISaveablePartSaves the contents of this part to another object.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
IProgressMonitorshould be used to indicate progress.If the save is successful, the part fires a property changed event reflecting the new dirty state (
PROP_DIRTYproperty).- Specified by:
doSaveAsin interfaceISaveablePart- Specified by:
doSaveAsin classEditorPart
-
init
Description copied from interface:IEditorPartInitializes this editor with the given editor site and input.This method is automatically called shortly after the part is instantiated. It marks the start of the part's lifecycle. The
IWorkbenchPart.disposemethod 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- Specified by:
initin interfaceIEditorPart- Specified by:
initin classEditorPart- Parameters:
site- the editor siteinput- the editor input- Throws:
PartInitException- if this editor was not initialized successfully
-
isDirty
public boolean isDirty()Description copied from interface:ISaveablePartReturns whether the contents of this part have changed since the last save operation. If this value changes the part must fire a property listener event withPROP_DIRTY.Note: this method is called often on a part open or part activation switch, for example by actions to determine their enabled status.
- Specified by:
isDirtyin interfaceISaveablePart- Specified by:
isDirtyin classEditorPart- Returns:
trueif the contents have been modified and need saving, andfalseif they have not changed since the last save
-
isSaveAsAllowed
public boolean isSaveAsAllowed()Description copied from interface:ISaveablePartReturns whether the "Save As" operation is supported by this part.- Specified by:
isSaveAsAllowedin interfaceISaveablePart- Specified by:
isSaveAsAllowedin classEditorPart- Returns:
trueif "Save As" is supported, andfalseif not supported
-
createPartControl
Description copied from interface:IWorkbenchPartCreates the SWT controls for this workbench part.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:
- Create one or more controls within the parent.
- Set the parent layout as needed.
- Register any global actions with the site's
IActionBars. - Register any context menus with the site.
- Register a selection provider with the site, to make it available to the
workbench's
ISelectionService(optional).
- Specified by:
createPartControlin interfaceIWorkbenchPart- Specified by:
createPartControlin classWorkbenchPart- Parameters:
parent- the parent control
-
createButtons
Create buttons to be displayed in this editor- Parameters:
parent- composite to create the buttons in.
-
editSourceLookupPath
protected void editSourceLookupPath()Edits the source lookup path associated with the active debug context. After the path is edited, source lookup is performed again and this editor is closed. -
setFocus
public void setFocus()Description copied from interface:IWorkbenchPartAsks this part to take focus within the workbench. Parts must assign focus to one of the controls contained in the part's parent composite.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.- Specified by:
setFocusin interfaceIWorkbenchPart- Specified by:
setFocusin classWorkbenchPart
-
setInput
Description copied from class:EditorPartSets the input to this editor. This method simply updates the internal member variable.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.
- Specified by:
setInputin interfaceIReusableEditor- Overrides:
setInputin classEditorPart- Parameters:
input- the editor input- See Also:
-
getText
Return the text to be displayed in this editor. The text is reset each time the editor input is set.- Returns:
- the text to be displayed in this editor
-
closeEditor
protected void closeEditor()Closes this editor. -
dispose
public void dispose()Description copied from class:WorkbenchPartTheWorkbenchPartimplementation of thisIWorkbenchPartmethod disposes the title image loaded bysetInitializationData. Subclasses may extend.- Specified by:
disposein interfaceIWorkbenchPart- Overrides:
disposein classWorkbenchPart
-
getArtifact
Returns the artifact this editor was opened for (i.e. the artifact that source was not found for), ornull- Returns:
- artifact with associated source or
null
-
initialize
protected void initialize()Initialize this editor. Called afterinit(IEditorSite, IEditorInput). By default, a launch listener is added to close this editor when the associated launch terminates. Subclasses may override.
-