Package org.eclipse.team.ui.synchronize
Interface ISynchronizePageSite
-
public interface ISynchronizePageSiteA site which provides access to the context in which this page is being displayed. Instances of this interface serve a similar purpose toIWorkbenchSiteinstances 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
instanceofchecks on the object returned bygetWorkbenchSite. Similarinstanceofchecks can be done with the part.Clients are not intended to implement this interface
- Since:
- 3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IActionBarsgetActionBars()Returns the action bars for this synchronize page site.IKeyBindingServicegetKeyBindingService()Get the keybinding service for the site ornullif one is not available.IDialogSettingsgetPageSettings()Return a settings node that can be used by the page to save state.IWorkbenchPartgetPart()Return the workbench part for the page ornullif a workbench part is not available (e.g. if the page is being shown in a dialog).ISelectionProvidergetSelectionProvider()Get the selection provider that gives access to the selection of the synchronize page associated with this page site.ShellgetShell()Returns the shell for this site.IWorkbenchSitegetWorkbenchSite()Return the workbench site for the page ornullif a workbench site is not available (e.g. if the page is being shown in a dialog).booleanisModal()Returns whether the site is associated with a page being shown in a modal dialogvoidsetFocus()Give the page focus.voidsetSelectionProvider(ISelectionProvider provider)Sets the selection provider for this workbench site.
-
-
-
Method Detail
-
getWorkbenchSite
IWorkbenchSite getWorkbenchSite()
Return the workbench site for the page ornullif a workbench site is not available (e.g. if the page is being shown in a dialog).- Returns:
- the workbench site for the page or
null
-
getPart
IWorkbenchPart getPart()
Return the workbench part for the page ornullif 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
Shell getShell()
Returns the shell for this site.- Returns:
- the shell for this site
-
getSelectionProvider
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
void setSelectionProvider(ISelectionProvider provider)
Sets the selection provider for this workbench site.- Parameters:
provider- the selection provider, ornullto clear it
-
getKeyBindingService
IKeyBindingService getKeyBindingService()
Get the keybinding service for the site ornullif one is not available.- Returns:
- the keybinding service for the site or
nullif one is not available
-
setFocus
void setFocus()
Give the page focus.
-
getPageSettings
IDialogSettings getPageSettings()
Return a settings node that can be used by the page to save state. Anullvalue is returned if the site does not allow for persisted settings.- Returns:
- a settings node or
null
-
getActionBars
IActionBars getActionBars()
Returns the action bars for this synchronize page site.- Returns:
- the action bars
-
isModal
boolean isModal()
Returns whether the site is associated with a page being shown in a modal dialog- Returns:
- whether the site is associated with a page being shown in a modal dialog
-
-