org.eclipse.ui.part
Class PageBookView

java.lang.Object
  |
  +--org.eclipse.ui.part.WorkbenchPart
        |
        +--org.eclipse.ui.part.ViewPart
              |
              +--org.eclipse.ui.part.PageBookView

All Implemented Interfaces:

IAdaptable, IExecutableExtension, IPartListener, IViewPart, IWorkbenchPart

Direct Known Subclasses:

AbstractDebugView, ContentOutline, PropertySheet

public abstract class PageBookView

extends ViewPart

implements IPartListener

Abstract superclass of all multi-page workbench views.

Within the workbench there are many views which track the active part. If a part is activated these views display some properties for the active part. A simple example is the Outline View, which displays the outline for the active editor. To avoid loss of context when part activation changes, these views may implement a multi-page approach. A separate page is maintained within the view for each source view. If a part is activated the associated page for the part is brought to top. If a part is closed the associated page is disposed. PageBookView is a base implementation for multi page views.

PageBookViews provide an IPageSite for each of their pages. This site is supplied during the page's initialization. The page may supply a selection provider for this site. PageBookViews deal with these selection providers in a similar way to a workbench page's SelectionService. When a page is made visible, if its site has a selection provider, then changes in the selection are listened for and the current selection is obtained and fired as a selection change event. Selection changes are no longer listened for when a page is made invisible.

This class should be subclassed by clients wishing to define new multi-page views.

When a PageBookView is created the following methods are invoked. Subclasses must implement these.

• createDefaultPage - called to create a default page for the view. This page is displayed when the active part in the workbench does not have a page.
• getBootstrapPart - called to determine the active part in the workbench. A page will be created for this part

When a part is activated the base implementation does not know if a page should be created for the part. Therefore, it delegates creation to the subclass.

• isImportant - called when a workbench part is activated. Subclasses return whether a page should be created for the new part.
• doCreatePage - called to create a page for a particular part in the workbench. This is only invoked when isImportant returns true.

When a part is closed the base implementation will destroy the page associated with the particular part. The page was created by a subclass, so the subclass must also destroy it. Subclasses must implement these.

• doDestroyPage - called to destroy a page for a particular part in the workbench.

Nested Class Summary

protected static class	PageBookView.PageRec A data structure used to store the information about a single page within a pagebook view.
protected class	PageBookView.SelectionProvider A selection provider/listener for this view.

Field Summary

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

protected

PageBookView() Creates a new pagebook view.

Method Summary

protected abstract IPage	createDefaultPage(PageBook book) Creates and returns the default page for this view.
void	createPartControl(Composite parent) The PageBookView implementation of this IWorkbenchPart method creates a PageBook control with its default page showing.
void	dispose() The PageBookView implementation of this IWorkbenchPart method cleans up all the pages.
protected abstract PageBookView.PageRec	doCreatePage(IWorkbenchPart part) Creates a new page in the pagebook for a particular part.
protected abstract void	doDestroyPage(IWorkbenchPart part, PageBookView.PageRec pageRecord) Destroys a page in the pagebook for a particular part.
protected abstract IWorkbenchPart	getBootstrapPart() Returns the active, important workbench part for this view.
protected IWorkbenchPart	getCurrentContributingPart() Returns the part which contributed the current page to this view.
IPage	getCurrentPage() Returns the currently visible page for this view or null if no page is currently visible.
IPage	getDefaultPage() Returns the default page for this view.
protected PageBook	getPageBook() Returns the pagebook control for this view.
protected PageBookView.PageRec	getPageRec(IPage page) Returns the page record for the given page of this view.
protected PageBookView.PageRec	getPageRec(IWorkbenchPart part) Returns the page record for the given part.
protected PageSite	getPageSite(IPage page) Returns the view site for the given page of this view.
protected PageBookView.SelectionProvider	getSelectionProvider() Returns the selectionProvider for this page book view.
void	init(IViewSite site) Initializes this view with the given view site.
protected void	initPage(IPageBookViewPage page) Initializes the given page with a page site.
protected abstract boolean	isImportant(IWorkbenchPart part) Returns whether the given part should be added to this view.
void	partActivated(IWorkbenchPart part) The PageBookView implementation of this IPartListener method shows the page when the given part is activated.
void	partBroughtToTop(IWorkbenchPart part) The PageBookView implementation of this IPartListener method does nothing.
void	partClosed(IWorkbenchPart part) The PageBookView implementation of this IPartListener method deal with the closing of the active part.
void	partDeactivated(IWorkbenchPart part) The PageBookView implementation of this IPartListener method does nothing.
void	partOpened(IWorkbenchPart part) The PageBookView implementation of this IPartListener method does nothing.
void	setFocus() Asks this part to take focus within the workbench.
protected void	showPageRec(PageBookView.PageRec pageRec) Shows page contained in the given page record in this view.

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

getViewSite, init, saveState

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

addPropertyListener, firePropertyChange, getAdapter, getConfigurationElement, getDefaultImage, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setInitializationData, setSite, setTitle, setTitleImage, setTitleToolTip

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, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

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

getAdapter

Constructor Detail

PageBookView

protected PageBookView()

Creates a new pagebook view.

Method Detail

createDefaultPage

protected abstract IPage createDefaultPage(PageBook book)

Creates and returns the default page for this view.

Subclasses must implement this method.

Subclasses must call initPage with the new page (if it is an IPageBookViewPage) before calling createControl on the page.

Parameters:

book - the pagebook control

Returns:

the default page

initPage

protected void initPage(IPageBookViewPage page)

Initializes the given page with a page site.

Subclasses should call this method after the page is created but before creating its controls.

Subclasses may override

createPartControl

public void createPartControl(Composite parent)

The PageBookView implementation of this IWorkbenchPart method creates a PageBook control with its default page showing. Subclasses may extend.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

Parameters:

parent - the parent control

dispose

public void dispose()

The PageBookView implementation of this IWorkbenchPart method cleans up all the pages. Subclasses may extend.

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class WorkbenchPart

doCreatePage

protected abstract PageBookView.PageRec doCreatePage(IWorkbenchPart part)

Creates a new page in the pagebook for a particular part. This page will be made visible whenever the part is active, and will be destroyed with a call to doDestroyPage.

Subclasses must implement this method.

Subclasses must call initPage with the new page (if it is an IPageBookViewPage) before calling createControl on the page.

Parameters:

part - the input part

Returns:

the record describing a new page for this view

See Also:

doDestroyPage(org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.part.PageBookView.PageRec)

doDestroyPage

protected abstract void doDestroyPage(IWorkbenchPart part,
                                      PageBookView.PageRec pageRecord)

Destroys a page in the pagebook for a particular part. This page was returned as a result from doCreatePage.

Subclasses must implement this method.

Parameters:

part - the input part

pageRecord - a page record for the part

See Also:

doCreatePage(org.eclipse.ui.IWorkbenchPart)

getBootstrapPart

protected abstract IWorkbenchPart getBootstrapPart()

Returns the active, important workbench part for this view.

When the page book view is created it has no idea which part within the workbook should be used to generate the first page. Therefore, it delegates the choice to subclasses of PageBookView.

Implementors of this method should return an active, important part in the workbench or null if none found.

Subclasses must implement this method.

Returns:

the active important part, or null if none

getCurrentContributingPart

protected IWorkbenchPart getCurrentContributingPart()

Returns the part which contributed the current page to this view.

Returns:

the part which contributed the current page or null if no part contributed the current page

getCurrentPage

public IPage getCurrentPage()

Returns the currently visible page for this view or null if no page is currently visible.

Returns:

the currently visible page

getPageSite

protected PageSite getPageSite(IPage page)

Returns the view site for the given page of this view.

Parameters:

page - the page

Returns:

the corresponding site, or null if not found

getDefaultPage

public IPage getDefaultPage()

Returns the default page for this view.

Returns:

the default page

getPageBook

protected PageBook getPageBook()

Returns the pagebook control for this view.

Returns:

the pagebook control, or null if not initialized

getPageRec

protected PageBookView.PageRec getPageRec(IWorkbenchPart part)

Returns the page record for the given part.

Parameters:

part - the part

Returns:

the corresponding page record, or null if not found

getPageRec

protected PageBookView.PageRec getPageRec(IPage page)

Returns the page record for the given page of this view.

Parameters:

page - the page

Returns:

the corresponding page record, or null if not found

isImportant

protected abstract boolean isImportant(IWorkbenchPart part)

Returns whether the given part should be added to this view.

Subclasses must implement this method.

Parameters:

part - the input part

Returns:

true if the part is relevant, and false otherwise

init

public void init(IViewSite site)
          throws PartInitException

Description copied from interface: IViewPart

Initializes this view with the given view site.

This method is automatically called by the workbench shortly after part construction. It marks the start of the views's lifecycle. Clients must not call this method.

Specified by:

init in interface IViewPart

Overrides:

init in class ViewPart

Parameters:

site - the view site

Throws:

PartInitException - if this view was not initialized successfully

partActivated

public void partActivated(IWorkbenchPart part)

The PageBookView implementation of this IPartListener method shows the page when the given part is activated. Subclasses may extend.

Specified by:

partActivated in interface IPartListener

Parameters:

part - the part that was activated

See Also:

IPerspective#activate

partBroughtToTop

public void partBroughtToTop(IWorkbenchPart part)

The PageBookView implementation of this IPartListener method does nothing. Subclasses may extend.

Specified by:

partBroughtToTop in interface IPartListener

Parameters:

part - the part that was surfaced

See Also:

IPerspective#bringToTop

partClosed

public void partClosed(IWorkbenchPart part)

The PageBookView implementation of this IPartListener method deal with the closing of the active part. Subclasses may extend.

Specified by:

partClosed in interface IPartListener

Parameters:

part - the part that was closed

See Also:

IPerspective#close

partDeactivated

public void partDeactivated(IWorkbenchPart part)

The PageBookView implementation of this IPartListener method does nothing. Subclasses may extend.

Specified by:

partDeactivated in interface IPartListener

Parameters:

part - the part that was deactivated

See Also:

IPerspective#activate

partOpened

public void partOpened(IWorkbenchPart part)

The PageBookView implementation of this IPartListener method does nothing. Subclasses may extend.

Specified by:

partOpened in interface IPartListener

Parameters:

part - the part that was opened

setFocus

public void setFocus()

Description copied from interface: IWorkbenchPart

Asks this part to take focus within the workbench.

Clients should not call this method (the workbench calls this method at appropriate times).

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

showPageRec

protected void showPageRec(PageBookView.PageRec pageRec)

Shows page contained in the given page record in this view. The page record must be one from this pagebook view.

The PageBookView implementation of this method asks the pagebook control to show the given page's control, and records that the given page is now current. Subclasses may extend.

Parameters:

pageRec - the page record containing the page to show

getSelectionProvider

protected PageBookView.SelectionProvider getSelectionProvider()

Returns the selectionProvider for this page book view.

Returns:

a SelectionProvider