Package org.eclipse.ui.part
Class Page
java.lang.Object
org.eclipse.ui.part.Page
- All Implemented Interfaces:
IPage
,IPageBookViewPage
- Direct Known Subclasses:
AbstractTemplatesPage
,AbstractTextSearchViewPage
,CompareOutlinePage
,ContentOutlinePage
,HistoryPage
,MessagePage
,PropertySheetPage
,TabbedPropertySheetPage
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 control
Subclasses 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
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
createControl
(Composite parent) Creates the SWT control for this page under the given parent control.void
dispose()
ThePage
implementation of thisIPage
method disposes of this page's control (if it has one and it has not already been disposed).abstract Control
ThePage
implementation of thisIPage
method returnsnull
.getSite()
Returns the site which contains this page.void
ThePage
implementation of thisIPageBookViewPage
method stores a reference to the supplied site (the site which contains this page).void
makeContributions
(IMenuManager menuManager, IToolBarManager toolBarManager, IStatusLineManager statusLineManager) This method exists for backward compatibility.void
setActionBars
(IActionBars actionBars) This method exists for backward compatibility.abstract void
setFocus()
ThePage
implementation of thisIPage
method does nothing.
-
Constructor Details
-
Page
protected Page()
-
-
Method Details
-
createControl
Description copied from interface:IPage
Creates the SWT control for this page under the given parent control.Clients should not call this method (the workbench calls this method when it needs to, which may be never).
- Specified by:
createControl
in interfaceIPage
- Parameters:
parent
- the parent control
-
dispose
public void dispose()ThePage
implementation of thisIPage
method disposes of this page's control (if it has one and it has not already been disposed). Subclasses may extend. -
getControl
ThePage
implementation of thisIPage
method returnsnull
. Subclasses must reimplement.- Specified by:
getControl
in interfaceIPage
- Returns:
- the SWT control for this page, or
null
if this page does not have a control
-
makeContributions
public void makeContributions(IMenuManager menuManager, IToolBarManager toolBarManager, IStatusLineManager statusLineManager) This method exists for backward compatibility. Subclasses should reimplementinit
. -
setActionBars
This method exists for backward compatibility. Subclasses should reimplementinit
.- Specified by:
setActionBars
in interfaceIPage
- Parameters:
actionBars
- the action bars for this page
-
init
ThePage
implementation of thisIPageBookViewPage
method stores a reference to the supplied site (the site which contains this page).Subclasses may extend.
- Specified by:
init
in interfaceIPageBookViewPage
- Parameters:
pageSite
- the page site- Since:
- 2.0
-
getSite
Returns the site which contains this page.- Specified by:
getSite
in interfaceIPageBookViewPage
- Returns:
- the site which contains this page
-
setFocus
public abstract void setFocus()ThePage
implementation of thisIPage
method does nothing. Subclasses must implement.
-