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,ContentOutlinePage,HistoryPage,MessagePage,PropertySheetPage,TabbedPropertySheetPage
public abstract class Page extends Object implements IPageBookViewPage
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:
PageBookView
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedPage()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidcreateControl(Composite parent)Creates the SWT control for this page under the given parent control.voiddispose()ThePageimplementation of thisIPagemethod disposes of this page's control (if it has one and it has not already been disposed).abstract ControlgetControl()ThePageimplementation of thisIPagemethod returnsnull.IPageSitegetSite()Returns the site which contains this page.voidinit(IPageSite pageSite)ThePageimplementation of thisIPageBookViewPagemethod stores a reference to the supplied site (the site which contains this page).voidmakeContributions(IMenuManager menuManager, IToolBarManager toolBarManager, IStatusLineManager statusLineManager)This method exists for backward compatibility.voidsetActionBars(IActionBars actionBars)This method exists for backward compatibility.abstract voidsetFocus()ThePageimplementation of thisIPagemethod does nothing.
-
-
-
Method Detail
-
createControl
public abstract void createControl(Composite parent)
Description copied from interface:IPageCreates 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:
createControlin interfaceIPage- Parameters:
parent- the parent control
-
dispose
public void dispose()
ThePageimplementation of thisIPagemethod disposes of this page's control (if it has one and it has not already been disposed). Subclasses may extend.
-
getControl
public abstract Control getControl()
ThePageimplementation of thisIPagemethod returnsnull. Subclasses must reimplement.- Specified by:
getControlin interfaceIPage- Returns:
- the SWT control for this page, or
nullif 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
public void setActionBars(IActionBars actionBars)
This method exists for backward compatibility. Subclasses should reimplementinit.- Specified by:
setActionBarsin interfaceIPage- Parameters:
actionBars- the action bars for this page
-
init
public void init(IPageSite pageSite)
ThePageimplementation of thisIPageBookViewPagemethod stores a reference to the supplied site (the site which contains this page).Subclasses may extend.
- Specified by:
initin interfaceIPageBookViewPage- Parameters:
pageSite- the page site- Since:
- 2.0
-
getSite
public IPageSite getSite()
Returns the site which contains this page.- Specified by:
getSitein interfaceIPageBookViewPage- Returns:
- the site which contains this page
-
-