Package org.eclipse.ui.part

Class MultiEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.ui.part.AbstractMultiEditor

org.eclipse.ui.part.MultiEditor

All Implemented Interfaces:

IAdaptable, IExecutableExtension, IEditorPart, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public abstract class MultiEditor
extends AbstractMultiEditor

A MultiEditor is a composite of editors. This class is intended to be subclassed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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

Constructors

Constructor	Description
MultiEditor()

Method Summary

Modifier and Type	Method	Description
void	activateEditor(IEditorPart part)	Activates the given nested editor.
Composite	createInnerPartControl(Composite parent, IEditorPart e)	Create the control of the inner editor.
protected abstract void	drawGradient(IEditorPart innerEditor, MultiEditor.Gradient g)	Draw the gradient in the title bar.
Composite	getInnerEditorContainer(IEditorReference innerEditorReference)	This method is called after createPartControl has been executed and should return the container for the given inner editor.
protected boolean	getShellActivated()	Return true if the shell is activated.
protected void	innerEditorsCreated()	Called as soon as the inner editors have been created and are available.
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.AbstractMultiEditor

dispose, doSave, doSaveAs, getActiveEditor, getIndex, getInnerEditors, handlePropertyChange, init, init, isDirty, isSaveAsAllowed, setChildren

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, createPartControl, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, createPartControl, getSite, getTitle, getTitleImage, removePropertyListener

Constructor Detail

MultiEditor

public MultiEditor()

Method Detail

updateGradient

public void updateGradient(IEditorPart editor)

Updates the gradient in the title bar.

Parameters:

editor - the editor to update; not null

drawGradient

protected abstract void drawGradient(IEditorPart innerEditor,
                                     MultiEditor.Gradient g)

Draw the gradient in the title bar.

createInnerPartControl

public Composite createInnerPartControl(Composite parent,
                                        IEditorPart e)

Create the control of the inner editor. Must be called by subclass.

setFocus

public void setFocus()

Description copied from interface: IWorkbenchPart

Asks this part to take focus within the workbench. Parts must assign focus to one of the controls contained in the part's parent composite.

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.

Specified by:

setFocus in interface IWorkbenchPart

Overrides:

setFocus in class AbstractMultiEditor

activateEditor

public void activateEditor(IEditorPart part)

Activates the given nested editor.

Overrides:

activateEditor in class AbstractMultiEditor

Parameters:

part - the nested editor

Since:

3.5

getShellActivated

protected boolean getShellActivated()

Return true if the shell is activated.

getInnerEditorContainer

public Composite getInnerEditorContainer(IEditorReference innerEditorReference)

Description copied from class: AbstractMultiEditor

This method is called after createPartControl has been executed and should return the container for the given inner editor.

Specified by:

getInnerEditorContainer in class AbstractMultiEditor

Parameters:

innerEditorReference - a reference to the inner editor that is being created.

Returns:

the container in which the inner editor's pane and part controls are to be created.

innerEditorsCreated

protected void innerEditorsCreated()

Description copied from class: AbstractMultiEditor

Called as soon as the inner editors have been created and are available.

Specified by:

innerEditorsCreated in class AbstractMultiEditor