Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.team.ui.synchronize
Interface ISynchronizePageSite


public interface ISynchronizePageSite

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.

Clients are not intended to implement this interface

Since:
3.0

Method Summary
  IActionBars getActionBars ()
          Returns the action bars for this synchronize page site.
  IKeyBindingService getKeyBindingService ()
          Get the keybinding service for the site or null if one is not available.
  IDialogSettings getPageSettings ()
          Return a settings node that can be used by the page to save state.
  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.
  IWorkbenchSite getWorkbenchSite ()
          Return the workbench site for the page or null if a workbench site is not available (e.g. if the page is being shown in a dialog).
 boolean isModal ()
          Returns whether the site is associated with a page being shown in a modal dialog
 void setFocus ()
          Give the page focus.
 void setSelectionProvider ( ISelectionProvider provider)
          Sets the selection provider for this workbench site.
 

Method Detail

getWorkbenchSite

IWorkbenchSite getWorkbenchSite()
Return the workbench site for the page or null if 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 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

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, or null to clear it

getKeyBindingService

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

void setFocus()
Give the page focus.


getPageSettings

IDialogSettings getPageSettings()
Return a settings node that can be used by the page to save state. A null value 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

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire