com.mindoo.remote.api.com.ibm.rcp.ui.shelf
Interface IRemoteWorkbenchWindowWithShelfPages

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemoteWorkbenchWindowWithShelfPages
extends IRemoteEclipseWrapper

Remote API Wrapper for the com.ibm.rcp.ui.shelf.IWorkbenchWindowWithShelfPages (Online documentation)

Original documentation:
A workbench window with 0 or more peripheral shelf pages. This class may be used to access ShelfPage API, including methods to show or hide a view, as well as change the size of the sidebar. This can be done as follows:
To access a ShelfPage object and, for example, hide a view:

// Substitute appropriate ShelfPage ID
IRemoteShelfPage shelfPage = windowWithShelfPages.getShelfPage(IRemoteWorkbenchWindowWithShelfPages.RIGHT);
if(shelfPage != null) {
IRemoteViewReference viewRef = shelfPage.findView(id);
if(viewRef!=null && (viewRef instanceof IRemoteShelfViewReference)) {
return shelfPage.hideView(viewRef);
}
}

Useful ShelfPage public methods:

public IRemoteViewPart showView(String viewId, String secondaryId, int mode)
public void hideView(IRemoteViewReference ref)

Set the width of the shelf area appropriately for the given mode (ShelfPage.COLLAPSED, ShelfPage.THIN, ShelfPage.EXPANDED):

public void setMode(int mode)

Field Summary

static java.lang.String	LEFT Constant identifier for left shelf page
static java.lang.String	RIGHT Constant identifier for right shelf page

Method Summary

IRemoteShelfPage	getShelfPage(java.lang.String id) Returns the shelf page with the specified id.
IRemoteShelfPage[]	getShelfPages() Returns a list of shelf pages.

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

_internalGetId, equalWrappedObjects

Field Detail

LEFT

static final java.lang.String LEFT

Constant identifier for left shelf page

See Also:

Constant Field Values

RIGHT

static final java.lang.String RIGHT

Constant identifier for right shelf page

See Also:

Constant Field Values

Method Detail

getShelfPages

IRemoteShelfPage[] getShelfPages()
                                 throws RemoteEclipseAPIException

Returns a list of shelf pages.

Returns:

a list o shelf pages

Throws:

RemoteEclipseAPIException

getShelfPage

IRemoteShelfPage getShelfPage(java.lang.String id)
                              throws RemoteEclipseAPIException

Returns the shelf page with the specified id.

Parameters:

id - the id of the shelf page

Returns:

the shelf page

Throws:

RemoteEclipseAPIException