com.mindoo.remote.api.org.eclipse.ui
Interface IRemoteWorkbenchWindow

All Superinterfaces:

IRemoteEclipseWrapper, IRemotePageService, IRemoteServiceLocator

public interface IRemoteWorkbenchWindow
extends IRemoteServiceLocator, IRemotePageService, IRemoteEclipseWrapper

Remote API Wrapper for the org.eclipse.ui.IWorkbenchWindow (Online documentation)

Original documentation:
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.

Field Summary

Fields inherited from interface com.mindoo.remote.api.org.eclipse.ui.IRemotePageService

ALLEVENTS, PERSPECTIVEACTIVATED, PERSPECTIVECHANGED

Method Summary

IRemoteWorkbenchPage	getActivePage() Returns the currently active page for this workbench window.
IRemoteWorkbenchPage[]	getPages() Returns a list of the pages in this workbench window.
IRemotePartService	getPartService() Returns the part service which tracks part activation within this workbench window.
IRemoteSelectionService	getSelectionService() Returns the selection service which tracks selection within this workbench window.
IRemoteWorkbenchWindowWithShelfPages	getShelfPagesAdapter() Helper method to access the side shelf

Methods inherited from interface com.mindoo.remote.api.org.eclipse.ui.services.IRemoteServiceLocator

getService, hasService

Methods inherited from interface com.mindoo.remote.api.org.eclipse.ui.IRemotePageService

addPerspectiveListenerSSJSLib, removePerspectiveListenerSSJSLib

Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper

_internalGetId, equalWrappedObjects

Method Detail

getActivePage

IRemoteWorkbenchPage getActivePage()
                                   throws RemoteEclipseAPIException

Returns the currently active page for this workbench window.

Returns:

the active page, or null if none

Throws:

RemoteEclipseAPIException

getPages

IRemoteWorkbenchPage[] getPages()
                                throws RemoteEclipseAPIException

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.

Returns:

a list of pages

Throws:

RemoteEclipseAPIException

getPartService

IRemotePartService getPartService()
                                  throws RemoteEclipseAPIException

Returns the part service which tracks part activation within this workbench window.

Returns:

the part service

Throws:

RemoteEclipseAPIException

getSelectionService

IRemoteSelectionService getSelectionService()
                                            throws RemoteEclipseAPIException

Returns the selection service which tracks selection within this workbench window.

Returns:

the selection service

Throws:

RemoteEclipseAPIException

getShelfPagesAdapter

IRemoteWorkbenchWindowWithShelfPages getShelfPagesAdapter()
                                                          throws RemoteEclipseAPIException

Helper method to access the side shelf

Returns:

sideshelf access

Throws:

RemoteEclipseAPIException