|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IPerspectiveRegistry
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.
This interface is not intended to be implemented by clients.
IWorkbench.getPerspectiveRegistry()| Method Summary | |
|---|---|
IPerspectiveDescriptor |
clonePerspective(String id,
String label,
IPerspectiveDescriptor desc)
Clones an existing perspective. |
void |
deletePerspective(IPerspectiveDescriptor persp)
Deletes a perspective. |
IPerspectiveDescriptor |
findPerspectiveWithId(String perspectiveId)
Finds and returns the registered perspective with the given perspective id. |
IPerspectiveDescriptor |
findPerspectiveWithLabel(String label)
Finds and returns the registered perspective with the given label. |
String |
getDefaultPerspective()
Returns the id of the default perspective for the workbench. |
IPerspectiveDescriptor[] |
getPerspectives()
Returns a list of the perspectives known to the workbench. |
void |
revertPerspective(IPerspectiveDescriptor perspToRevert)
Reverts a perspective back to its original definition as specified in the plug-in manifest. |
void |
setDefaultPerspective(String id)
Sets the default perspective for the workbench to the given perspective id. |
| Method Detail |
|---|
IPerspectiveDescriptor clonePerspective(String id,
String label,
IPerspectiveDescriptor desc)
throws IllegalArgumentException
id - the id for the cloned perspective, which must not already be used by
any registered perspectivelabel - the label assigned to the cloned perspectivedesc - the perspective to clone
IllegalArgumentException - if there is already a perspective with the given idvoid deletePerspective(IPerspectiveDescriptor persp)
persp - the perspective to deleteIPerspectiveDescriptor findPerspectiveWithId(String perspectiveId)
perspectiveId - the perspective id
null if noneIPerspectiveDescriptor.getId()IPerspectiveDescriptor findPerspectiveWithLabel(String label)
label - the label
null if noneIPerspectiveDescriptor.getLabel()String getDefaultPerspective()
Returns null if there is no default perspective.
nullIPerspectiveDescriptor[] getPerspectives()
void setDefaultPerspective(String id)
null, the id must correspond to a perspective extension
within the workbench's perspective registry.
A null id indicates no default perspective.
id - a perspective id, or nullvoid revertPerspective(IPerspectiveDescriptor perspToRevert)
perspToRevert - the perspective to revert
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.