|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkbenchWindow
A workbench org.eclipse.jface.window is a top level org.eclipse.jface.window in a workbench. Visually, a workbench org.eclipse.jface.window has a menubar, a toolbar, a status bar, and a main area for displaying a single page consisting of a collection of views and editors.
Each workbench org.eclipse.jface.window has a collection of 0 or more pages; the active page is the one that is being presented to the end user; at most one page is active in a org.eclipse.jface.window at a time.
This interface is not intended to be implemented by clients.
IWorkbenchPage
Method Summary | |
---|---|
boolean |
close()
Closes this workbench org.eclipse.jface.window. |
IWorkbenchPage |
getActivePage()
Returns the currently active page for this workbench org.eclipse.jface.window. |
IExtensionTracker |
getExtensionTracker()
Return the extension tracker for the workbench. |
IWorkbenchPage[] |
getPages()
Returns a list of the pages in this workbench org.eclipse.jface.window. |
IPartService |
getPartService()
Returns the part service which tracks part activation within this workbench org.eclipse.jface.window. |
ISelectionService |
getSelectionService()
Returns the selection service which tracks selection within this workbench org.eclipse.jface.window. |
Shell |
getShell()
Returns this workbench org.eclipse.jface.window's shell. |
IWorkbench |
getWorkbench()
Returns the workbench for this org.eclipse.jface.window. |
boolean |
isApplicationMenu(java.lang.String menuId)
Returns whether the specified menu is an application menu as opposed to a part menu. |
IWorkbenchPage |
openPage(IAdaptable input)
Creates and opens a new workbench page. |
IWorkbenchPage |
openPage(java.lang.String perspectiveId,
IAdaptable input)
Creates and opens a new workbench page. |
void |
setActivePage(IWorkbenchPage page)
Sets or clears the currently active page for this workbench org.eclipse.jface.window. |
Methods inherited from interface org.eclipse.ui.IPageService |
---|
addPageListener, addPerspectiveListener, removePageListener, removePerspectiveListener |
Methods inherited from interface org.eclipse.jface.operation.IRunnableContext |
---|
run |
Method Detail |
---|
boolean close()
If the org.eclipse.jface.window has an open editor with unsaved content, the user will be given the opportunity to save it.
true
if the org.eclipse.jface.window was successfully closed, and
false
if it is still openIWorkbenchPage getActivePage()
getActivePage
in interface IPageService
null
if noneIWorkbenchPage[] getPages()
Note that each org.eclipse.jface.window has its own pages; pages are never shared between different windows.
IPartService getPartService()
ISelectionService getSelectionService()
Shell getShell()
IWorkbench getWorkbench()
boolean isApplicationMenu(java.lang.String menuId)
This is typically used during "in place" editing. Application menus should be preserved during menu merging. All other menus may be removed from the org.eclipse.jface.window.
menuId
- the menu id
true
if the specified menu is an application
menu, and false
if it is notIWorkbenchPage openPage(java.lang.String perspectiveId, IAdaptable input) throws WorkbenchException
Note: Since release 2.0, a org.eclipse.jface.window is limited to contain at most
one page. If a page exist in the org.eclipse.jface.window when this method is used, then
another org.eclipse.jface.window is created for the new page. Callers are strongly
recommended to use the IWorkbench.showPerspective
APIs to
programmatically show a perspective.
perspectiveId
- the perspective id for the org.eclipse.jface.window's initial pageinput
- the page input, or null
if there is no current
input. This is used to seed the input for the new page's
views.
WorkbenchException
- if a page could not be openedIWorkbench.showPerspective(String, IWorkbenchWindow, IAdaptable)
IWorkbenchPage openPage(IAdaptable input) throws WorkbenchException
Note: Since release 2.0, a org.eclipse.jface.window is limited to contain at most
one page. If a page exist in the org.eclipse.jface.window when this method is used, then
another org.eclipse.jface.window is created for the new page. Callers are strongly
recommended to use the IWorkbench.showPerspective
APIs to
programmatically show a perspective.
input
- the page input, or null
if there is no current
input. This is used to seed the input for the new page's
views.
WorkbenchException
- if a page could not be openedIWorkbench.showPerspective(String, IWorkbenchWindow, IAdaptable)
void setActivePage(IWorkbenchPage page)
page
- the new active pageIExtensionTracker getExtensionTracker()
Return the extension tracker for the workbench. This tracker may be used by plug-ins to ensure responsiveness to changes to the plug-in registry.
The tracker at this level of the workbench is typically used to track elements that persist for the life of the workbench. For example, the action objects corresponding to new wizards contributed by plug-ins fall into this category.
This method is EXPERIMENTAL and may change prior to the 3.1 release.
IWorkbench.getExtensionTracker()
,
IWorkbenchPage.getExtensionTracker()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |