|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.part.Page
public abstract class Page
Abstract base superclass for pages in a pagebook view.
This class should be subclassed by clients wishing to define new types of pages for multi-page views.
Subclasses must implement the following methods:
createControl - to create the page's controlgetControl - to retrieve the page's controlSubclasses may extend or reimplement the following methods as required:
dispose - extend to provide additional cleanupsetFocus - reimplement to accept focussetActionBars - reimplement to make contributionsmakeContributions - this method exists to support previous versionssetActionBars - this method exists to support previous versionsinit - extend to provide additional setup
PageBookView| Constructor Summary | |
|---|---|
protected |
Page()
|
| Method Summary | |
|---|---|
abstract void |
createControl(Composite parent)
Creates the SWT control for this page under the given parent control. |
void |
dispose()
The Page implementation of this IPage method
disposes of this page's control (if it has one and it has not already
been disposed). |
abstract Control |
getControl()
The Page implementation of this IPage method returns
null. |
IPageSite |
getSite()
Returns the site which contains this page. |
void |
init(IPageSite pageSite)
The Page implementation of this IPageBookViewPage method
stores a reference to the supplied site (the site which contains this
page). |
void |
makeContributions(IMenuManager menuManager,
IToolBarManager toolBarManager,
IStatusLineManager statusLineManager)
|
void |
setActionBars(IActionBars actionBars)
Allows the page to make contributions to the given action bars. |
abstract void |
setFocus()
The Page implementation of this IPage method
does nothing. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected Page()
| Method Detail |
|---|
public abstract void createControl(Composite parent)
IPageClients should not call this method (the workbench calls this method when it needs to, which may be never).
createControl in interface IPageparent - the parent controlpublic void dispose()
Page implementation of this IPage method
disposes of this page's control (if it has one and it has not already
been disposed). Subclasses may extend.
dispose in interface IPagepublic abstract Control getControl()
Page implementation of this IPage method returns
null. Subclasses must reimplement.
getControl in interface IPagenull if this
page does not have a control
public void makeContributions(IMenuManager menuManager,
IToolBarManager toolBarManager,
IStatusLineManager statusLineManager)
public void setActionBars(IActionBars actionBars)
IPage
This method is automatically called shortly after
createControl is called
setActionBars in interface IPageactionBars - the action bars for this pagepublic void init(IPageSite pageSite)
Page implementation of this IPageBookViewPage method
stores a reference to the supplied site (the site which contains this
page).
Subclasses may extend.
init in interface IPageBookViewPagepageSite - the page sitepublic IPageSite getSite()
getSite in interface IPageBookViewPagepublic abstract void setFocus()
Page implementation of this IPage method
does nothing. Subclasses must implement.
setFocus in interface IPage
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.