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

All Superinterfaces:

IRemoteEclipseWrapper, IRemoteWorkbenchPartReference

All Known Subinterfaces:

IRemoteShelfViewReference

public interface IRemoteViewReference
extends IRemoteWorkbenchPartReference, IRemoteEclipseWrapper

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

Original documentation:
Defines a reference to an IViewPart.

Method Summary

java.lang.String	getSecondaryId() Returns the secondary ID for the view.
IRemoteViewPart	getView(boolean restore) Returns the IRemoteViewPart referenced by this object.

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

getContentDescription, getId, getPage, getPart, getPartName, getTitle

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

_internalGetId, equalWrappedObjects

Method Detail

getSecondaryId

java.lang.String getSecondaryId()
                                throws RemoteEclipseAPIException

Returns the secondary ID for the view.

Returns:

the secondary ID, or null if there is no secondary id

Throws:

RemoteEclipseAPIException

getView

IRemoteViewPart getView(boolean restore)
                        throws RemoteEclipseAPIException

Returns the IRemoteViewPart referenced by this object. Returns null if the view was not instantiated or it failed to be restored. Tries to restore the view if restore is true.

Parameters:

restore - true to restore

Returns:

viewpart

Throws:

RemoteEclipseAPIException