Package org.eclipse.ui.ide

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 for IFileStore elements that represent files that are not part of the current workspace.
Since:
3.3

  • Constructor Details

    • FileStoreEditorInput

      public FileStoreEditorInput(IFileStore fileStore)
      Parameters:
      fileStore - the file store; not null

  • Method Details

    • exists

      public boolean exists()
      Description copied from interface: IEditorInput
      Returns 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 exists becomes false or it drops off the bottom of the list.

      Specified by:
      exists in interface IEditorInput
      Returns:
      true if the editor input exists; false otherwise

    • getImageDescriptor

      public ImageDescriptor getImageDescriptor()
      Description copied from interface: IEditorInput
      Returns 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:
      getImageDescriptor in interface IEditorInput
      Returns:
      the image descriptor for this input; may be null if there is no image.

    • getName

      public String getName()
      Description copied from interface: IEditorInput
      Returns 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:
      getName in interface IEditorInput
      Returns:
      the name string; never null;

    • getPersistable

      public IPersistableElement getPersistable()
      Description copied from interface: IEditorInput
      Returns an object that can be used to save the state of this editor input.
      Specified by:
      getPersistable in interface IEditorInput
      Returns:
      the persistable element, or null if this editor input cannot be persisted

    • getToolTipText

      public String getToolTipText()
      Description copied from interface: IEditorInput
      Returns 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:
      getToolTipText in interface IEditorInput
      Returns:
      the tool tip text; never null.

    • getAdapter

      public <T> T getAdapter(Class<T> adapter)
      Description copied from interface: IAdaptable
      Returns an object which is an instance of the given class associated with this object. Returns null if 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:
      getAdapter in interface IAdaptable
      Type Parameters:
      T - the class type
      Parameters:
      adapter - the adapter class to look up
      Returns:
      a object of the given class, or null if this object does not have an adapter for the given class

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getURI

      public URI getURI()
      Description copied from interface: IURIEditorInput
      Returns the URI of the file underlying this editor input.
      Specified by:
      getURI in interface IURIEditorInput
      Returns:
      URI

    • getFactoryId

      public String getFactoryId()
      Description copied from interface: IPersistableElement
      Returns 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:
      getFactoryId in interface IPersistableElement
      Returns:
      the element factory id
      See Also:

    • saveState

      public void saveState(IMemento memento)
      Description copied from interface: IPersistable
      Saves the state of the object in the given memento.
      Specified by:
      saveState in interface IPersistable
      Parameters:
      memento - the storage area for object's state