|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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)
|
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. |
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 int hashCode()
public boolean equals(Object obj)
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 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
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
getImageDescriptor
in interface IEditorInput
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
public IPersistableElement getPersistable()
IEditorInput
getPersistable
in interface IEditorInput
null
if this editor input
cannot be persistedpublic IStorage getStorage() throws CoreException
IStorageEditorInput
getStorage
in interface IStorageEditorInput
CoreException
- if this method failspublic String getToolTipText()
IEditorInput
getToolTipText
in interface IEditorInput
public void saveState(IMemento memento)
IPersistableElement
saveState
in interface IPersistableElement
memento
- the storage area for object's statepublic IPath getPath()
IPathEditorInput
getPath
in interface IPathEditorInput
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.