Java tutorial
/******************************************************************************* * Copyright (c) 2009, 2011 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 com.siteview.mde.internal.ui.shared.target; import java.io.File; import java.util.ArrayList; import java.util.List; import org.eclipse.core.runtime.*; import org.eclipse.jface.dialogs.*; import org.eclipse.jface.viewers.*; import org.eclipse.jface.wizard.*; import com.siteview.mde.internal.core.MDECore; import com.siteview.mde.internal.core.target.provisional.*; import com.siteview.mde.internal.ui.*; import com.siteview.mde.internal.ui.wizards.WizardElement; import com.siteview.mde.ui.IProvisionerWizard; import org.eclipse.swt.SWT; import org.eclipse.swt.custom.SashForm; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.graphics.Point; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Text; import org.eclipse.ui.*; import org.eclipse.ui.activities.WorkbenchActivityHelper; /** * Wizard page for selecting the type of bundle container to be added to a target * * @see AddBundleContainerWizard * @see IBundleContainer */ public class AddBundleContainerSelectionPage extends WizardSelectionPage { /** * Extension point that provides target provisioner wizard */ private static final String PROVISIONER_POINT = "targetProvisioners"; //$NON-NLS-1$ /** * Section in the dialog settings for this wizard and the wizards created with selection * Shared with the EditBundleContainerWizard */ static final String SETTINGS_SECTION = "editBundleContainerWizard"; //$NON-NLS-1$ private static ITargetPlatformService fTargetService; private Text fDescription; private ITargetDefinition fTarget; protected AddBundleContainerSelectionPage(ITargetDefinition target) { super("SelectionPage"); //$NON-NLS-1$ setTitle(Messages.AddBundleContainerSelectionPage_1); setMessage(Messages.AddBundleContainerSelectionPage_2); MDEPlugin.getDefault().getLabelProvider().connect(this); fTarget = target; } /** * Gets the target platform service provided by PDE Core * @return the target platform service * @throws CoreException if unable to acquire the service */ private static ITargetPlatformService getTargetPlatformService() throws CoreException { if (fTargetService == null) { fTargetService = (ITargetPlatformService) MDECore.getDefault() .acquireService(ITargetPlatformService.class.getName()); if (fTargetService == null) { throw new CoreException( new Status(IStatus.ERROR, MDECore.PLUGIN_ID, Messages.AddDirectoryContainerPage_9)); } } return fTargetService; } /* (non-Javadoc) * @see org.eclipse.jface.wizard.WizardSelectionPage#dispose() */ public void dispose() { MDEPlugin.getDefault().getLabelProvider().disconnect(this); super.dispose(); } /* (non-Javadoc) * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite) */ public void createControl(Composite parent) { Composite comp = SWTFactory.createComposite(parent, 1, 1, GridData.FILL_BOTH, 0, 0); SashForm sashForm = new SashForm(comp, SWT.VERTICAL); GridData gd = new GridData(GridData.FILL_BOTH); // limit the width of the sash form to avoid the wizard opening very wide. gd.widthHint = 300; sashForm.setLayoutData(gd); sashForm.setFont(comp.getFont()); TableViewer wizardSelectionViewer = new TableViewer(sashForm, SWT.BORDER); wizardSelectionViewer.setContentProvider(new ArrayContentProvider()); wizardSelectionViewer.setLabelProvider(new LabelProvider() { public String getText(Object element) { if (element instanceof AbstractBundleContainerNode) { return ((AbstractBundleContainerNode) element).getName(); } return super.getText(element); } public Image getImage(Object element) { if (element instanceof AbstractBundleContainerNode) { return ((AbstractBundleContainerNode) element).getImage(); } return super.getImage(element); } }); wizardSelectionViewer.addDoubleClickListener(new IDoubleClickListener() { public void doubleClick(DoubleClickEvent event) { IStructuredSelection selection = (IStructuredSelection) event.getSelection(); if (!selection.isEmpty()) { setSelectedNode((IWizardNode) selection.getFirstElement()); getContainer().showPage(getNextPage()); } } }); wizardSelectionViewer.addSelectionChangedListener(new ISelectionChangedListener() { public void selectionChanged(SelectionChangedEvent event) { IStructuredSelection selection = (IStructuredSelection) event.getSelection(); if (!selection.isEmpty()) { fDescription .setText(((AbstractBundleContainerNode) selection.getFirstElement()).getDescription()); setSelectedNode((AbstractBundleContainerNode) selection.getFirstElement()); } } }); wizardSelectionViewer.getTable().setLayoutData(new GridData(GridData.FILL_BOTH)); wizardSelectionViewer.getTable().setFont(sashForm.getFont()); fDescription = SWTFactory.createText(sashForm, SWT.READ_ONLY | SWT.BORDER | SWT.MULTI | SWT.WRAP, 1); sashForm.setWeights(new int[] { 70, 30 }); initViewerContents(wizardSelectionViewer); setControl(comp); PlatformUI.getWorkbench().getHelpSystem().setHelp(parent, IHelpContextIds.ADD_LOCATION_WIZARD); } /** * Creates the IWizardNode instances that provide choices for the user to select * @param wizardSelectionViewer */ private void initViewerContents(TableViewer wizardSelectionViewer) { List choices = new ArrayList(); choices.addAll(getStandardChoices()); choices.addAll(getProvisionerExtensionChoices()); wizardSelectionViewer.setInput(choices.toArray(new IWizardNode[choices.size()])); } /** * Returns the standard choices of bundle containers to create * @return list of wizard nodes */ private List getStandardChoices() { List standardChoices = new ArrayList(4); // Directory Containers standardChoices.add(new AbstractBundleContainerNode(Messages.AddBundleContainerSelectionPage_3, Messages.AddBundleContainerSelectionPage_4, PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_OBJ_FOLDER)) { public IWizard createWizard() { Wizard wizard = new Wizard() { private EditDirectoryContainerPage fPage1; public void addPages() { IDialogSettings settings = MDEPlugin.getDefault().getDialogSettings() .getSection(SETTINGS_SECTION); if (settings == null) { settings = MDEPlugin.getDefault().getDialogSettings().addNewSection(SETTINGS_SECTION); } setDialogSettings(settings); fPage1 = new EditDirectoryContainerPage(); addPage(fPage1); addPage(new PreviewContainerPage(fTarget, fPage1)); setNeedsProgressMonitor(true); } public boolean performFinish() { IBundleContainer container = fPage1.getBundleContainer(); if (container != null) { fPage1.storeSettings(); IBundleContainer[] oldContainers = fTarget.getBundleContainers(); if (oldContainers == null) { fTarget.setBundleContainers(new IBundleContainer[] { container }); } else { IBundleContainer[] newContainers = new IBundleContainer[oldContainers.length + 1]; System.arraycopy(oldContainers, 0, newContainers, 0, oldContainers.length); newContainers[newContainers.length - 1] = container; fTarget.setBundleContainers(newContainers); } } return true; } }; wizard.setWindowTitle(Messages.AddBundleContainerSelectionPage_1); return wizard; } }); // Installation/Profile Containers standardChoices.add(new AbstractBundleContainerNode(Messages.AddBundleContainerSelectionPage_6, Messages.AddBundleContainerSelectionPage_7, MDEPlugin.getDefault().getLabelProvider().get(MDEPluginImages.DESC_PRODUCT_DEFINITION)) { public IWizard createWizard() { Wizard wizard = new Wizard() { private EditProfileContainerPage fPage1; public void addPages() { IDialogSettings settings = MDEPlugin.getDefault().getDialogSettings() .getSection(SETTINGS_SECTION); if (settings == null) { settings = MDEPlugin.getDefault().getDialogSettings().addNewSection(SETTINGS_SECTION); } setDialogSettings(settings); setDialogSettings(settings); fPage1 = new EditProfileContainerPage(); addPage(fPage1); addPage(new PreviewContainerPage(fTarget, fPage1)); setNeedsProgressMonitor(true); } public boolean performFinish() { IBundleContainer container = fPage1.getBundleContainer(); if (container != null) { fPage1.storeSettings(); IBundleContainer[] oldContainers = fTarget.getBundleContainers(); if (oldContainers == null) { fTarget.setBundleContainers(new IBundleContainer[] { container }); } else { IBundleContainer[] newContainers = new IBundleContainer[oldContainers.length + 1]; System.arraycopy(oldContainers, 0, newContainers, 0, oldContainers.length); newContainers[newContainers.length - 1] = container; fTarget.setBundleContainers(newContainers); } } return true; } }; wizard.setWindowTitle(Messages.AddBundleContainerSelectionPage_1); return wizard; } }); // Feature Containers standardChoices.add(new AbstractBundleContainerNode(Messages.AddBundleContainerSelectionPage_9, Messages.AddBundleContainerSelectionPage_10, MDEPlugin.getDefault().getLabelProvider().get(MDEPluginImages.DESC_FEATURE_OBJ)) { public IWizard createWizard() { Wizard wizard = new Wizard() { public void addPages() { IDialogSettings settings = MDEPlugin.getDefault().getDialogSettings() .getSection(SETTINGS_SECTION); if (settings == null) { settings = MDEPlugin.getDefault().getDialogSettings().addNewSection(SETTINGS_SECTION); } setDialogSettings(settings); addPage(new AddFeatureContainersPage()); } public boolean performFinish() { try { IBundleContainer[] containers = ((AddFeatureContainersPage) getPages()[0]) .getBundleContainers(); if (containers != null) { ((AddFeatureContainersPage) getPages()[0]).storeSettings(); IBundleContainer[] oldContainers = fTarget.getBundleContainers(); if (oldContainers == null) { fTarget.setBundleContainers(containers); } else { IBundleContainer[] newContainers = new IBundleContainer[oldContainers.length + containers.length]; System.arraycopy(oldContainers, 0, newContainers, 0, oldContainers.length); System.arraycopy(containers, 0, newContainers, oldContainers.length, containers.length); fTarget.setBundleContainers(newContainers); } } return true; } catch (CoreException e) { setErrorMessage(e.getMessage()); return false; } } }; wizard.setWindowTitle(Messages.AddBundleContainerSelectionPage_1); return wizard; } }); // Repository and Update Site Container standardChoices.add(new AbstractBundleContainerNode(Messages.AddBundleContainerSelectionPage_8, Messages.AddBundleContainerSelectionPage_11, MDEPlugin.getDefault().getLabelProvider().get(MDEPluginImages.DESC_REPOSITORY_OBJ)) { public IWizard createWizard() { Wizard wizard = new Wizard() { public void addPages() { IDialogSettings settings = MDEPlugin.getDefault().getDialogSettings() .getSection(SETTINGS_SECTION); if (settings == null) { settings = MDEPlugin.getDefault().getDialogSettings().addNewSection(SETTINGS_SECTION); } setDialogSettings(settings); addPage(new EditIUContainerPage(fTarget)); } public boolean performFinish() { IBundleContainer container = ((EditIUContainerPage) getPages()[0]).getBundleContainer(); if (container != null) { ((EditIUContainerPage) getPages()[0]).storeSettings(); IBundleContainer[] oldContainers = fTarget.getBundleContainers(); if (oldContainers == null) { fTarget.setBundleContainers(new IBundleContainer[] { container }); } else { IBundleContainer[] newContainers = new IBundleContainer[oldContainers.length + 1]; System.arraycopy(oldContainers, 0, newContainers, 0, oldContainers.length); newContainers[newContainers.length - 1] = container; fTarget.setBundleContainers(newContainers); } } return true; } }; wizard.setWindowTitle(Messages.AddBundleContainerSelectionPage_1); return wizard; } }); return standardChoices; } /** * Returns a list of choices created from the ITargetProvisioner extension * The extension point was deprecated in 3.5 but we need to retain some compatibility. * @return list of wizard nodes */ private List getProvisionerExtensionChoices() { List list = new ArrayList(); IExtensionRegistry registry = Platform.getExtensionRegistry(); IExtensionPoint point = registry.getExtensionPoint(MDEPlugin.getPluginId(), PROVISIONER_POINT); if (point == null) return list; 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++) { WizardElement element = createWizardElement(elements[j]); if (element != null) { final String pluginId = element.getPluginId(); final String contributionId = element.getID(); IPluginContribution pc = new IPluginContribution() { public String getLocalId() { return contributionId; } public String getPluginId() { return pluginId; } }; if (!WorkbenchActivityHelper.filterItem(pc)) { list.add(createExtensionNode(element)); } } } } return list; } /** * Returns a Wizard element representing an extension contributed wizard * @param config config for the extensino * @return new wizard element */ protected WizardElement createWizardElement(IConfigurationElement config) { String name = config.getAttribute(WizardElement.ATT_NAME); String id = config.getAttribute(WizardElement.ATT_ID); if (name == null || id == null) return null; WizardElement element = new WizardElement(config); String imageName = config.getAttribute(WizardElement.ATT_ICON); Image image = null; if (imageName != null) { String pluginID = config.getNamespaceIdentifier(); image = MDEPlugin.getDefault().getLabelProvider().getImageFromPlugin(pluginID, imageName); } element.setImage(image); return element; } /** * Creates a wizard node that will get the pages from the contributed wizard and create a directory bundle container from the result * @param element wizard element representing the extension * @return wizard node */ private AbstractBundleContainerNode createExtensionNode(final WizardElement element) { return new AbstractBundleContainerNode(element.getLabel(), element.getDescription(), element.getImage()) { public IWizard createWizard() { Wizard wizard = new Wizard() { private IProvisionerWizard fWizard; public void addPages() { try { fWizard = (IProvisionerWizard) element.createExecutableExtension(); } catch (CoreException e) { MDEPlugin.log(e); MessageDialog.openError(getContainer().getShell(), Messages.Errors_CreationError, Messages.Errors_CreationError_NoWizard); } fWizard.setContainer(getContainer()); fWizard.addPages(); IWizardPage[] pages = fWizard.getPages(); for (int i = 0; i < pages.length; i++) addPage(pages[i]); } public boolean performFinish() { if (fWizard != null) { if (!fWizard.performFinish()) { return false; } File[] dirs = fWizard.getLocations(); for (int i = 0; i < dirs.length; i++) { if (dirs[i] == null || !dirs[i].isDirectory()) { ErrorDialog.openError(getShell(), Messages.AddBundleContainerSelectionPage_0, Messages.AddBundleContainerSelectionPage_5, new Status(IStatus.ERROR, MDEPlugin.getPluginId(), Messages.AddDirectoryContainerPage_6)); return false; } try { // First try the specified dir, then try the plugins dir IBundleContainer container = getTargetPlatformService() .newDirectoryContainer(dirs[i].getPath()); IBundleContainer[] oldContainers = fTarget.getBundleContainers(); if (oldContainers == null) { fTarget.setBundleContainers(new IBundleContainer[] { container }); } else { IBundleContainer[] newContainers = new IBundleContainer[oldContainers.length + 1]; System.arraycopy(oldContainers, 0, newContainers, 0, oldContainers.length); newContainers[oldContainers.length] = container; fTarget.setBundleContainers(newContainers); } } catch (CoreException ex) { ErrorDialog.openError(getShell(), Messages.AddBundleContainerSelectionPage_0, Messages.AddBundleContainerSelectionPage_5, ex.getStatus()); return false; } } } return true; } }; wizard.setContainer(getContainer()); wizard.setWindowTitle(Messages.AddBundleContainerSelectionPage_1); return wizard; } }; } /** * Abstract implementation of the IWizardNode interface providing a consistent look and feel * for the table displaying a list of possible bundle container types. */ abstract class AbstractBundleContainerNode implements IWizardNode { private String fTypeName; private String fTypeDescription; private Image fTypeImage; private IWizard fWizard; public AbstractBundleContainerNode(String name, String description, Image image) { fTypeName = name; fTypeDescription = description; fTypeImage = image; } public abstract IWizard createWizard(); public void dispose() { if (fWizard != null) { fWizard.dispose(); fWizard = null; } } public Point getExtent() { return new Point(-1, -1); } public IWizard getWizard() { if (fWizard == null) { fWizard = createWizard(); } return fWizard; } public boolean isContentCreated() { return fWizard != null; } public String getName() { return fTypeName; } public String getDescription() { return fTypeDescription; } public Image getImage() { return fTypeImage; } } }