|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
IEditorPart |
getEditor(boolean restore)
Returns the editor referenced by this object. |
IEditorInput |
getEditorInput()
Returns the editor input for the editor referenced by this object. |
String |
getFactoryId()
Returns the factory id of the factory used to restore this editor. |
String |
getName()
Returns the editor input name. |
boolean |
isDirty()
Returns true if the editor is dirty otherwise returns false. |
boolean |
isPinned()
Returns true if the editor is pinned otherwise returns false. |
Methods inherited from interface org.eclipse.ui.IWorkbenchPartReference |
---|
addPropertyListener, getContentDescription, getId, getPage, getPart, getPartName, getTitle, getTitleImage, getTitleToolTip, removePropertyListener |
Method Detail |
public String getFactoryId()
public String getName()
public IEditorPart getEditor(boolean restore)
null
if the editor was not instantiated or
it failed to be restored. Tries to restore the editor
if restore
is true.
public boolean isDirty()
public boolean isPinned()
public IEditorInput getEditorInput() throws PartInitException
Unlike most of the other methods on this type, this method can trigger plug-in activation.
PartInitException
- if there was an error restoring the editor input
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.