IWizardCategory


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  import org.eclipse.core.runtime.IPath;
14  
15  /**
16   * A wizard category may contain other categories or wizard elements. 
17   * <p>
18   * This interface is not intended to be implemented by clients.
19   * </p>
20   * 
21   * @since 3.1
22   */
23  public interface IWizardCategory {
24  
25      /**
26       * Returns the category child object corresponding to the passed path
27       * (relative to this object), or <code>null</code> if such an object could
28       * not be found.  The segments of this path should correspond to category ids.
29       * 
30       * @param path
31       *            the search path
32       * @return the category or <code>null</code>
33       */
34      IWizardCategory findCategory(IPath path);
35  
36      /**
37       * Find a wizard that has the provided id. This will search recursivly over
38       * this categories children.
39       * 
40       * @param id
41       *            the id to search for
42       * @return the wizard or <code>null</code>
43       */
44      IWizardDescriptor findWizard(String   id);
45  
46      /**
47       * Return the immediate child categories.
48       * 
49       * @return the child categories. Never <code>null</code>.
50       */
51      IWizardCategory[] getCategories();
52  
53      /**
54       * Return the identifier of this category.
55       * 
56       * @return the identifier of this category
57       */
58      String   getId();
59  
60      /**
61       * Return the label for this category.
62       * 
63       * @return the label for this category
64       */
65      String   getLabel();
66  
67      /**
68       * Return the parent category.
69       * 
70       * @return the parent category. May be <code>null</code>.
71       */
72      IWizardCategory getParent();
73  
74      /**
75       * Return this wizards path. The segments of this path will correspond to
76       * category ids.
77       * 
78       * @return the path
79       */
80      IPath getPath();
81  
82      /**
83       * Return the wizards in this category.
84       * 
85       * @return the wizards in this category. Never <code>null</code>
86       */
87      IWizardDescriptor[] getWizards();
88  }
89
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags