|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.ui.part.MultiEditor
A MultiEditor is a composite of editors. This class is intended to be subclassed.
Nested Class Summary | |
static class |
MultiEditor.Gradient
The colors used to draw the title bar of the inner editors |
Field Summary |
Fields inherited from interface org.eclipse.ui.IEditorPart |
PROP_DIRTY, PROP_INPUT |
Fields inherited from interface org.eclipse.ui.IWorkbenchPart |
PROP_TITLE |
Constructor Summary | |
MultiEditor()
Constructor for TileEditor. |
Method Summary | |
protected void |
activateEditor(IEditorPart part)
Activates the given nested editor. |
Composite |
createInnerPartControl(Composite parent,
IEditorPart e)
Create the control of the inner editor. |
void |
dispose()
The MultiEditor implementation of this
method extends the EditorPart implementation,
and disposes any inner editors. |
void |
doSave(IProgressMonitor monitor)
Saves the contents of this part. |
void |
doSaveAs()
Saves the contents of this part to another object. |
protected abstract void |
drawGradient(IEditorPart innerEditor,
MultiEditor.Gradient g)
Draw the gradient in the title bar. |
IEditorPart |
getActiveEditor()
Returns the active inner editor. |
protected int |
getIndex(IEditorPart editor)
Returns the index of the given nested editor. |
IEditorPart[] |
getInnerEditors()
Returns an array with all inner editors. |
protected boolean |
getShellActivated()
Return true if the shell is activated. |
void |
init(IEditorSite site,
IEditorInput input)
Initializes this editor with the given editor site and input. |
void |
init(IEditorSite site,
MultiEditorInput input)
|
boolean |
isDirty()
Returns whether the contents of this part have changed since the last save operation. |
boolean |
isSaveAsAllowed()
Returns whether the "Save As" operation is supported by this part. |
void |
setChildren(IEditorPart[] children)
Set the inner editors. |
void |
setFocus()
Asks this part to take focus within the workbench. |
void |
updateGradient(IEditorPart editor)
Updates the gradient in the title bar. |
Methods inherited from class org.eclipse.ui.part.EditorPart |
getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setPartName |
Methods inherited from class org.eclipse.ui.part.WorkbenchPart |
addPropertyListener, createPartControl, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getPartName, getSite, getTitle, getTitleImage, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.IWorkbenchPart |
addPropertyListener, createPartControl, getSite, getTitle, getTitleImage, removePropertyListener |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Constructor Detail |
public MultiEditor()
Method Detail |
public void doSave(IProgressMonitor monitor)
ISaveablePart
If the save is successful, the part should fire a property changed event
reflecting the new dirty state (PROP_DIRTY
property).
If the save is cancelled through user action, or for any other reason, the
part should invoke setCancelled
on the IProgressMonitor
to inform the caller.
This method is long-running; progress and cancellation are provided by the given progress monitor.
doSave
in interface ISaveablePart
doSave
in class EditorPart
public Composite createInnerPartControl(Composite parent, IEditorPart e)
public void dispose()
MultiEditor
implementation of this
method extends the EditorPart
implementation,
and disposes any inner editors. Subclasses may extend.
dispose
in interface IWorkbenchPart
dispose
in class WorkbenchPart
public void doSaveAs()
ISaveablePart
Implementors are expected to open a "Save As" dialog where the user will
be able to select a new name for the contents. After the selection is made,
the contents should be saved to that new name. During this operation a
IProgressMonitor
should be used to indicate progress.
If the save is successful, the part fires a property changed event
reflecting the new dirty state (PROP_DIRTY
property).
doSaveAs
in interface ISaveablePart
doSaveAs
in class EditorPart
public void init(IEditorSite site, IEditorInput input) throws PartInitException
IEditorPart
This method is automatically called shortly after the part is instantiated.
It marks the start of the part's lifecycle. The
IWorkbenchPart.dispose
method 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 PartInitException
init
in interface IEditorPart
init
in class EditorPart
PartInitException
public void init(IEditorSite site, MultiEditorInput input) throws PartInitException
PartInitException
public boolean isDirty()
ISaveablePart
PROP_DIRTY
.
isDirty
in interface ISaveablePart
isDirty
in class EditorPart
public boolean isSaveAsAllowed()
ISaveablePart
isSaveAsAllowed
in interface ISaveablePart
isSaveAsAllowed
in class EditorPart
public void setFocus()
IWorkbenchPart
Clients should not call this method (the workbench calls this method at
appropriate times). To have the workbench activate a part, use
IWorkbenchPage.activate(IWorkbenchPart) instead
.
setFocus
in interface IWorkbenchPart
setFocus
in class WorkbenchPart
public final IEditorPart getActiveEditor()
public final IEditorPart[] getInnerEditors()
public final void setChildren(IEditorPart[] children)
protected void activateEditor(IEditorPart part)
part
- the nested editorprotected int getIndex(IEditorPart editor)
public void updateGradient(IEditorPart editor)
protected abstract void drawGradient(IEditorPart innerEditor, MultiEditor.Gradient g)
protected boolean getShellActivated()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.