Eclipse Platform
Release 3.1

org.eclipse.ui.wizards
Interface IWizardCategory


public interface IWizardCategory

A wizard category may contain other categories or wizard elements.

This interface is not intended to be implemented by clients.

Since:
3.1

Method Summary
 IWizardCategory findCategory(IPath path)
          Returns the category child object corresponding to the passed path (relative to this object), or null if such an object could not be found.
 IWizardDescriptor findWizard(String id)
          Find a wizard that has the provided id.
 IWizardCategory[] getCategories()
          Return the immediate child categories.
 String getId()
          Return the identifier of this category.
 String getLabel()
          Return the label for this category.
 IWizardCategory getParent()
          Return the parent category.
 IPath getPath()
          Return this wizards path.
 IWizardDescriptor[] getWizards()
          Return the wizards in this category.
 

Method Detail

findCategory

public IWizardCategory findCategory(IPath path)
Returns the category child object corresponding to the passed path (relative to this object), or null if such an object could not be found. The segments of this path should correspond to category ids.

Parameters:
path - the search path
Returns:
the category or null

findWizard

public IWizardDescriptor findWizard(String id)
Find a wizard that has the provided id. This will search recursivly over this categories children.

Parameters:
id - the id to search for
Returns:
the wizard or null

getCategories

public IWizardCategory[] getCategories()
Return the immediate child categories.

Returns:
the child categories. Never null.

getId

public String getId()
Return the identifier of this category.

Returns:
the identifier of this category

getLabel

public String getLabel()
Return the label for this category.

Returns:
the label for this category

getParent

public IWizardCategory getParent()
Return the parent category.

Returns:
the parent category. May be null.

getPath

public IPath getPath()
Return this wizards path. The segments of this path will correspond to category ids.

Returns:
the path

getWizards

public IWizardDescriptor[] getWizards()
Return the wizards in this category.

Returns:
the wizards in this category. Never null

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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