public class FileEditorInput extends PlatformObject implements IFileEditorInput, IPathEditorInput, IURIEditorInput, IPersistableElement
This class may be instantiated; it is not intended to be subclassed.
Constructor and Description |
---|
FileEditorInput(IFile file)
Creates an editor input based of the given file resource.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
boolean |
exists()
Returns whether the editor input exists.
|
Object |
getAdapter(Class 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.
|
IFile |
getFile()
Returns the file resource underlying this editor input.
|
ImageDescriptor |
getImageDescriptor()
Returns the image descriptor for this input.
|
String |
getName()
Returns the name of this editor input for display purposes.
|
IPath |
getPath()
Returns the local file system path of the file underlying this editor input.
|
IPersistableElement |
getPersistable()
Returns an object that can be used to save the state of this editor
input.
|
IStorage |
getStorage()
Returns the underlying IStorage object.
|
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() |
static boolean |
isLocalFile(IFile file)
Return whether or not file is local.
|
void |
saveState(IMemento memento)
Saves the state of the object in the given memento.
|
String |
toString() |
public FileEditorInput(IFile file)
file
- the file resourcepublic static boolean isLocalFile(IFile file)
IFile
s with a local
value should call IPathEditorInput.getPath()
file
- true
if the file has a local implementation.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 String getFactoryId()
IPersistableElement
Factory ids are declared in extensions to the standard extension point
"org.eclipse.ui.elementFactories"
.
getFactoryId
in interface IPersistableElement
IElementFactory
public IFile getFile()
IFileEditorInput
The IFile
returned can be a handle to a resource
that does not exist in the workspace. As such, an editor should
provide appropriate feedback to the user instead of simply failing
during input validation. For example, a text editor could open
in read-only mode with a message in the text area to inform the
user that the file does not exist.
getFile
in interface IFileEditorInput
public 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 IStorage getStorage()
IStorageEditorInput
getStorage
in interface IStorageEditorInput
public String getToolTipText()
IEditorInput
getToolTipText
in interface IEditorInput
null
.public void saveState(IMemento memento)
IPersistable
saveState
in interface IPersistable
memento
- the storage area for object's statepublic URI getURI()
IURIEditorInput
URI
of the file underlying this editor input.getURI
in interface IURIEditorInput
URI
public IPath getPath()
IPathEditorInput
getPath
in interface IPathEditorInput
public Object getAdapter(Class adapter)
PlatformObject
null
if
no such object can be found.
This implementation of the method declared by IAdaptable
passes the request along to the platform's adapter manager; roughly
Platform.getAdapterManager().getAdapter(this, adapter)
.
Subclasses may override this method (however, if they do so, they
should invoke the method on their superclass to ensure that the
Platform's adapter manager is consulted).
getAdapter
in interface IAdaptable
getAdapter
in class PlatformObject
adapter
- the class to adapt tonull
IAdaptable.getAdapter(Class)
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.