public class FileStoreEditorInput extends Object implements IURIEditorInput, IPersistableElement
IFileStore
elements that represent files
that are not part of the current workspace.Constructor and Description |
---|
FileStoreEditorInput(IFileStore fileStore) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
boolean |
exists()
Returns whether the editor input exists.
|
<T> T |
getAdapter(Class<T> adapter)
Returns an object which is an instance of the given class
associated with this object.
|
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.
|
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.
|
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.
|
public FileStoreEditorInput(IFileStore fileStore)
fileStore
- 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 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 <T> T getAdapter(Class<T> adapter)
IAdaptable
null
if
no such object can be found.getAdapter
in interface IAdaptable
adapter
- the adapter class to look upnull
if this object does not
have an adapter for the given classpublic URI getURI()
IURIEditorInput
URI
of the file underlying this editor input.getURI
in interface IURIEditorInput
URI
public String getFactoryId()
IPersistableElement
Factory ids are declared in extensions to the standard extension point
"org.eclipse.ui.elementFactories"
.
getFactoryId
in interface IPersistableElement
IElementFactory
public void saveState(IMemento memento)
IPersistable
saveState
in interface IPersistable
memento
- the storage area for object's state
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.