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

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemotePerspectiveRegistry
extends IRemoteEclipseWrapper

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

Original documentation:
The workbench's global registry of perspectives.

This registry contains a descriptor for each perspectives in the workbench. It is initially populated with stock perspectives from the workbench's perspective extension point ("org.eclipse.ui.perspectives") and with custom perspectives defined by the user.

Method Summary

IRemotePerspectiveDescriptor	clonePerspective(java.lang.String id, java.lang.String label, IRemotePerspectiveDescriptor originalDescriptor) Clones an existing perspective.
IRemotePerspectiveDescriptor	findPerspectiveWithId(java.lang.String perspectiveId) Finds and returns the registered perspective with the given perspective id.
IRemotePerspectiveDescriptor[]	getPerspectives() Returns a list of the perspectives known to the workbench.

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

_internalGetId, equalWrappedObjects

Method Detail

getPerspectives

IRemotePerspectiveDescriptor[] getPerspectives()
                                               throws RemoteEclipseAPIException

Returns a list of the perspectives known to the workbench.

Returns:

a list of perspectives

Throws:

RemoteEclipseAPIException

findPerspectiveWithId

IRemotePerspectiveDescriptor findPerspectiveWithId(java.lang.String perspectiveId)
                                                   throws RemoteEclipseAPIException

Finds and returns the registered perspective with the given perspective id.

Parameters:

perspectiveId - the perspective id

Returns:

the perspective, or null if none

Throws:

RemoteEclipseAPIException

clonePerspective

IRemotePerspectiveDescriptor clonePerspective(java.lang.String id,
                                              java.lang.String label,
                                              IRemotePerspectiveDescriptor originalDescriptor)
                                              throws RemoteEclipseAPIException

Clones an existing perspective.

Parameters:

id - the id for the cloned perspective, which must not already be used by any registered perspective

label - the label assigned to the cloned perspective

originalDescriptor - the perspective to clone

Returns:

the cloned perspective descriptor

Throws:

RemoteEclipseAPIException