unified title and description handling in wizards
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / wizards / HTMLFileWizard.java
1 package net.sourceforge.phpeclipse.wizards;
2
3 /**********************************************************************
4  Copyright (c) 2000, 2002 IBM Corp. and others.
5  All rights reserved. This program and the accompanying materials
6  are made available under the terms of the Common Public License v1.0
7  which accompanies this distribution, and is available at
8  http://www.eclipse.org/legal/cpl-v10.html
9
10  Contributors:
11  IBM Corporation - Initial implementation
12  www.phpeclipse.de
13  **********************************************************************/
14
15 import java.io.ByteArrayInputStream;
16 import java.io.IOException;
17 import java.io.InputStream;
18 import java.lang.reflect.InvocationTargetException;
19
20 import net.sourceforge.phpdt.internal.corext.codemanipulation.StubUtility;
21 import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContext;
22 import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContextType;
23 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
24
25 import org.eclipse.core.resources.IContainer;
26 import org.eclipse.core.resources.IFile;
27 import org.eclipse.core.resources.IProject;
28 import org.eclipse.core.resources.IResource;
29 import org.eclipse.core.resources.IWorkspaceRoot;
30 import org.eclipse.core.resources.ResourcesPlugin;
31 import org.eclipse.core.runtime.CoreException;
32 import org.eclipse.core.runtime.IProgressMonitor;
33 import org.eclipse.core.runtime.IStatus;
34 import org.eclipse.core.runtime.Path;
35 import org.eclipse.core.runtime.Status;
36 import org.eclipse.jface.dialogs.MessageDialog;
37 import org.eclipse.jface.operation.IRunnableWithProgress;
38 import org.eclipse.jface.text.templates.Template;
39 import org.eclipse.jface.viewers.ISelection;
40 import org.eclipse.jface.viewers.IStructuredSelection;
41 import org.eclipse.jface.wizard.Wizard;
42 import org.eclipse.ui.INewWizard;
43 import org.eclipse.ui.IWorkbench;
44 import org.eclipse.ui.IWorkbenchPage;
45 import org.eclipse.ui.IWorkbenchWizard;
46 import org.eclipse.ui.PartInitException;
47 import org.eclipse.ui.PlatformUI;
48 import org.eclipse.ui.ide.IDE;
49
50 /**
51  * This wizard creates one file with the extension "html".
52  */
53 public class HTMLFileWizard extends Wizard implements INewWizard {
54
55   private HTMLFileWizardPage page;
56
57   private ISelection selection;
58
59   public HTMLFileWizard() {
60     super();
61     setNeedsProgressMonitor(true);
62     setWindowTitle(PHPWizardMessages.getString("WizardNewProjectCreationPage.html.windowTitle"));
63   }
64
65   /**
66    * Adding the page to the wizard.
67    */
68   public void addPages() {
69     page = new HTMLFileWizardPage(selection);
70     addPage(page);
71   }
72
73   /**
74    * This method is called when 'Finish' button is pressed in the wizard. We will create an operation and run it using wizard as
75    * execution context.
76    */
77   public boolean performFinish() {
78     final String containerName = page.getContainerName();
79     final String fileName = page.getFileName();
80     IRunnableWithProgress op = new IRunnableWithProgress() {
81       public void run(IProgressMonitor monitor) throws InvocationTargetException {
82         try {
83           doFinish(containerName, fileName, monitor);
84         } catch (CoreException e) {
85           throw new InvocationTargetException(e);
86         } finally {
87           monitor.done();
88         }
89       }
90     };
91     try {
92       getContainer().run(true, false, op);
93     } catch (InterruptedException e) {
94       return false;
95     } catch (InvocationTargetException e) {
96       Throwable realException = e.getTargetException();
97       MessageDialog.openError(getShell(), PHPWizardMessages.getString("Wizard.error"), realException.getMessage());
98       return false;
99     }
100     return true;
101   }
102
103   /**
104    * The worker method. It will find the container, create the file if missing or just replace its contents, and open the editor on
105    * the newly created file.
106    */
107   private void doFinish(String containerName, String fileName, IProgressMonitor monitor) throws CoreException {
108     // create a sample file
109     monitor.beginTask(PHPWizardMessages.getString("Wizard.Monitor.creating") + " " + fileName, 2);
110     IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
111     IResource resource = root.findMember(new Path(containerName));
112     if (!resource.exists() || !(resource instanceof IContainer)) {
113       throwCoreException(PHPWizardMessages.getString("Wizard.Monitor.containerDoesNotExistException"));
114     }
115     IContainer container = (IContainer) resource;
116     final IFile file = container.getFile(new Path(fileName));
117     IProject project = file.getProject();
118     String projectName = project.getName();
119     try {
120       InputStream stream;
121       stream = openContentStream(fileName, projectName);
122       if (file.exists()) {
123         file.setContents(stream, true, true, monitor);
124       } else {
125         file.create(stream, true, monitor);
126       }
127       stream.close();
128     } catch (IOException e) {
129     }
130     monitor.worked(1);
131     monitor.setTaskName(PHPWizardMessages.getString("Wizard.Monitor.openingFile"));
132     getShell().getDisplay().asyncExec(new Runnable() {
133       public void run() {
134         IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
135         try {
136           IDE.openEditor(page, file, true);
137         } catch (PartInitException e) {
138         }
139       }
140     });
141     monitor.worked(1);
142   }
143
144   /**
145    * We will initialize file contents with a sample text.
146    */
147   private InputStream openContentStream(String fileName, String projectname) {
148     try {
149       Template template = PHPeclipsePlugin.getDefault().getCodeTemplateStore().findTemplate(CodeTemplateContextType.NEWHTML);
150       if (template == null) {
151         return null;
152       }
153       String lineDelimiter = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
154       CodeTemplateContext context = new CodeTemplateContext(template.getContextTypeId(), null, lineDelimiter);
155       context.setFileNameVariable(fileName, projectname);
156       return new ByteArrayInputStream(StubUtility.evaluateTemplate(context, template).getBytes());
157     } catch (CoreException e) {
158       e.printStackTrace();
159       return null;
160     }
161   }
162
163   private void throwCoreException(String message) throws CoreException {
164     IStatus status = new Status(IStatus.ERROR, "net.sourceforge.phpeclipse.wizards", IStatus.OK, message, null);
165     throw new CoreException(status);
166   }
167
168   /**
169    * We will accept the selection in the workbench to see if we can initialize from it.
170    *
171    * @see IWorkbenchWizard#init(IWorkbench, IStructuredSelection)
172    */
173   public void init(IWorkbench workbench, IStructuredSelection selection) {
174     this.selection = selection;
175   }
176
177 }