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 class MultiPageEditorPart instead
Abstract 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 controls
  • setFocus - to accept focus
  • isDirty - to decide whether a significant change has occurred
  • doSave - to save contents of editor
  • doSaveAs - 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 instantiated
  • init(IEditorSite,IEditorInput) - extend to provide additional initialization when editor is assigned its site
  • isSaveOnCloseNeeded - override to control saving
  • isSaveAsAllowed - override to control saving
  • gotoMarker - reimplement to make selections based on markers
  • dispose - extend to provide additional cleanup
  • getAdapter - 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.

  • Constructor Details

    • MultiPageEditor

      @Deprecated public MultiPageEditor()
      Deprecated.
      Use the class MultiPageEditorPart instead
      Creates a new multi-page editor.

  • Method Details

    • 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.
      The MultiPageEditor implementation of this IWorkbenchPart method creates a TabFolder control.
      Specified by:
      createPartControl in interface IWorkbenchPart
      Specified by:
      createPartControl in class WorkbenchPart
      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:

    • 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