Package org.eclipse.ui.part
Class MultiPageEditor
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.ui.part.WorkbenchPart
-
- org.eclipse.ui.part.EditorPart
-
- org.eclipse.ui.part.MultiPageEditor
-
- All Implemented Interfaces:
IAdaptable
,IExecutableExtension
,IEditorPart
,ISaveablePart
,IWorkbenchPart
,IWorkbenchPart2
,IWorkbenchPart3
,IWorkbenchPartOrientation
@Deprecated(forRemoval=true) public abstract class MultiPageEditor extends EditorPart
Deprecated, for removal: This API element is subject to removal in a future version.Use the classMultiPageEditorPart
insteadAbstract superclass of all multi-page workbench editors.This class should be subclassed by clients wishing to define new multi-page editor.
Subclasses must implement the following methods:
createPartControl
- to create the view's controlssetFocus
- to accept focusisDirty
- to decide whether a significant change has occurreddoSave
- to save contents of editordoSaveAs
- to save contents of editor
Subclasses may extend or reimplement the following methods as required:
setInitializationData
- extend to provide additional initialization when editor extension is instantiatedinit(IEditorSite,IEditorInput)
- extend to provide additional initialization when editor is assigned its siteisSaveOnCloseNeeded
- override to control savingisSaveAsAllowed
- override to control savinggotoMarker
- reimplement to make selections based on markersdispose
- extend to provide additional cleanupgetAdapter
- reimplement to make their editor adaptable
- Restriction:
- This class is not intended to be subclassed by clients.
- Restriction:
- This class is not intended to be referenced by clients. Marked for deletion see Bug 547018.
-
-
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 MultiPageEditor()
Deprecated.Use the classMultiPageEditorPart
instead
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addSyncroPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Adds a synchronized pagebook to this editor.void
createPartControl(Composite parent)
Deprecated, for removal: This API element is subject to removal in a future version.TheMultiPageEditor
implementation of thisIWorkbenchPart
method creates aTabFolder
control.protected TabFolder
getFolder()
Deprecated, for removal: This API element is subject to removal in a future version.Returns this editor's workbook.protected void
onPageChange()
Deprecated, for removal: This API element is subject to removal in a future version.Indicates that a page change has occurred.protected void
removeSyncroPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Removes a synchronized pagebook from this editor.protected void
sync()
Deprecated, for removal: This API element is subject to removal in a future version.Synchronizes each registered pagebook with the editor page.protected void
syncPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Sets the visible page of the given pagebook to be the same as the visible page of this editor.-
Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, doSave, doSaveAs, getEditorInput, getEditorSite, getTitleToolTip, init, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
-
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setFocus, 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, dispose, getSite, getTitle, getTitleImage, removePropertyListener, setFocus
-
-
-
-
Constructor Detail
-
MultiPageEditor
@Deprecated public MultiPageEditor()
Deprecated.Use the classMultiPageEditorPart
insteadCreates a new multi-page editor.
-
-
Method Detail
-
addSyncroPageBook
protected void addSyncroPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Adds a synchronized pagebook to this editor. Once added, the visible page of the pagebook and the visible page of the editor will be synchronized.- Parameters:
pageBook
- the pagebook to add
-
createPartControl
public void createPartControl(Composite parent)
Deprecated, for removal: This API element is subject to removal in a future version.TheMultiPageEditor
implementation of thisIWorkbenchPart
method creates aTabFolder
control.- Specified by:
createPartControl
in interfaceIWorkbenchPart
- Specified by:
createPartControl
in classWorkbenchPart
- Parameters:
parent
- the parent control
-
getFolder
protected TabFolder getFolder()
Deprecated, for removal: This API element is subject to removal in a future version.Returns this editor's workbook.- Returns:
- the editor workbook
-
onPageChange
protected void onPageChange()
Deprecated, for removal: This API element is subject to removal in a future version.Indicates that a page change has occurred. Updates the sync vector.
-
removeSyncroPageBook
protected void removeSyncroPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Removes a synchronized pagebook from this editor.- Parameters:
pageBook
- the pagebook to remove- See Also:
addSyncroPageBook(PageBook)
-
sync
protected void sync()
Deprecated, for removal: This API element is subject to removal in a future version.Synchronizes each registered pagebook with the editor page.
-
syncPageBook
protected void syncPageBook(PageBook pageBook)
Deprecated, for removal: This API element is subject to removal in a future version.Sets the visible page of the given pagebook to be the same as the visible page of this editor.- Parameters:
pageBook
- a pagebook to synchronize
-
-