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

All Superinterfaces:

IRemoteEclipseWrapper

All Known Subinterfaces:

IRemoteViewPart

public interface IRemoteWorkbenchPart
extends IRemoteEclipseWrapper

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

Original documentation:
A workbench part is a visual component within a workbench page. There are two subtypes: view and editor, as defined by IViewPart and IEditorPart.

A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor. Modifications made in a view are saved immediately.

Method Summary

IRemoteWorkbenchPartSite	getSite() Returns the site for this workbench part.
java.lang.String	getTitle() Returns the title of this workbench part.
java.lang.String	getTitleToolTip() Returns the title tool tip text of this workbench part.

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

_internalGetId, equalWrappedObjects

Method Detail

getSite

IRemoteWorkbenchPartSite getSite()
                                 throws RemoteEclipseAPIException

Returns the site for this workbench part. The site can be null while the workbench part is being initialized. After the initialization is complete, this value must be non-null for the remainder of the part's life cycle.

Returns:

The part site; this value may be null if the part has not yet been initialized

Throws:

RemoteEclipseAPIException

getTitle

java.lang.String getTitle()
                          throws RemoteEclipseAPIException

Returns the title of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

The title is used to populate the title bar of this part's visual container.

Returns:

the workbench part title (not null)

Throws:

RemoteEclipseAPIException

getTitleToolTip

java.lang.String getTitleToolTip()
                                 throws RemoteEclipseAPIException

Returns the title tool tip text of this workbench part. An empty string result indicates no tool tip. If this value changes the part must fire a property listener event with PROP_TITLE.

The tool tip text is used to populate the title bar of this part's visual container.

Returns:

the workbench part title tool tip (not null)

Throws:

RemoteEclipseAPIException