|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.ide.FileStoreEditorInput
public class FileStoreEditorInput
Implements an IEditorInput instance appropriate for
IFileStore elements that represent files
that are not part of the current workspace.
| Constructor Summary | |
|---|---|
FileStoreEditorInput(IFileStore fileStore)
|
|
| Method Summary | |
|---|---|
boolean |
equals(java.lang.Object o)
|
boolean |
exists()
Returns whether the editor input exists. |
java.lang.Object |
getAdapter(java.lang.Class adapter)
Returns an object which is an instance of the given class associated with this object. |
java.lang.String |
getFactoryId()
Returns the id of the element factory which should be used to re-create this object. |
ImageDescriptor |
getImageDescriptor()
Returns the image descriptor for this input. |
java.lang.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. |
java.lang.String |
getToolTipText()
Returns the tool tip text for this editor input. |
java.net.URI |
getURI()
Returns the URI of the file underlying this editor input. |
int |
hashCode()
|
void |
saveState(IMemento memento)
Saves the state of the object in the given memento. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FileStoreEditorInput(IFileStore fileStore)
fileStore - | 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 java.lang.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 java.lang.String getToolTipText()
IEditorInput
getToolTipText in interface IEditorInputnull.public java.lang.Object getAdapter(java.lang.Class adapter)
IAdaptablenull if
no such object can be found.
getAdapter in interface IAdaptableadapter - the adapter class to look up
null if this object does not
have an adapter for the given classpublic boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic java.net.URI getURI()
IURIEditorInputURI of the file underlying this editor input.
getURI in interface IURIEditorInputURIpublic java.lang.String getFactoryId()
IPersistableElement
Factory ids are declared in extensions to the standard extension point
"org.eclipse.ui.elementFactories".
getFactoryId in interface IPersistableElementIElementFactorypublic void saveState(IMemento memento)
IPersistable
saveState in interface IPersistablememento - the storage area for object's state
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.