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

All Superinterfaces:

IRemoteEclipseWrapper

All Known Subinterfaces:

IRemoteShelfViewReference, IRemoteViewReference

public interface IRemoteWorkbenchPartReference
extends IRemoteEclipseWrapper

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

Original documentation:
Implements a reference to a IWorkbenchPart. The IWorkbenchPart will not be instantiated until the part becomes visible or the API getPart is sent with true;

Method Summary

java.lang.String	getContentDescription() Returns the content description for the part (or the empty string if none)
java.lang.String	getId()
IRemoteWorkbenchPage	getPage() Returns the workbench page that contains this part
IRemoteWorkbenchPart	getPart(boolean restore) Returns the IWorkbenchPart referenced by this object.
java.lang.String	getPartName() Returns the name of the part, as it should be shown in tabs.
java.lang.String	getTitle()

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

_internalGetId, equalWrappedObjects

Method Detail

getId

java.lang.String getId()
                       throws RemoteEclipseAPIException

Throws:

RemoteEclipseAPIException

getTitle

java.lang.String getTitle()
                          throws RemoteEclipseAPIException

Throws:

RemoteEclipseAPIException

See Also:

IRemoteWorkbenchPart.getTitle()

getPage

IRemoteWorkbenchPage getPage()
                             throws RemoteEclipseAPIException

Returns the workbench page that contains this part

Returns:

page

Throws:

RemoteEclipseAPIException

getPartName

java.lang.String getPartName()
                             throws RemoteEclipseAPIException

Returns the name of the part, as it should be shown in tabs.

Returns:

the part name

Throws:

RemoteEclipseAPIException

getContentDescription

java.lang.String getContentDescription()
                                       throws RemoteEclipseAPIException

Returns the content description for the part (or the empty string if none)

Returns:

the content description for the part

Throws:

RemoteEclipseAPIException

getPart

IRemoteWorkbenchPart getPart(boolean restore)
                             throws RemoteEclipseAPIException

Returns the IWorkbenchPart referenced by this object.

Parameters:

restore - tries to restore the part if true.

Returns:

the part, or null if the part was not instantiated or it failed to be restored.

Throws:

RemoteEclipseAPIException