|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.ui.part.FileEditorInput
Adapter for making a file resource a suitable input for an editor.
This class may be instantiated; it is not intended to be subclassed.
Constructor Summary | |
FileEditorInput(IFile file)
Creates an editor input based of the given file resource. |
Method Summary | |
boolean |
equals(Object obj)
The FileEditorInput implementation of this Object
method bases the equality of two FileEditorInput objects on the
equality of their underlying IFile resources. |
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. |
IPersistableElement |
getPersistable()
|
IStorage |
getStorage()
Returns the underlying IStorage object. |
String |
getToolTipText()
Returns the tool tip text for 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 FileEditorInput(IFile file)
file
- the file resourceMethod Detail |
public boolean equals(Object obj)
FileEditorInput
implementation of this Object
method bases the equality of two FileEditorInput
objects on the
equality of their underlying IFile
resources.
equals
in class Object
public boolean exists()
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 Object getAdapter(Class adapter)
IAdaptable
null
if
no such object can be found.
getAdapter
in interface IAdaptable
adapter
- the adapter class to look up
null
if this object does not
have an adapter for the given classpublic 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
getFile
in interface IFileEditorInput
public ImageDescriptor getImageDescriptor()
IEditorInput
getImageDescriptor
in interface IEditorInput
public String getName()
IEditorInput
For instance, if the fully qualified input name is
"a\b\MyFile.gif"
, the return value would be just
"MyFile.gif"
.
getName
in interface IEditorInput
public IPersistableElement getPersistable()
getPersistable
in interface IEditorInput
public IStorage getStorage() throws CoreException
IStorageEditorInput
getStorage
in interface IStorageEditorInput
CoreException
- if this method failspublic String getToolTipText()
IEditorInput
The format of the path will vary with each input type. For instance,
if the editor input is of type IFileEditorInput
this method
should return the fully qualified resource path. For editor input of
other types it may be different.
getToolTipText
in interface IEditorInput
public int hashCode()
hashCode
in class Object
public void saveState(IMemento memento)
IPersistableElement
saveState
in interface IPersistableElement
memento
- the storage area for object's state
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |