|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.debug.ui.sourcelookup.CommonSourceNotFoundEditorInput
public class CommonSourceNotFoundEditorInput
Editor input for the CommonSourceNotFoundEditor. The editor
input can be created on an artifact that has a source association.
This class may be instantiated and subclassed.
CommonSourceNotFoundEditor| Constructor Summary | |
|---|---|
CommonSourceNotFoundEditorInput(Object artifact)
Constructs an editor input for the given artifact associated with source. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.eclipse.core.runtime.PlatformObject |
|---|
getAdapter |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Constructor Detail |
|---|
public CommonSourceNotFoundEditorInput(Object artifact)
artifact - artifact associated with source| Method Detail |
|---|
public 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 IEditorInputtrue if the editor input exists;
false otherwisepublic ImageDescriptor getImageDescriptor()
IEditorInputNote: 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 IEditorInputnull if
there is no image.public String getName()
IEditorInputFor instance, when the input is from a file, the return value would ordinarily be just the file name.
getName in interface IEditorInputnull;public IPersistableElement getPersistable()
IEditorInput
getPersistable in interface IEditorInputnull if this editor
input cannot be persistedpublic String getToolTipText()
IEditorInput
getToolTipText in interface IEditorInputnull.public Object getArtifact()
|
Eclipse Platform Release 3.2 |
|||||||||
| 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, 2006. All rights reserved.