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

Last change on this file since 15615 was 15615, checked in by oranfry, 16 years ago

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