public interface IEditorInput extends IAdaptable
IEditorInputis a light weight descriptor of editor input, like a file name but more abstract. It is not a model. It is a description of the model source for an
Clients implementing this editor input interface should override
Object.equals(Object) to answer true for two inputs that are
the same. The
IWorkbenchPage.openEditor APIs are dependent on
this to find an editor with the same input.
Clients should extend this interface to declare new types of editor inputs.
An editor input is passed to an editor via the
method. Due to the wide range of valid editor inputs, it is not possible to
define generic methods for getting and setting bytes.
Editor input must implement the
extensions are managed by the platform's adapter manager.
Please note that it is important that the editor input be light weight. Within the workbench, the navigation history tends to hold on to editor inputs as a means of reconstructing the editor at a later time. The navigation history can hold on to quite a few inputs (i.e., the default is fifty). The actual data model should probably not be held in the input.
|Modifier and Type||Method and Description|
Returns whether the editor input exists.
Returns the image descriptor for this input.
Returns the name of this editor input for display purposes.
Returns an object that can be used to save the state of this editor input.
Returns the tool tip text for this editor input.
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
false or it drops off the bottom of the list.
trueif the editor input exists;
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()).
nullif there is no image.
For instance, when the input is from a file, the return value would ordinarily be just the file name.
nullif this editor input cannot be persisted
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.