|
 |
|
| |
org.eclipse.ui
Interface IEditorReference
-
All Superinterfaces:
-
IWorkbenchPartReference
-
public interface IEditorReference
- extends
IWorkbenchPartReference
Implements a reference to a editor.
The IEditorPart will not be instanciated until
the editor becomes visible or the API getEditor
is sent with true;
This interface is not intended to be implemented by clients.
-
Restriction:
- This interface is not intended to be implemented by clients.
|
Methods inherited from interface org.eclipse.ui.
IWorkbenchPartReference
|
addPartPropertyListener,
addPropertyListener,
getContentDescription,
getId,
getPage,
getPart,
getPartName,
getPartProperty,
getTitle,
getTitleImage,
getTitleToolTip,
isDirty,
removePartPropertyListener,
removePropertyListener
|
getFactoryId
String getFactoryId()
- Returns the factory id of the factory used to
restore this editor. Returns null if the editor
is not persistable.
-
-
getName
String getName()
- Returns the editor input name. May return null is the
name is not available or if the editor failed to be
restored.
-
-
getEditor
IEditorPart getEditor(boolean restore)
- Returns the editor referenced by this object.
Returns
null if the editor was not instantiated or
it failed to be restored. Tries to restore the editor
if restore is true.
-
-
isPinned
boolean isPinned()
- Returns true if the editor is pinned otherwise returns false.
-
-
getEditorInput
IEditorInput getEditorInput()
throws
PartInitException
- Returns the editor input for the editor referenced by this object.
Unlike most of the other methods on this type, this method
can trigger plug-in activation.
-
-
-
Returns:
- the editor input for the editor referenced by this object
-
Throws:
-
PartInitException
- if there was an error restoring the editor input -
Since:
- 3.1
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
