public class CommonSourceNotFoundEditorInput extends PlatformObject implements IEditorInput
CommonSourceNotFoundEditor
. The editor
input can be created on an artifact that has a source association.
This class may be instantiated and subclassed.
CommonSourceNotFoundEditor
Constructor and Description |
---|
CommonSourceNotFoundEditorInput(Object artifact)
Constructs an editor input for the given artifact associated with source.
|
Modifier and Type | Method and Description |
---|---|
boolean |
exists()
Returns whether the editor input exists.
|
Object |
getArtifact()
Returns the artifact that source was not found for.
|
ImageDescriptor |
getImageDescriptor()
Returns the image descriptor for this input.
|
String |
getName()
Returns the name of this editor input for display purposes.
|
IPersistableElement |
getPersistable()
Returns an object that can be used to save the state of this editor
input.
|
String |
getToolTipText()
Returns the tool tip text for this editor input.
|
getAdapter
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAdapter
public CommonSourceNotFoundEditorInput(Object artifact)
artifact
- artifact associated with sourcepublic boolean exists()
IEditorInput
This method is primarily used to determine if an editor input should
appear in the "File Most Recently Used" menu. An editor input will appear
in the list until the return value of exists
becomes
false
or it drops off the bottom of the list.
exists
in interface IEditorInput
true
if the editor input exists;
false
otherwisepublic ImageDescriptor getImageDescriptor()
IEditorInput
Note: although a null return value has never been permitted from this method, there are many known buggy implementations that return null. Clients that need the image for an editor are advised to use IWorkbenchPart.getImage() instead of IEditorInput.getImageDescriptor(), or to recover from a null return value in a manner that records the ID of the problematic editor input. Implementors that have been returning null from this method should pick some other default return value (such as ImageDescriptor.getMissingImageDescriptor()).
getImageDescriptor
in interface IEditorInput
null
if
there is no image.public String getName()
IEditorInput
For instance, when the input is from a file, the return value would ordinarily be just the file name.
getName
in interface IEditorInput
null
;public IPersistableElement getPersistable()
IEditorInput
getPersistable
in interface IEditorInput
null
if this editor
input cannot be persistedpublic String getToolTipText()
IEditorInput
getToolTipText
in interface IEditorInput
null
.public Object getArtifact()
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.