| org.eclipse.ui.IWorkbenchWindow
All known Subclasses: org.eclipse.ui.internal.WorkbenchWindow,
| IWorkbenchWindow | | public interface IWorkbenchWindow extends IPageService,IRunnableContext,IServiceLocator,IShellProvider(Code) | | A workbench window is a top level window in a workbench. Visually, a
workbench 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 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 window at a time.
The workbench window supports a few
IServiceLocator services by
default. If these services are used to allocate resources, it is important to
remember to clean up those resources after you are done with them. Otherwise,
the resources will exist until the workbench window is closed. The supported
services are:
This interface is not intended to be implemented by clients.
See Also: IWorkbenchPage |
| Method Summary | |
| public boolean | close()
Closes this workbench window. | | public IWorkbenchPage | getActivePage()
Returns the currently active page for this workbench window. | | public IExtensionTracker | getExtensionTracker()
Return the extension tracker for the workbench. | | public IWorkbenchPage[] | getPages()
Returns a list of the pages in this workbench window. | | public IPartService | getPartService()
Returns the part service which tracks part activation within this
workbench window. | | public ISelectionService | getSelectionService()
Returns the selection service which tracks selection within this
workbench window. | | public Shell | getShell()
Returns this workbench window's shell. | | public IWorkbench | getWorkbench()
Returns the workbench for this window. | | public boolean | isApplicationMenu(String menuId)
Returns whether the specified menu is an application menu as opposed to
a part menu. | | public IWorkbenchPage | openPage(String perspectiveId, IAdaptable input)
Creates and opens a new workbench page. | | public IWorkbenchPage | openPage(IAdaptable input)
Creates and opens a new workbench page. | | public void | run(boolean fork, boolean cancelable, IRunnableWithProgress runnable)
This specialization of IRunnableContext#run(boolean, boolean,
IRunnableWithProgress) blocks until the runnable has been run,
regardless of the value of fork.
It is recommended that fork is set to
true in most cases. | | public void | setActivePage(IWorkbenchPage page)
Sets or clears the currently active page for this workbench window. |
| close | | public boolean close()(Code) | | Closes this workbench window.
If the window has an open editor with unsaved content, the user will be
given the opportunity to save it.
true if the window was successfully closed, andfalse if it is still open |
| getActivePage | | public IWorkbenchPage getActivePage()(Code) | | Returns the currently active page for this workbench window.
the active page, or null if none |
| getExtensionTracker | | public IExtensionTracker getExtensionTracker()(Code) | |
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.
the extension tracker
See Also: IWorkbench.getExtensionTracker
See Also: IWorkbenchPage.getExtensionTracker
since:
3.1 |
| getPages | | public IWorkbenchPage[] getPages()(Code) | | Returns a list of the pages in this workbench window.
Note that each window has its own pages; pages are never shared between
different windows.
a list of pages |
| getPartService | | public IPartService getPartService()(Code) | | Returns the part service which tracks part activation within this
workbench window.
the part service |
| getSelectionService | | public ISelectionService getSelectionService()(Code) | | Returns the selection service which tracks selection within this
workbench window.
the selection service |
| getShell | | public Shell getShell()(Code) | | Returns this workbench window's shell.
the shell containing this window's controls or nullif the shell has not been created yet or if the window has been closed |
| getWorkbench | | public IWorkbench getWorkbench()(Code) | | Returns the workbench for this window.
the workbench |
| isApplicationMenu | | public boolean isApplicationMenu(String menuId)(Code) | | Returns whether the specified menu is an application menu as opposed to
a part menu. Application menus contain items which affect the workbench
or window. Part menus contain items which affect the active part (view
or editor).
This is typically used during "in place" editing. Application menus
should be preserved during menu merging. All other menus may be removed
from the window.
Parameters:
menuId - the menu id true if the specified menu is an applicationmenu, and false if it is not |
| openPage | | public IWorkbenchPage openPage(String perspectiveId, IAdaptable input) throws WorkbenchException(Code) | | Creates and opens a new workbench page. The perspective of the new page
is defined by the specified perspective ID. The new page become active.
Note: Since release 2.0, a window is limited to contain at most
one page. If a page exist in the window when this method is used, then
another window is created for the new page. Callers are strongly
recommended to use the IWorkbench.showPerspective APIs to
programmatically show a perspective.
Parameters:
perspectiveId - the perspective id for the window's initial page
Parameters:
input - the page input, or null if there is no currentinput. This is used to seed the input for the new page'sviews. the new workbench page
exception:
WorkbenchException - if a page could not be opened
See Also: IWorkbench.showPerspective(StringIWorkbenchWindowIAdaptable) |
| openPage | | public IWorkbenchPage openPage(IAdaptable input) throws WorkbenchException(Code) | | Creates and opens a new workbench page. The default perspective is used
as a template for creating the page. The page becomes active.
Note: Since release 2.0, a window is limited to contain at most
one page. If a page exist in the window when this method is used, then
another window is created for the new page. Callers are strongly
recommended to use the IWorkbench.showPerspective APIs to
programmatically show a perspective.
Parameters:
input - the page input, or null if there is no currentinput. This is used to seed the input for the new page'sviews. the new workbench window
exception:
WorkbenchException - if a page could not be opened
See Also: IWorkbench.showPerspective(StringIWorkbenchWindowIAdaptable) |
| run | | public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException, InterruptedException(Code) | | This specialization of IRunnableContext#run(boolean, boolean,
IRunnableWithProgress) blocks until the runnable has been run,
regardless of the value of fork.
It is recommended that fork is set to
true in most cases. If fork is set to false,
the runnable will run in the UI thread and it is the runnable's
responsibility to call Display.readAndDispatch()
to ensure UI responsiveness.
since:
3.2 |
| setActivePage | | public void setActivePage(IWorkbenchPage page)(Code) | | Sets or clears the currently active page for this workbench window.
Parameters:
page - the new active page |
|
|