org.eclipse.team.ui.history
Interface IHistoryPageSite

public interface IHistoryPageSite

A site which provides access to the context in which this page is being displayed. Instances of this interface serve a similar purpose to IWorkbenchSite instances but is provided as a separate objects to allow clients to access the different site types (view, editor, dialog) using a common interface. This interface also provides access to the part for the site because this is required by some UI components. Clients should not need to access the part.

Clients can determine the type of workbench site by doing instanceof checks on the object returned by getWorkbenchSite. Similar instanceof checks can be done with the part.

This interface is not intended to be implemented by clients.

Since:

3.2

Method Summary

IActionBars	getActionBars() Returns the action bars for this history page site.
IKeyBindingService	getKeyBindingService() Get the keybinding service for the site or null if one is not available.
IWorkbenchPart	getPart() Return the workbench part for the page or null if a workbench part is not available (e.g. if the page is being shown in a dialog).
ISelectionProvider	getSelectionProvider() Get the selection provider that gives access to the selection of the synchronize page associated with this page site.
Shell	getShell() Returns the shell for this site.
IWorkbenchPartSite	getWorkbenchPartSite() Return the workbench part site for the page or null if a workbench part site is not available (e.g. if the page is being shown in a dialog).
boolean	isModal() Returns whether this site is modal.
void	setFocus() Give the page focus.
void	setSelectionProvider(ISelectionProvider provider) Sets the selection provider for this workbench site.
void	setToolBarManager(ToolBarManager toolBarManager) Sets the Toolbar Manager for this history page site.

Method Detail

getWorkbenchPartSite

public IWorkbenchPartSite getWorkbenchPartSite()

Return the workbench part site for the page or null if a workbench part site is not available (e.g. if the page is being shown in a dialog).

Returns:

the workbench part site for the page or null

getPart

public IWorkbenchPart getPart()

Return the workbench part for the page or null if a workbench part is not available (e.g. if the page is being shown in a dialog).

Returns:

the workbench part for the page or null

getShell

public Shell getShell()

Returns the shell for this site.

Returns:

the shell for this site

getSelectionProvider

public ISelectionProvider getSelectionProvider()

Get the selection provider that gives access to the selection of the synchronize page associated with this page site.

Returns:

the selection provider for the page

setSelectionProvider

public void setSelectionProvider(ISelectionProvider provider)

Sets the selection provider for this workbench site.

Parameters:

provider - the selection provider, or null to clear it

getKeyBindingService

public IKeyBindingService getKeyBindingService()

Get the keybinding service for the site or null if one is not available.

Returns:

the keybinding service for the site or null if one is not available

setFocus

public void setFocus()

Give the page focus.

getActionBars

public IActionBars getActionBars()

Returns the action bars for this history page site.

Returns:

the action bars

setToolBarManager

public void setToolBarManager(ToolBarManager toolBarManager)

Sets the Toolbar Manager for this history page site.

Parameters:

toolBarManager -

isModal

public boolean isModal()

Returns whether this site is modal.

Returns:

true if the site is modal, false otherwise