diff options
Diffstat (limited to 'bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java')
| -rw-r--r-- | bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java | 137 |
1 files changed, 70 insertions, 67 deletions
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java index 4f200fcf0a7..40936a27ba1 100644 --- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java +++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IPerspectiveRegistry.java @@ -20,27 +20,30 @@ package org.eclipse.ui; * It is initially populated with stock perspectives from the workbench's * perspective extension point (<code>"org.eclipse.ui.perspectives"</code>) and * with custom perspectives defined by the user. - * </p><p> + * </p> + * <p> * This interface is not intended to be implemented by clients. * </p> + * * @see IWorkbench#getPerspectiveRegistry * @noimplement This interface is not intended to be implemented by clients. */ public interface IPerspectiveRegistry { - /** - * Clones an existing perspective. - * - * @param id the id for the cloned perspective, which must not already be used by - * any registered perspective - * @param label the label assigned to the cloned perspective - * @param desc the perspective to clone - * @return the cloned perspective descriptor - * @throws IllegalArgumentException if there is already a perspective with the given id - * - * @since 3.0 - */ - IPerspectiveDescriptor clonePerspective(String id, String label, - IPerspectiveDescriptor desc) throws IllegalArgumentException; + /** + * Clones an existing perspective. + * + * @param id the id for the cloned perspective, which must not already be + * used by any registered perspective + * @param label the label assigned to the cloned perspective + * @param desc the perspective to clone + * @return the cloned perspective descriptor + * @throws IllegalArgumentException if there is already a perspective with the + * given id + * + * @since 3.0 + */ + IPerspectiveDescriptor clonePerspective(String id, String label, IPerspectiveDescriptor desc) + throws IllegalArgumentException; /** * Deletes a perspective. Has no effect if the perspective is defined in an @@ -51,61 +54,61 @@ public interface IPerspectiveRegistry { */ void deletePerspective(IPerspectiveDescriptor persp); - /** - * Finds and returns the registered perspective with the given perspective id. - * - * @param perspectiveId the perspective id - * @return the perspective, or <code>null</code> if none - * @see IPerspectiveDescriptor#getId - */ - IPerspectiveDescriptor findPerspectiveWithId(String perspectiveId); + /** + * Finds and returns the registered perspective with the given perspective id. + * + * @param perspectiveId the perspective id + * @return the perspective, or <code>null</code> if none + * @see IPerspectiveDescriptor#getId + */ + IPerspectiveDescriptor findPerspectiveWithId(String perspectiveId); - /** - * Finds and returns the registered perspective with the given label. - * - * @param label the label - * @return the perspective, or <code>null</code> if none - * @see IPerspectiveDescriptor#getLabel - */ - IPerspectiveDescriptor findPerspectiveWithLabel(String label); + /** + * Finds and returns the registered perspective with the given label. + * + * @param label the label + * @return the perspective, or <code>null</code> if none + * @see IPerspectiveDescriptor#getLabel + */ + IPerspectiveDescriptor findPerspectiveWithLabel(String label); - /** - * Returns the id of the default perspective for the workbench. This identifies one - * perspective extension within the workbench's perspective registry. - * <p> - * Returns <code>null</code> if there is no default perspective. - * </p> - * - * @return the default perspective id, or <code>null</code> - */ - String getDefaultPerspective(); + /** + * Returns the id of the default perspective for the workbench. This identifies + * one perspective extension within the workbench's perspective registry. + * <p> + * Returns <code>null</code> if there is no default perspective. + * </p> + * + * @return the default perspective id, or <code>null</code> + */ + String getDefaultPerspective(); - /** - * Returns a list of the perspectives known to the workbench. - * - * @return a list of perspectives - */ - IPerspectiveDescriptor[] getPerspectives(); + /** + * Returns a list of the perspectives known to the workbench. + * + * @return a list of perspectives + */ + IPerspectiveDescriptor[] getPerspectives(); - /** - * Sets the default perspective for the workbench to the given perspective id. - * If non-<code>null</code>, the id must correspond to a perspective extension - * within the workbench's perspective registry. - * <p> - * A <code>null</code> id indicates no default perspective. - * </p> - * - * @param id a perspective id, or <code>null</code> - */ - void setDefaultPerspective(String id); + /** + * Sets the default perspective for the workbench to the given perspective id. + * If non-<code>null</code>, the id must correspond to a perspective extension + * within the workbench's perspective registry. + * <p> + * A <code>null</code> id indicates no default perspective. + * </p> + * + * @param id a perspective id, or <code>null</code> + */ + void setDefaultPerspective(String id); - /** - * Reverts a perspective back to its original definition - * as specified in the plug-in manifest. - * - * @param perspToRevert the perspective to revert - * - * @since 3.0 - */ - void revertPerspective(IPerspectiveDescriptor perspToRevert); + /** + * Reverts a perspective back to its original definition as specified in the + * plug-in manifest. + * + * @param perspToRevert the perspective to revert + * + * @since 3.0 + */ + void revertPerspective(IPerspectiveDescriptor perspToRevert); } |