- All Superinterfaces:
- All Known Subinterfaces:
- All Known Implementing Classes:
public interface IEditorPart extends IWorkbenchPart, ISaveablePartAn editor is a visual component within a workbench page. It is typically used to edit or browse a document or input object. The input is identified using an
IEditorInput. Modifications made in an editor part follow an open-save-close lifecycle model (in contrast to a view part, where modifications are saved to the workbench immediately).
An editor is document or input-centric. Each editor has an input, and only one editor can exist for each editor input within a page. This policy has been designed to simplify part management.
An editor should be used in place of a view whenever more than one instance of a document type can exist.
This interface may be implemented directly. For convenience, a base implementation is defined in
An editor part is added to the workbench in two stages:
- An editor extension is contributed to the workbench registry. This extension defines the extension id, extension class, and the file extensions which are supported by the editor.
- An editor part based upon the extension is created and added to the workbench when the user opens a file with one of the supported file extensions (or some other suitable form of editor input).
All editor parts implement the
IAdaptableinterface; extensions are managed by the platform's adapter manager.
Fields Modifier and Type Field Description
PROP_DIRTYThe property id for
PROP_INPUTThe property id for
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
getEditorInput()Returns the input for this editor.
getEditorSite()Returns the site for this editor.
init(IEditorSite site, IEditorInput input)Initializes this editor with the given editor site and input.
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
Methods inherited from interface org.eclipse.ui.ISaveablePart
doSave, doSaveAs, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
static final int PROP_DIRTYThe property id for
- See Also:
- Constant Field Values
static final int PROP_INPUTThe property id for
- See Also:
- Constant Field Values
IEditorInput getEditorInput()Returns the input for this editor. If this value changes the part must fire a property listener event with
- the editor input
IEditorSite getEditorSite()Returns the site for this editor. This method is equivalent to
The site can be
nullwhile the editor is being initialized. After the initialization is complete, this value must be non-
nullfor the remainder of the editor's life cycle.
- the editor site; this value may be
nullif the editor has not yet been initialized
void init(IEditorSite site, IEditorInput input) throws PartInitExceptionInitializes this editor with the given editor site and input.
This method is automatically called shortly after the part is instantiated. It marks the start of the part's lifecycle. The
IWorkbenchPart.disposemethod will be called automically at the end of the lifecycle. Clients must not call this method.
Implementors of this method must examine the editor input object type to determine if it is understood. If not, the implementor must throw a
site- the editor site
input- the editor input
PartInitException- if this editor was not initialized successfully