source: release-kits/shared/ant-installer/src/org/tp23/antinstaller/runtime/SwingRunner.java@ 17851

Last change on this file since 17851 was 17851, checked in by oranfry, 15 years ago

changing installer to a more universal font
File size: 12.5 KB
Line 
1/*
2 * Copyright 2005 Paul Hinds
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package org.tp23.antinstaller.runtime;
17
18import java.awt.GraphicsConfiguration;
19import java.awt.Toolkit;
20import java.awt.Dimension;
21import java.io.ByteArrayOutputStream;
22import java.io.InputStream;
23import java.util.ArrayList;
24import java.util.List;
25import java.util.ResourceBundle;
26
27import javax.swing.ImageIcon;
28import javax.swing.JFrame;
29
30import org.tp23.antinstaller.InstallException;
31import org.tp23.antinstaller.Installer;
32import org.tp23.antinstaller.InstallerContext;
33import org.tp23.antinstaller.ValidationException;
34import org.tp23.antinstaller.antmod.FeedbackListener;
35import org.tp23.antinstaller.page.Page;
36import org.tp23.antinstaller.renderer.AntOutputRenderer;
37import org.tp23.antinstaller.renderer.RendererFactory;
38import org.tp23.antinstaller.renderer.swing.PageCompletionListener;
39import org.tp23.antinstaller.renderer.swing.SizeConstants;
40import org.tp23.antinstaller.renderer.swing.SwingInstallerContext;
41import org.tp23.antinstaller.renderer.swing.SwingMessageRenderer;
42import org.tp23.antinstaller.renderer.swing.SwingPageRenderer;
43
44import java.util.Enumeration;
45import java.awt.Font;
46import javax.swing.plaf.FontUIResource;
47import javax.swing.UIManager;
48
49
50
51/**
52 * <p>Runs the installer in a JFrame window </p>
53 * <p>This class uses the Installer object tree as its data source and renderers
54 * from the org.tp23.antinstaller.renderer.swing package </p>
55 * Runners must also create a MessageRenderer and make it available in the
56 * InstallerContext
57 * <p>Copyright: Copyright (c) 2004</p>
58 * <p>Company: tp23</p>
59 *
60 * @author Paul Hinds
61 * @version $Id: SwingRunner.java,v 1.11 2007/01/19 00:24:36 teknopaul Exp $
62 */
63public class SwingRunner extends AntRunner implements Runner, PageCompletionListener {
64
65 protected SwingInstallerContext swingCtx = null;
66 private JFrame frame = new JFrame();
67 private List pageRenderers;
68 private volatile boolean doAnt = false;
69 protected Thread initialThread;
70 protected IfPropertyHelper ifHelper;
71 // context local property refs
72 protected InstallerContext ctx;
73 protected Logger logger;
74 protected Installer installer;
75
76 public SwingRunner(InstallerContext ctx) {
77 super(ctx);
78 swingCtx = new SwingInstallerContext(ctx, frame);
79
80 SwingMessageRenderer smr = new SwingMessageRenderer();
81 smr.setOwner(frame);
82 ctx.setMessageRenderer(smr);
83
84 ctx.setBuildListener(new FeedbackListener(swingCtx));
85
86 ifHelper = new IfPropertyHelper(ctx);
87 logger = ctx.getLogger();
88 installer = ctx.getInstaller();
89 this.ctx = ctx;
90 }
91
92 /**
93 * Renders the installer in a Swing GUI, this method blocks until
94 * the UI has finished
95 *
96 * @return boolean false implies user aborted
97 * @throws InstallException
98 */
99 public boolean runInstaller() throws InstallException {
100 try {
101 frame.setTitle(installer.getName());
102 frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
103 frame.setSize(SizeConstants.PAGE_WIDTH, SizeConstants.PAGE_HEIGHT);
104 frame.getRootPane().setDoubleBuffered(true);
105 frame.setResizable( true );
106
107 Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
108 frame.setLocation(screenSize.width/2 - frame.getWidth()/2, screenSize.height/2 - frame.getHeight()/2);
109
110 //setLocation(frame);
111 setIcon(frame, installer);
112
113 //set font
114 FontUIResource default_font = new FontUIResource("AR PL New Sung", Font.PLAIN, 12);
115 Enumeration keys = UIManager.getDefaults().keys();
116 while (keys.hasMoreElements()) {
117 Object key = keys.nextElement();
118 Object value = UIManager.get(key);
119 if (value instanceof FontUIResource) {
120 UIManager.put(key, default_font);
121 }
122 }
123
124 preparePages(installer.getPages(), ctx);
125 showFirstPage();
126 // need to block here until pages are complete
127 initialThread = Thread.currentThread();
128 try {
129 Thread.sleep(Long.MAX_VALUE);
130 }
131 catch (InterruptedException ex1) {
132
133 }
134 return doAnt;
135 }
136 catch (Exception ex) {
137 logger.log("Fatal exception: " + ex.getMessage());
138 if (ctx.getInstaller().isVerbose()) {
139 logger.log(ex);
140 }
141 ctx.getMessageRenderer().printMessage("Fatal exception: " + ex.getMessage());
142 throw new InstallException("", ex);
143 }
144 }
145
146 public void pageBack(Page page) {
147 if (page.isAbort()) {
148 abort();
149 return;
150 }
151 Page[] pages = installer.getPages();
152 for (int i = 0; i < pages.length; i++) {
153 if (pages[i] == page) {
154 // found current page
155 if (i > 0) {
156
157 //skip pages if the ifTarget or ifProperty attributes exist and fail
158 int nextIdx = i - 1;
159 try {
160 while (true) {
161 if (!ifHelper.ifTarget(pages[nextIdx], pages) ||
162 !ifHelper.ifProperty(pages[nextIdx])) {
163 //Continue looping
164 --nextIdx;
165 } else {
166 break;
167 }
168 }
169 }
170 catch (InstallException instExc) {
171 logger.log("InstallException rendering page:" + page.getName());
172 logger.log(installer, instExc);
173 }
174
175 //for(;ifTargetSkip(pages[nextIdx], pages);nextIdx--);
176
177 SwingPageRenderer renderer = (SwingPageRenderer) pageRenderers.get(nextIdx);
178 ctx.setCurrentPage(pages[nextIdx]);
179 try {
180 renderNext(renderer);
181 }
182 catch (InstallException ex) {
183 logger.log("InstallExcepiton rendering page:" + page.getName());
184 logger.log(installer, ex);
185 }
186 catch (ClassNotFoundException ex) {
187 logger.log("ClassNotFoundException rendering page:" + page.getName());
188 logger.log(installer, ex);
189 }
190 return;
191 }
192 }
193 }
194 }
195
196 /**
197 * Called when a page is complete and the next button is pressed.
198 * This method is called by the event thread that looses exceptions so Throwable
199 * is caught
200 *
201 * @param page Page
202 */
203 public void pageComplete(Page page) {
204 try {
205 if (page.isAbort()) {
206 abort();
207 return;
208 }
209 runPost(page);
210 Page[] pages = installer.getPages();
211 SwingPageRenderer currentRenderer;
212 for (int i = 0; i < pages.length; i++) {
213 if (pages[i] == page) { // found current page
214 currentRenderer = (SwingPageRenderer) pageRenderers.get(i);
215 // check validation
216 boolean validationPassed = false;
217 try {
218 currentRenderer.updateInputFields();
219 validationPassed = currentRenderer.validateFields();
220 } catch (ValidationException ve) {
221 logger.log("ValidationException rendering page:" + page.getName());
222 logger.log(installer, ve);
223 return;
224 }
225 if (!validationPassed) {
226 return;
227 }
228
229
230 if (i < pages.length - 1) {
231
232 //more pages left
233
234 // skip the page if the ifTarget or ifProperty dictate it
235 int nextIdx = i + 1;
236 while (true) {
237 if (!ifHelper.ifTarget(pages[nextIdx], pages) ||
238 !ifHelper.ifProperty(pages[nextIdx])) {
239 //Continue looping
240 nextIdx++;
241 } else {
242 break;
243 }
244 }
245
246
247 SwingPageRenderer renderer = (SwingPageRenderer) pageRenderers.get(nextIdx);
248 ctx.setCurrentPage(pages[nextIdx]);
249 try {
250 renderNext(renderer);
251 }
252 catch (InstallException ex) {
253 logger.log("InstallException rendering page:" + page.getName());
254 logger.log(installer, ex);
255 }
256 catch (ClassNotFoundException ex) {
257 logger.log("ClassNotFoundException rendering page:" + page.getName());
258 logger.log(installer, ex);
259 }
260 return;
261 }
262 if (i == pages.length - 1) {
263 // all done
264 currentRenderer.getBackButton().setEnabled(false);
265 currentRenderer.getNextButton().setEnabled(false);
266 currentRenderer.getFinishButton().setEnabled(false);
267 doAnt = true;
268 initialThread.interrupt();
269 return;
270 }
271 }
272 }
273 }
274 catch (Throwable e) {
275 ctx.log("Throwable during page completion:" + e.getMessage());
276 if (ctx.getInstaller().isVerbose()) {
277 ctx.log(e);
278 }
279 }
280 }
281
282 protected void showFirstPage() throws Exception {
283 ctx.setCurrentPage(installer.getPages()[0]);
284 renderNext((SwingPageRenderer) pageRenderers.get(0));
285 }
286
287
288 private void preparePages(Page[] pages, InstallerContext ctx) throws Exception {
289 pageRenderers = new ArrayList();
290 for (int i = 0; i < pages.length; i++) {
291 SwingPageRenderer renderer = RendererFactory.getSwingPageRenderer(pages[i]);
292 if (i == 0) renderer.getBackButton().setEnabled(false);
293 renderer.setContext(swingCtx);
294 renderer.setPageCompletionListener(this);
295 renderer.setPage(pages[i]);
296 renderer.instanceInit();
297 pageRenderers.add(renderer);
298 if (renderer instanceof AntOutputRenderer) {
299 ctx.setAntOutputRenderer((AntOutputRenderer) renderer);
300 }
301 }
302 }
303
304 protected void renderNext(SwingPageRenderer renderer) throws ClassNotFoundException, InstallException {
305 renderer.reInit();
306 renderer.reInstanceInit();
307
308 renderer.updateDefaultValues();
309 frame.getContentPane().removeAll();
310 frame.getContentPane().add(renderer);
311 frame.getContentPane().repaint();
312 frame.show();
313 if (renderer.getNextButton().isEnabled()) {
314 renderer.getNextButton().requestFocus();
315 } else if (renderer.getFinishButton().isEnabled()) {
316 renderer.getFinishButton().requestFocus();
317 }
318 }
319
320 private void setLocation(JFrame frame) {
321 GraphicsConfiguration config = frame.getGraphicsConfiguration();
322 int x = (int) config.getBounds().getCenterX() - (SizeConstants.PAGE_WIDTH / 2);
323 int y = (int) config.getBounds().getCenterY() - (SizeConstants.PAGE_HEIGHT / 2);
324 frame.setLocation(x, y);
325 frame.setResizable(false);
326 }
327
328 private void setIcon(JFrame frame, Installer installer) {
329 String iconResource = installer.getWindowIcon();
330 try {
331 if (iconResource == null) {
332 return;
333 }
334 InputStream in = this.getClass().getResourceAsStream(iconResource);
335 ByteArrayOutputStream baos = new ByteArrayOutputStream();
336 byte[] buffer = new byte[256];
337 int read = 0; // The number of bytes read from the stream
338 for (read = in.read(buffer); read != -1; read = in.read(buffer)) {
339 baos.write(buffer, 0, read);
340 }
341 ImageIcon icon = new ImageIcon(baos.toByteArray());
342 //Image icon = Toolkit.getDefaultToolkit().createImage(baos.toByteArray());
343 frame.setIconImage(icon.getImage());
344 }
345 catch (Exception ex) {
346 // we can live with out an icon
347 logger.log("Can not load icon resource: " + iconResource);
348 logger.log(installer, ex);
349 }
350 }
351
352 public void antFinished() {
353 SwingPageRenderer renderer = (SwingPageRenderer) pageRenderers.get(pageRenderers.size() - 1);
354 renderer.getBackButton().setEnabled(false);
355 renderer.getNextButton().setEnabled(false);
356 renderer.getCancelButton().setEnabled(false);
357 renderer.getFinishButton().setText(org.tp23.antinstaller.Installer.langPack.getString("exit"));
358 renderer.getFinishButton().setEnabled(true);
359 renderer.getFinishButton().requestFocus();
360 renderer.getTitleLabel().setText(org.tp23.antinstaller.Installer.langPack.getString("complete"));
361 renderer.stopPage();
362 ctx.getAntOutputRenderer().getErr().flush();
363 ctx.getAntOutputRenderer().getOut().flush();
364 ctx.getMessageRenderer().printMessage(org.tp23.antinstaller.Installer.langPack.getString("finished"));
365 }
366
367 public void fatalError() {
368 List renderers = getPageRenderers();
369 if ((renderers != null) && (renderers.size() > 0)) {
370 SwingPageRenderer renderer = (SwingPageRenderer) renderers.get(renderers.size() - 1);
371 renderer.getBackButton().setEnabled(false);
372 renderer.getNextButton().setEnabled(false);
373 renderer.getCancelButton().setEnabled(false);
374 renderer.getFinishButton().setText(org.tp23.antinstaller.Installer.langPack.getString("exit"));
375 renderer.getFinishButton().setEnabled(true);
376 renderer.getFinishButton().requestFocus();
377 renderer.stopPage();
378 renderer.getTitleLabel().setText(org.tp23.antinstaller.Installer.langPack.getString("failed"));
379 }
380 // else - we're done here, or should we call abort()?
381 }
382
383 /**
384 * Returns a string representation of the object.
385 *
386 * @return a string representation of the object.
387 */
388 public String toString() {
389 return "SwingRunner";
390 }
391
392 private void abort() {
393 this.doAnt = false;
394 initialThread.interrupt();
395 }
396
397 /**
398 * @return Returns the frame.
399 */
400 public JFrame getFrame() {
401 return frame;
402 }
403
404 /**
405 * This method is only valid after the PageRenderers have been generated
406 *
407 * @return Returns the pageRenderers.
408 */
409 public List getPageRenderers() {
410 return pageRenderers;
411 }
412}
Note: See TracBrowser for help on using the repository browser.