Class FileStoreEditorInput
- java.lang.Object
-
- org.eclipse.ui.ide.FileStoreEditorInput
-
- All Implemented Interfaces:
IAdaptable,IEditorInput,IPersistable,IPersistableElement,IURIEditorInput
public class FileStoreEditorInput extends Object implements IURIEditorInput, IPersistableElement
Implements an IEditorInput instance appropriate forIFileStoreelements that represent files that are not part of the current workspace.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description FileStoreEditorInput(IFileStore fileStore)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)booleanexists()Returns whether the editor input exists.<T> TgetAdapter(Class<T> adapter)Returns an object which is an instance of the given class associated with this object.StringgetFactoryId()Returns the id of the element factory which should be used to re-create this object.ImageDescriptorgetImageDescriptor()Returns the image descriptor for this input.StringgetName()Returns the name of this editor input for display purposes.IPersistableElementgetPersistable()Returns an object that can be used to save the state of this editor input.StringgetToolTipText()Returns the tool tip text for this editor input.URIgetURI()Returns theURIof the file underlying this editor input.inthashCode()voidsaveState(IMemento memento)Saves the state of the object in the given memento.
-
-
-
Constructor Detail
-
FileStoreEditorInput
public FileStoreEditorInput(IFileStore fileStore)
- Parameters:
fileStore-
-
-
Method Detail
-
exists
public boolean exists()
Description copied from interface:IEditorInputReturns whether the editor input 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
existsbecomesfalseor it drops off the bottom of the list.- Specified by:
existsin interfaceIEditorInput- Returns:
trueif the editor input exists;falseotherwise
-
getImageDescriptor
public ImageDescriptor getImageDescriptor()
Description copied from interface:IEditorInputReturns the image descriptor for this input.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()).
- Specified by:
getImageDescriptorin interfaceIEditorInput- Returns:
- the image descriptor for this input; may be
nullif there is no image.
-
getName
public String getName()
Description copied from interface:IEditorInputReturns the name of this editor input for display purposes.For instance, when the input is from a file, the return value would ordinarily be just the file name.
- Specified by:
getNamein interfaceIEditorInput- Returns:
- the name string; never
null;
-
getPersistable
public IPersistableElement getPersistable()
Description copied from interface:IEditorInputReturns an object that can be used to save the state of this editor input.- Specified by:
getPersistablein interfaceIEditorInput- Returns:
- the persistable element, or
nullif this editor input cannot be persisted
-
getToolTipText
public String getToolTipText()
Description copied from interface:IEditorInputReturns the tool tip text for this editor input. This text is used to differentiate between two input with the same name. For instance, MyClass.java in folder X and MyClass.java in folder Y. The format of the text varies between input types.- Specified by:
getToolTipTextin interfaceIEditorInput- Returns:
- the tool tip text; never
null.
-
getAdapter
public <T> T getAdapter(Class<T> adapter)
Description copied from interface:IAdaptableReturns an object which is an instance of the given class associated with this object. Returnsnullif no such object can be found.Clients may implement this method but should generally call
Adapters.adapt(Object, Class, boolean)rather than invoking it directly.- Specified by:
getAdapterin interfaceIAdaptable- Type Parameters:
T- the class type- Parameters:
adapter- the adapter class to look up- Returns:
- a object of the given class,
or
nullif this object does not have an adapter for the given class
-
getURI
public URI getURI()
Description copied from interface:IURIEditorInputReturns theURIof the file underlying this editor input.- Specified by:
getURIin interfaceIURIEditorInput- Returns:
URI
-
getFactoryId
public String getFactoryId()
Description copied from interface:IPersistableElementReturns the id of the element factory which should be used to re-create this object.Factory ids are declared in extensions to the standard extension point
"org.eclipse.ui.elementFactories".- Specified by:
getFactoryIdin interfaceIPersistableElement- Returns:
- the element factory id
- See Also:
IElementFactory
-
saveState
public void saveState(IMemento memento)
Description copied from interface:IPersistableSaves the state of the object in the given memento.- Specified by:
saveStatein interfaceIPersistable- Parameters:
memento- the storage area for object's state
-
-