Eclipse Platform
Release 3.1

org.eclipse.ui
Interface IPerspectiveRegistry


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.

See Also:
IWorkbench.getPerspectiveRegistry()

Method Summary
 IPerspectiveDescriptor clonePerspective(String id, String label, IPerspectiveDescriptor desc)
          Clones an existing 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

clonePerspective

public IPerspectiveDescriptor clonePerspective(String id,
                                               String label,
                                               IPerspectiveDescriptor desc)
                                        throws IllegalArgumentException
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
desc - the perspective to clone
Returns:
the cloned perspective descriptor
Throws:
IllegalArgumentException
Since:
3.0

findPerspectiveWithId

public IPerspectiveDescriptor findPerspectiveWithId(String perspectiveId)
Finds and returns the registered perspective with the given perspective id.

Parameters:
perspectiveId - the perspective id
Returns:
the perspective, or null if none
See Also:
IPerspectiveDescriptor.getId()

findPerspectiveWithLabel

public IPerspectiveDescriptor findPerspectiveWithLabel(String label)
Finds and returns the registered perspective with the given label.

Parameters:
label - the label
Returns:
the perspective, or null if none
See Also:
IPerspectiveDescriptor.getLabel()

getDefaultPerspective

public String getDefaultPerspective()
Returns the id of the default perspective for the workbench. This identifies one perspective extension within the workbench's perspective registry.

Returns null if there is no default perspective.

Returns:
the default perspective id, or null

getPerspectives

public IPerspectiveDescriptor[] getPerspectives()
Returns a list of the perspectives known to the workbench.

Returns:
a list of perspectives

setDefaultPerspective

public void setDefaultPerspective(String id)
Sets the default perspective for the workbench to the given perspective id. If non-null, the id must correspond to a perspective extension within the workbench's perspective registry.

A null id indicates no default perspective.

Parameters:
id - a perspective id, or null

revertPerspective

public void revertPerspective(IPerspectiveDescriptor perspToRevert)
Reverts a perspective back to its original definition as specified in the plug-in manifest.

Parameters:
perspToRevert - the perspective to revert
Since:
3.0

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.