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

All Superinterfaces:

IRemoteEclipseWrapper, IRemoteWorkbenchPart

public interface IRemoteViewPart
extends IRemoteWorkbenchPart, IRemoteEclipseWrapper

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

Original documentation:
A view is a visual component within a workbench page. It 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 (in contrast to an editor part, which conforms to a more elaborate open-save-close lifecycle).

Only one instance of a particular view type may exist within a workbench page. This policy is designed to simplify part management for a user.

This interface may be implemented directly. For convenience, a base implementation is defined in ViewPart.

A view is added to the workbench in two steps:

1. A view extension is contributed to the workbench registry. This extension defines the extension id and extension class.
2. The view is included in the default layout for a perspective. Alternatively, the user may open the view from the Perspective menu.

Method Summary

IRemoteViewSite

getViewSite() Returns the site for this view.

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

getSite, getTitle, getTitleToolTip

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

_internalGetId, equalWrappedObjects

Method Detail

getViewSite

IRemoteViewSite getViewSite()
                            throws RemoteEclipseAPIException

Returns the site for this view.

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

Returns:

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

Throws:

RemoteEclipseAPIException