org.eclipse.ui.wizards.IWizardRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2004, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.wizards;


/**
 * A registry describing all wizard extensions known to the workbench.
 * 
 * This interface is not intended to be implemented by clients.
 * 
 *
 * @since 3.1
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IWizardRegistry {

	/**
	 * Find a wizard with the given id.
	 *
	 * @param id the id to search for
	 * @return the wizard descriptor matching the given id or null
	 */
	IWizardDescriptor findWizard(String id);

	/**
	 * Return the wizards that have been designated as "primary".
	 *
	 * @return the primary wizard descriptors.  Never null.
	 */
	IWizardDescriptor [] getPrimaryWizards();

	/**
	 * Find the category with the given id.
	 *
	 * @param id the id of the category to search for
	 * @return the category matching the given id or null
	 */
	IWizardCategory findCategory(String id);

	/**
	 * Return the root category.
	 *
	 * @return the root category.  Never null.
	 */
	IWizardCategory getRootCategory();
}