Java tutorial
/******************************************************************************* * Copyright (c) 2000, 2009 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 * Leon J. Breedt - Added multiple folder creation support (in WizardNewFolderMainPage) * *******************************************************************************/ package com.coretek.testcase.projectView.projectwizard.page; import java.lang.reflect.InvocationTargetException; import java.net.URI; import java.util.Iterator; import org.eclipse.core.commands.ExecutionException; import org.eclipse.core.resources.IFolder; import org.eclipse.core.resources.IResource; import org.eclipse.core.resources.IResourceStatus; import org.eclipse.core.resources.IWorkspaceRoot; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IAdaptable; import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.OperationCanceledException; import org.eclipse.core.runtime.Preferences; import org.eclipse.core.runtime.SubProgressMonitor; import org.eclipse.jface.dialogs.ErrorDialog; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.operation.IRunnableWithProgress; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.wizard.WizardPage; import org.eclipse.osgi.util.NLS; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.graphics.Point; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Event; import org.eclipse.swt.widgets.Listener; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.ide.undo.CreateFolderOperation; import org.eclipse.ui.ide.undo.WorkspaceUndoUtil; import org.eclipse.ui.internal.ide.IDEWorkbenchMessages; import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin; import org.eclipse.ui.internal.ide.IIDEHelpContextIds; import org.eclipse.ui.internal.ide.dialogs.CreateLinkedResourceGroup; import org.eclipse.ui.internal.ide.misc.ResourceAndContainerGroup; /** * Standard main page for a wizard that creates a folder resource. * <p> * This page may be used by clients as-is; it may be also be subclassed to suit. * </p> * <p> * Subclasses may extend * <ul> * <li><code>handleEvent</code></li> * </ul> * </p> */ public class WizardNewFolderMainPage extends WizardPage implements Listener { private static final int SIZING_CONTAINER_GROUP_HEIGHT = 250; private IStructuredSelection currentSelection; private IFolder newFolder; // link target location private URI linkTargetPath; // widgets private ResourceAndContainerGroup resourceGroup; private Button advancedButton; private CreateLinkedResourceGroup linkedResourceGroup; private Composite linkedResourceParent; private Composite linkedResourceComposite; /** * Height of the "advanced" linked resource group. Set when the advanced * group is first made visible. */ private int linkedResourceGroupHeight = -1; /** * First time the advanced group is validated. */ private boolean firstLinkCheck = true; /** * Creates a new folder creation wizard page. If the initial resource * selection contains exactly one container resource then it will be used as * the default container resource. * * @param pageName the name of the page * @param selection the current resource selection */ public WizardNewFolderMainPage(String pageName, IStructuredSelection selection) { super("newFolderPage1");//$NON-NLS-1$ setTitle(pageName); setDescription(IDEWorkbenchMessages.WizardNewFolderMainPage_description); this.currentSelection = selection; } /** * Creates the widget for advanced options. * * @param parent the parent composite */ @SuppressWarnings({ "restriction", "deprecation" }) protected void createAdvancedControls(Composite parent) { Preferences preferences = ResourcesPlugin.getPlugin().getPluginPreferences(); if (preferences.getBoolean(ResourcesPlugin.PREF_DISABLE_LINKING) == false) { linkedResourceParent = new Composite(parent, SWT.NONE); linkedResourceParent.setFont(parent.getFont()); linkedResourceParent.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); GridLayout layout = new GridLayout(); layout.marginHeight = 0; layout.marginWidth = 0; linkedResourceParent.setLayout(layout); advancedButton = new Button(linkedResourceParent, SWT.PUSH); advancedButton.setFont(linkedResourceParent.getFont()); advancedButton.setText(IDEWorkbenchMessages.showAdvanced); GridData data = setButtonLayoutData(advancedButton); data.horizontalAlignment = GridData.BEGINNING; advancedButton.setLayoutData(data); advancedButton.addSelectionListener(new SelectionAdapter() { public void widgetSelected(SelectionEvent e) { handleAdvancedButtonSelect(); } }); } linkedResourceGroup = new CreateLinkedResourceGroup(IResource.FOLDER, new Listener() { public void handleEvent(Event e) { setPageComplete(validatePage()); firstLinkCheck = false; } }, new CreateLinkedResourceGroup.IStringValue() { public String getValue() { return resourceGroup.getResource(); } public void setValue(String string) { resourceGroup.setResource(string); } public IResource getResource() { // TODO Auto-generated method stub return null; } }); } /** * (non-Javadoc) Method declared on IDialogPage. */ @SuppressWarnings("restriction") public void createControl(Composite parent) { initializeDialogUnits(parent); // top level group Composite composite = new Composite(parent, SWT.NONE); composite.setFont(parent.getFont()); composite.setLayout(new GridLayout()); composite.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_FILL | GridData.HORIZONTAL_ALIGN_FILL)); PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IIDEHelpContextIds.NEW_FOLDER_WIZARD_PAGE); resourceGroup = new ResourceAndContainerGroup(composite, this, IDEWorkbenchMessages.WizardNewFolderMainPage_folderName, IDEWorkbenchMessages.WizardNewFolderMainPage_folderLabel, false, SIZING_CONTAINER_GROUP_HEIGHT); resourceGroup.setAllowExistingResources(false); createAdvancedControls(composite); initializePage(); validatePage(); setErrorMessage(null); setMessage(null); setControl(composite); } /** * Creates a folder resource given the folder handle. * * @param folderHandle the folder handle to create a folder resource for * @param monitor the progress monitor to show visual progress with * @exception CoreException if the operation fails * @exception OperationCanceledException if the operation is canceled * * @deprecated As of 3.3, use {@link #createNewFolder()} which uses the * undoable operation support. */ protected void createFolder(IFolder folderHandle, IProgressMonitor monitor) throws CoreException { try { // Create the folder resource in the workspace // Update: Recursive to create any folders which do not exist // already if (!folderHandle.exists()) { if (linkTargetPath != null) { folderHandle.createLink(linkTargetPath, IResource.ALLOW_MISSING_LOCAL, monitor); } else { IPath path = folderHandle.getFullPath(); IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); int numSegments = path.segmentCount(); if (numSegments > 2 && !root.getFolder(path.removeLastSegments(1)).exists()) { // If the direct parent of the path doesn't exist, try // to create the // necessary directories. for (int i = numSegments - 2; i > 0; i--) { IFolder folder = root.getFolder(path.removeLastSegments(i)); if (!folder.exists()) { folder.create(false, true, monitor); } } } folderHandle.create(false, true, monitor); } } } catch (CoreException e) { // If the folder already existed locally, just refresh to get // contents if (e.getStatus().getCode() == IResourceStatus.PATH_OCCUPIED) { folderHandle.refreshLocal(IResource.DEPTH_INFINITE, new SubProgressMonitor(monitor, 500)); } else { throw e; } } if (monitor.isCanceled()) { throw new OperationCanceledException(); } } /** * Creates a folder resource handle for the folder with the given workspace * path. This method does not create the folder resource; this is the * responsibility of <code>createFolder</code>. * * @param folderPath the path of the folder resource to create a handle for * @return the new folder resource handle * @see #createFolder */ protected IFolder createFolderHandle(IPath folderPath) { return IDEWorkbenchPlugin.getPluginWorkspace().getRoot().getFolder(folderPath); } /** * Creates the link target path if a link target has been specified. */ protected void createLinkTarget() { linkTargetPath = linkedResourceGroup.getLinkTargetURI(); } /** * Creates a new folder resource in the selected container and with the * selected name. Creates any missing resource containers along the path; * does nothing if the container resources already exist. * <p> * In normal usage, this method is invoked after the user has pressed Finish * on the wizard; the enablement of the Finish button implies that all * controls on this page currently contain valid values. * </p> * <p> * Note that this page caches the new folder once it has been successfully * created; subsequent invocations of this method will answer the same * folder resource without attempting to create it again. * </p> * <p> * This method should be called within a workspace modify operation since it * creates resources. * </p> * * @return the created folder resource, or <code>null</code> if the folder * was not created */ public IFolder createNewFolder() { if (newFolder != null) { return newFolder; } // create the new folder and cache it if successful final IPath containerPath = resourceGroup.getContainerFullPath(); IPath newFolderPath = containerPath.append(resourceGroup.getResource()); final IFolder newFolderHandle = createFolderHandle(newFolderPath); createLinkTarget(); IRunnableWithProgress op = new IRunnableWithProgress() { public void run(IProgressMonitor monitor) { CreateFolderOperation op = new CreateFolderOperation(newFolderHandle, linkTargetPath, IDEWorkbenchMessages.WizardNewFolderCreationPage_title); try { // see bug // https://bugs.eclipse.org/bugs/show_bug.cgi?id=219901 // directly execute the operation so that the undo state is // not preserved. Making this undoable can result in // accidental // folder (and file) deletions. op.execute(monitor, WorkspaceUndoUtil.getUIInfoAdapter(getShell())); } catch (final ExecutionException e) { getContainer().getShell().getDisplay().syncExec(new Runnable() { public void run() { if (e.getCause() instanceof CoreException) { ErrorDialog.openError(getContainer().getShell(), // Was // Utilities.getFocusShell() IDEWorkbenchMessages.WizardNewFolderCreationPage_errorTitle, null, // no // special // message ((CoreException) e.getCause()).getStatus()); } else { IDEWorkbenchPlugin.log(getClass(), "createNewFolder()", e.getCause()); //$NON-NLS-1$ MessageDialog.openError(getContainer().getShell(), IDEWorkbenchMessages.WizardNewFolderCreationPage_internalErrorTitle, NLS.bind(IDEWorkbenchMessages.WizardNewFolder_internalError, e.getCause().getMessage())); } } }); } } }; try { getContainer().run(true, true, op); } catch (InterruptedException e) { return null; } catch (InvocationTargetException e) { // ExecutionExceptions are handled above, but unexpected runtime // exceptions and errors may still occur. IDEWorkbenchPlugin.log(getClass(), "createNewFolder()", e.getTargetException()); //$NON-NLS-1$ MessageDialog.open(MessageDialog.ERROR, getContainer().getShell(), IDEWorkbenchMessages.WizardNewFolderCreationPage_internalErrorTitle, NLS.bind(IDEWorkbenchMessages.WizardNewFolder_internalError, e.getTargetException().getMessage()), SWT.SHEET); return null; } newFolder = newFolderHandle; return newFolder; } /** * Shows/hides the advanced option widgets. */ protected void handleAdvancedButtonSelect() { Shell shell = getShell(); Point shellSize = shell.getSize(); Composite composite = (Composite) getControl(); if (linkedResourceComposite != null) { linkedResourceComposite.dispose(); linkedResourceComposite = null; composite.layout(); shell.setSize(shellSize.x, shellSize.y - linkedResourceGroupHeight); advancedButton.setText(IDEWorkbenchMessages.showAdvanced); } else { linkedResourceComposite = linkedResourceGroup.createContents(linkedResourceParent); if (linkedResourceGroupHeight == -1) { Point groupSize = linkedResourceComposite.computeSize(SWT.DEFAULT, SWT.DEFAULT, true); linkedResourceGroupHeight = groupSize.y; } shell.setSize(shellSize.x, shellSize.y + linkedResourceGroupHeight); composite.layout(); advancedButton.setText(IDEWorkbenchMessages.hideAdvanced); } } /** * The <code>WizardNewFolderCreationPage</code> implementation of this * <code>Listener</code> method handles all events and enablements for * controls on this page. Subclasses may extend. */ public void handleEvent(Event ev) { setPageComplete(validatePage()); } /** * Initializes this page's controls. */ protected void initializePage() { Iterator it = currentSelection.iterator(); if (it.hasNext()) { Object next = it.next(); IResource selectedResource = null; if (next instanceof IResource) { selectedResource = (IResource) next; } else if (next instanceof IAdaptable) { selectedResource = (IResource) ((IAdaptable) next).getAdapter(IResource.class); } if (selectedResource != null) { if (selectedResource.getType() == IResource.FILE) { selectedResource = selectedResource.getParent(); } if (selectedResource.isAccessible()) { resourceGroup.setContainerFullPath(selectedResource.getFullPath()); } } } setPageComplete(false); } /* * @see DialogPage.setVisible(boolean) */ public void setVisible(boolean visible) { super.setVisible(visible); if (visible) { resourceGroup.setFocus(); } } /** * Checks whether the linked resource target is valid. Sets the error * message accordingly and returns the status. * * @return IStatus validation result from the CreateLinkedResourceGroup */ protected IStatus validateLinkedResource() { IPath containerPath = resourceGroup.getContainerFullPath(); IPath newFolderPath = containerPath.append(resourceGroup.getResource()); IFolder newFolderHandle = createFolderHandle(newFolderPath); IStatus status = linkedResourceGroup.validateLinkLocation(newFolderHandle); if (status.getSeverity() == IStatus.ERROR) { if (firstLinkCheck) { setMessage(status.getMessage()); } else { setErrorMessage(status.getMessage()); } } else if (status.getSeverity() == IStatus.WARNING) { setMessage(status.getMessage(), WARNING); setErrorMessage(null); } return status; } /** * Returns whether this page's controls currently all contain valid values. * * @return <code>true</code> if all controls are valid, and * <code>false</code> if at least one is invalid */ protected boolean validatePage() { boolean valid = true; if (!resourceGroup.areAllValuesValid()) { // if blank name then fail silently if (resourceGroup.getProblemType() == ResourceAndContainerGroup.PROBLEM_RESOURCE_EMPTY || resourceGroup.getProblemType() == ResourceAndContainerGroup.PROBLEM_CONTAINER_EMPTY) { setMessage(resourceGroup.getProblemMessage()); setErrorMessage(null); } else { setErrorMessage(resourceGroup.getProblemMessage()); } valid = false; } IStatus linkedResourceStatus = null; if (valid) { linkedResourceStatus = validateLinkedResource(); if (linkedResourceStatus.getSeverity() == IStatus.ERROR) { valid = false; } } // validateLinkedResource sets messages itself if (valid && (linkedResourceStatus == null || linkedResourceStatus.isOK())) { setMessage(null); setErrorMessage(null); } return valid; } }