| /******************************************************************************* |
| * Copyright (c) 2000, 2004 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.team.internal.ui.wizards; |
| |
| |
| import org.eclipse.core.resources.IProject; |
| import org.eclipse.core.runtime.*; |
| import org.eclipse.jface.wizard.IWizardPage; |
| import org.eclipse.jface.wizard.Wizard; |
| import org.eclipse.team.internal.ui.*; |
| import org.eclipse.team.ui.IConfigurationWizard; |
| import org.eclipse.ui.IWorkbench; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.activities.IActivityManager; |
| import org.eclipse.ui.activities.IIdentifier; |
| import org.eclipse.ui.model.AdaptableList; |
| |
| /** |
| * The wizard for associating projects with team providers |
| */ |
| public class ConfigureProjectWizard extends Wizard implements IConfigurationWizard { |
| protected IWorkbench workbench; |
| protected IProject project; |
| protected IConfigurationWizard wizard; |
| |
| protected ConfigureProjectWizardMainPage mainPage; |
| private String pluginId = TeamUIPlugin.PLUGIN_ID; |
| |
| protected final static String PT_CONFIGURATION ="configurationWizards"; //$NON-NLS-1$ |
| protected final static String TAG_WIZARD = "wizard"; //$NON-NLS-1$ |
| protected final static String TAG_DESCRIPTION = "description"; //$NON-NLS-1$ |
| protected final static String ATT_NAME = "name"; //$NON-NLS-1$ |
| protected final static String ATT_CLASS = "class"; //$NON-NLS-1$ |
| protected final static String ATT_ICON = "icon"; //$NON-NLS-1$ |
| protected final static String ATT_ID = "id"; //$NON-NLS-1$ |
| |
| public ConfigureProjectWizard() { |
| setNeedsProgressMonitor(true); |
| setWindowTitle(getWizardWindowTitle()); //$NON-NLS-1$ |
| } |
| |
| protected String getExtensionPoint() { |
| return PT_CONFIGURATION; |
| } |
| |
| protected String getWizardWindowTitle() { |
| return TeamUIMessages.ConfigureProjectWizard_title; //$NON-NLS-1$ |
| } |
| |
| protected String getWizardLabel() { |
| return TeamUIMessages.ConfigureProjectWizard_configureProject; //$NON-NLS-1$ |
| } |
| |
| protected String getWizardDescription() { |
| return TeamUIMessages.ConfigureProjectWizard_description; //$NON-NLS-1$ |
| } |
| |
| /* |
| * @see Wizard#addPages |
| */ |
| public void addPages() { |
| AdaptableList disabledWizards = new AdaptableList(); |
| AdaptableList wizards = getAvailableWizards(disabledWizards); |
| if (wizards.size() == 1 && disabledWizards.size() == 0) { |
| // If there is only one wizard, skip the first page. |
| // Only skip the first page if the one wizard has at least one page. |
| ConfigurationWizardElement element = (ConfigurationWizardElement)wizards.getChildren()[0]; |
| try { |
| this.wizard = (IConfigurationWizard)element.createExecutableExtension(); |
| wizard.init(workbench, project); |
| wizard.addPages(); |
| if (wizard.getPageCount() > 0) { |
| wizard.setContainer(getContainer()); |
| IWizardPage[] pages = wizard.getPages(); |
| for (int i = 0; i < pages.length; i++) { |
| addPage(pages[i]); |
| } |
| return; |
| } |
| } catch (CoreException e) { |
| TeamUIPlugin.log(e); |
| return; |
| } |
| } |
| mainPage = new ConfigureProjectWizardMainPage("configurePage1", getWizardLabel(), TeamUIPlugin.getImageDescriptor(ITeamUIImages.IMG_WIZBAN_SHARE), wizards, disabledWizards); //$NON-NLS-1$ |
| mainPage.setDescription(getWizardDescription()); |
| mainPage.setProject(project); |
| mainPage.setWorkbench(workbench); |
| addPage(mainPage); |
| } |
| public IWizardPage getNextPage(IWizardPage page) { |
| if (wizard != null) { |
| return wizard.getNextPage(page); |
| } |
| return super.getNextPage(page); |
| } |
| public boolean canFinish() { |
| // If we are on the first page, never allow finish unless the selected wizard has no pages. |
| if (getContainer().getCurrentPage() == mainPage) { |
| if (mainPage.getSelectedWizard() != null && mainPage.getNextPage() == null) { |
| return true; |
| } |
| return false; |
| } |
| if (wizard != null) { |
| return wizard.canFinish(); |
| } |
| return super.canFinish(); |
| } |
| /* |
| * @see Wizard#performFinish |
| */ |
| public boolean performFinish() { |
| // There is only one wizard with at least one page |
| if (wizard != null) { |
| return wizard.performFinish(); |
| } |
| // If we are on the first page and the selected wizard has no pages then |
| // allow it to finish. |
| if (getContainer().getCurrentPage() == mainPage) { |
| IConfigurationWizard noPageWizard = mainPage.getSelectedWizard(); |
| if (noPageWizard != null) { |
| if (noPageWizard.canFinish()) |
| { |
| return noPageWizard.performFinish(); |
| } |
| } |
| } |
| // If the wizard has pages and there are several |
| // wizards registered then the registered wizard |
| // will call it's own performFinish(). |
| return true; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.jface.wizard.IWizard#performCancel() |
| */ |
| public boolean performCancel() { |
| if (wizard != null) { |
| return wizard.performCancel(); |
| } |
| return super.performCancel(); |
| } |
| |
| /** |
| * Returns the configuration wizards that are available for invocation. |
| * |
| * @return the available wizards |
| */ |
| protected AdaptableList getAvailableWizards(AdaptableList disabledWizards) { |
| AdaptableList result = new AdaptableList(); |
| IExtensionRegistry registry = Platform.getExtensionRegistry(); |
| IExtensionPoint point = registry.getExtensionPoint(pluginId, getExtensionPoint()); |
| if (point != null) { |
| IExtension[] extensions = point.getExtensions(); |
| for (int i = 0; i < extensions.length; i++) { |
| IConfigurationElement[] elements = extensions[i].getConfigurationElements(); |
| for (int j = 0; j < elements.length; j++) { |
| IConfigurationElement element = elements[j]; |
| if (element.getName().equals(TAG_WIZARD)) { |
| ConfigurationWizardElement wizard = createWizardElement(element); |
| if (wizard != null && filterItem(element)) { |
| disabledWizards.add(wizard); |
| } else if (wizard != null) { |
| result.add(wizard); |
| } |
| } |
| } |
| } |
| } |
| return result; |
| } |
| |
| private boolean filterItem(IConfigurationElement element) { |
| String extensionId = element.getAttribute(ATT_ID); |
| String extensionPluginId = element.getNamespace(); |
| IActivityManager activityMgr = PlatformUI.getWorkbench().getActivitySupport().getActivityManager(); |
| IIdentifier id = activityMgr.getIdentifier(extensionPluginId + "/" + extensionId); //$NON-NLS-1$ |
| return (!id.isEnabled()); |
| } |
| |
| /** |
| * Returns a new ConfigurationWizardElement configured according to the parameters |
| * contained in the passed Registry. |
| * |
| * May answer null if there was not enough information in the Extension to create |
| * an adequate wizard |
| * |
| * @param element the element for which to create a wizard element |
| * @return the wizard element for the given element |
| */ |
| protected ConfigurationWizardElement createWizardElement(IConfigurationElement element) { |
| // WizardElements must have a name attribute |
| String nameString = element.getAttribute(ATT_NAME); |
| if (nameString == null) { |
| // Missing attribute |
| return null; |
| } |
| ConfigurationWizardElement result = new ConfigurationWizardElement(nameString); |
| if (initializeWizard(result, element)) { |
| // initialization was successful |
| return result; |
| } |
| return null; |
| } |
| /** |
| * Initialize the passed element's properties based on the contents of |
| * the passed registry. Answer a boolean indicating whether the element |
| * was able to be adequately initialized. |
| * |
| * @param element the element to initialize the properties for |
| * @param extension the registry to get properties from |
| * @return whether initialization was successful |
| */ |
| protected boolean initializeWizard(ConfigurationWizardElement element, IConfigurationElement config) { |
| element.setID(config.getAttribute(ATT_ID)); |
| String description = ""; //$NON-NLS-1$ |
| IConfigurationElement [] children = config.getChildren(TAG_DESCRIPTION); |
| if (children.length >= 1) { |
| description = children[0].getValue(); |
| } |
| |
| element.setDescription(description); |
| |
| // apply CLASS and ICON properties |
| element.setConfigurationElement(config); |
| String iconName = config.getAttribute(ATT_ICON); |
| if (iconName != null) { |
| IExtension extension = config.getDeclaringExtension(); |
| element.setImageDescriptor(TeamUIPlugin.getImageDescriptorFromExtension(extension, iconName)); |
| } |
| // ensure that a class was specified |
| if (element.getConfigurationElement() == null) { |
| // Missing attribute |
| return false; |
| } |
| setForcePreviousAndNextButtons(true); |
| return true; |
| } |
| /* |
| * Method declared on IConfigurationWizard |
| */ |
| public void init(IWorkbench workbench, IProject project) { |
| this.workbench = workbench; |
| this.project = project; |
| } |
| } |