KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > wizards > IWizardRegistry


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.wizards;
12
13
14 /**
15  * A registry describing all wizard extensions known to the workbench.
16  * <p>
17  * This interface is not intended to be implemented by clients.
18  * </p>
19  *
20  * @since 3.1
21  */
22 public interface IWizardRegistry {
23
24     /**
25      * Find a wizard with the given id.
26      *
27      * @param id the id to search for
28      * @return the wizard descriptor matching the given id or <code>null</code>
29      */
30     IWizardDescriptor findWizard(String JavaDoc id);
31     
32     /**
33      * Return the wizards that have been designated as "primary".
34      *
35      * @return the primary wizard descriptors. Never <code>null</code>.
36      */
37     IWizardDescriptor [] getPrimaryWizards();
38
39     /**
40      * Find the category with the given id.
41      *
42      * @param id the id of the category to search for
43      * @return the category matching the given id or <code>null</code>
44      */
45     IWizardCategory findCategory(String JavaDoc id);
46     
47     /**
48      * Return the root category.
49      *
50      * @return the root category. Never <code>null</code>.
51      */
52     IWizardCategory getRootCategory();
53 }
54
Popular Tags