/******************************************************************************* * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation * Leon J. Breedt: Added multiple folder creation support *******************************************************************************/ package org.eclipse.ui.dialogs; import java.lang.reflect.InvocationTargetException; import java.text.MessageFormat; import java.util.Iterator; import java.util.StringTokenizer; import org.eclipse.core.resources.*; import org.eclipse.core.runtime.*; import org.eclipse.jface.dialogs.ErrorDialog; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.wizard.WizardPage; 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.*; import org.eclipse.ui.actions.WorkspaceModifyOperation; import org.eclipse.ui.help.WorkbenchHelp; import org.eclipse.ui.internal.*; import org.eclipse.ui.internal.dialogs.CreateLinkedResourceGroup; import org.eclipse.ui.internal.misc.ResourceAndContainerGroup; /** * Standard main page for a wizard that creates a folder resource. *
* This page may be used by clients as-is; it may be also be subclassed to suit. *
** Subclasses may extend *
handleEvent
createFolder
.
*
* @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 WorkbenchPlugin.getPluginWorkspace().getRoot().getFolder(folderPath);
}
/**
* Creates the link target path if a link target has been specified.
*/
protected void createLinkTarget() {
String linkTarget = linkedResourceGroup.getLinkTarget();
if (linkTarget != null) {
linkTargetPath = new Path(linkTarget);
}
else {
linkTargetPath = null;
}
}
/**
* 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.
* * 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. *
** 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. *
** This method should be called within a workspace modify operation since * it creates resources. *
* * @return the created folder resource, ornull
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();
WorkspaceModifyOperation op = new WorkspaceModifyOperation() {
public void execute(IProgressMonitor monitor) throws CoreException {
try {
monitor.beginTask(WorkbenchMessages.getString("WizardNewFolderCreationPage.progress"), 2000); //$NON-NLS-1$
ContainerGenerator generator = new ContainerGenerator(containerPath);
generator.generateContainer(new SubProgressMonitor(monitor, 1000));
createFolder(newFolderHandle, new SubProgressMonitor(monitor, 1000));
} finally {
monitor.done();
}
}
};
try {
getContainer().run(true, true, op);
} catch (InterruptedException e) {
return null;
} catch (InvocationTargetException e) {
if (e.getTargetException() instanceof CoreException) {
ErrorDialog.openError(
getContainer().getShell(), // Was Utilities.getFocusShell()
WorkbenchMessages.getString("WizardNewFolderCreationPage.errorTitle"), //$NON-NLS-1$
null, // no special message
((CoreException) e.getTargetException()).getStatus());
}
else {
// CoreExceptions are handled above, but unexpected runtime exceptions and errors may still occur.
WorkbenchPlugin.log(MessageFormat.format("Exception in {0}.getNewFolder(): {1}", new Object[] {getClass().getName(),e.getTargetException()}));//$NON-NLS-1$
MessageDialog.openError(getContainer().getShell(), WorkbenchMessages.getString("WizardNewFolderCreationPage.internalErrorTitle"), WorkbenchMessages.format("WizardNewFolder.internalError", new Object[] {e.getTargetException().getMessage()})); //$NON-NLS-2$ //$NON-NLS-1$
}
return null; // ie.- one of the steps resulted in a core exception
}
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(WorkbenchMessages.getString("showAdvanced")); //$NON-NLS-1$
} 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(WorkbenchMessages.getString("hideAdvanced")); //$NON-NLS-1$
}
}
/**
* The WizardNewFolderCreationPage
implementation of this
* Listener
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 enum = currentSelection.iterator();
if (enum.hasNext()) {
Object next = enum.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 true
if all controls are valid, and
* false
if at least one is invalid
*/
protected boolean validatePage() {
boolean valid = true;
IWorkspace workspace = WorkbenchPlugin.getPluginWorkspace();
IStatus nameStatus = null;
String folderName = resourceGroup.getResource();
if (folderName.indexOf(IPath.SEPARATOR) != -1) {
StringTokenizer tok = new StringTokenizer(folderName, String.valueOf(IPath.SEPARATOR));
while (tok.hasMoreTokens()) {
String pathFragment = tok.nextToken();
nameStatus = workspace.validateName(pathFragment, IResource.FOLDER);
if (!nameStatus.isOK()) {
break;
}
}
}
//If the name status was not set validate using the name
if(nameStatus == null && folderName.length() > 0)
nameStatus = workspace.validateName(folderName, IResource.FOLDER);
if (nameStatus != null && !nameStatus.isOK()) {
setErrorMessage(nameStatus.getMessage());
return false;
}
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;
}
}