|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
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. |
IToolBarManager |
getToolBarManager()
Returns the toolbar manager for this site or null
it there is no toolbar. |
IPageSite |
getWorkbenchPageSite()
Return the workbench page site for the page or null if a
workbench page 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. |
Method Detail |
public IPageSite getWorkbenchPageSite()
null
if a
workbench page site is not available (e.g. if the page is being shown in
a dialog).
null
public IWorkbenchPart getPart()
null
if a
workbench part is not available (e.g. if the page is being shown in a
dialog).
null
public Shell getShell()
public ISelectionProvider getSelectionProvider()
public void setSelectionProvider(ISelectionProvider provider)
provider
- the selection provider, or null
to clear itpublic void setFocus()
public IToolBarManager getToolBarManager()
null
it there is no toolbar. For sites which have a corresponding
workbench site, the toolbar manager will come from the action
bars.
public boolean isModal()
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.