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

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemotePerspectiveDescriptor
extends IRemoteEclipseWrapper

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

Original documentation:
A perspective descriptor describes a perspective in an IPerspectiveRegistry.

A perspective is a template for view visibility, layout, and action visibility within a workbench page. There are two types of perspective: a predefined perspective and a custom perspective.

A predefined perspective is defined by an extension to the workbench's perspective extension point ("org.eclipse.ui.perspectives"). The extension defines a id, label, and IPerspectiveFactory. A perspective factory is used to define the initial layout for a page.
A custom perspective is defined by the user. In this case a predefined perspective is modified to suit a particular task and saved as a new perspective. The attributes for the perspective are stored in a separate file in the workbench's metadata directory.

Within a page the user can open any of the perspectives known to the workbench's perspective registry, typically by selecting one from the workbench's Open Perspective menu. When selected, the views and actions within the active page rearrange to reflect the perspective.

Method Summary

java.lang.String	getDescription() Returns the description of this perspective.
java.lang.String	getId() Returns this perspective's id.
java.lang.String	getLabel() Returns this perspective's label.

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

_internalGetId, equalWrappedObjects

Method Detail

getDescription

java.lang.String getDescription()
                                throws RemoteEclipseAPIException

Returns the description of this perspective. This is the value of its "description" attribute.

Returns:

the description

Throws:

RemoteEclipseAPIException

getId

java.lang.String getId()
                       throws RemoteEclipseAPIException

Returns this perspective's id. For perspectives declared via an extension, this is the value of its "id" attribute.

Returns:

the perspective id

Throws:

RemoteEclipseAPIException

getLabel

java.lang.String getLabel()
                          throws RemoteEclipseAPIException

Returns this perspective's label. For perspectives declared via an extension, this is the value of its "label" attribute.

Returns:

the label

Throws:

RemoteEclipseAPIException