source: josm/trunk/src/org/openstreetmap/josm/gui/SplashScreen.java@ 8497

Last change on this file since 8497 was 8497, checked in by simon04, 10 years ago

fix #11355 - Splash screen: display parallel initialization tasks in a sensible way
  • Property svn:eol-style set to native
File size: 10.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Color;
7import java.awt.Component;
8import java.awt.Graphics;
9import java.awt.GridBagConstraints;
10import java.awt.GridBagLayout;
11import java.awt.Image;
12import java.awt.Insets;
13import java.awt.event.MouseAdapter;
14import java.awt.event.MouseEvent;
15import java.util.ArrayList;
16import java.util.Collections;
17import java.util.List;
18import java.util.Objects;
19
20import javax.swing.ImageIcon;
21import javax.swing.JFrame;
22import javax.swing.JLabel;
23import javax.swing.JPanel;
24import javax.swing.JProgressBar;
25import javax.swing.JSeparator;
26import javax.swing.border.Border;
27import javax.swing.border.EmptyBorder;
28import javax.swing.border.EtchedBorder;
29import javax.swing.event.ChangeEvent;
30import javax.swing.event.ChangeListener;
31
32import org.openstreetmap.josm.Main;
33import org.openstreetmap.josm.data.Version;
34import org.openstreetmap.josm.gui.progress.ProgressMonitor;
35import org.openstreetmap.josm.gui.progress.ProgressTaskId;
36import org.openstreetmap.josm.gui.util.GuiHelper;
37import org.openstreetmap.josm.tools.ImageProvider;
38import org.openstreetmap.josm.tools.Predicates;
39import org.openstreetmap.josm.tools.Utils;
40import org.openstreetmap.josm.tools.WindowGeometry;
41
42/**
43 * Show a splash screen so the user knows what is happening during startup.
44 * @since 976
45 */
46public class SplashScreen extends JFrame implements ChangeListener {
47
48 private final SplashProgressMonitor progressMonitor;
49 private final SplashScreenProgressRenderer progressRenderer;
50
51 /**
52 * Constructs a new {@code SplashScreen}.
53 */
54 public SplashScreen() {
55 setUndecorated(true);
56
57 // Add a nice border to the main splash screen
58 JPanel contentPane = (JPanel)this.getContentPane();
59 Border margin = new EtchedBorder(1, Color.white, Color.gray);
60 contentPane.setBorder(margin);
61
62 // Add a margin from the border to the content
63 JPanel innerContentPane = new JPanel();
64 innerContentPane.setBorder(new EmptyBorder(10, 10, 2, 10));
65 contentPane.add(innerContentPane);
66 innerContentPane.setLayout(new GridBagLayout());
67
68 // Add the logo
69 JLabel logo = new JLabel(new ImageIcon(ImageProvider.get("logo.svg").getImage().getScaledInstance(128, 129, Image.SCALE_SMOOTH)));
70 GridBagConstraints gbc = new GridBagConstraints();
71 gbc.gridheight = 2;
72 gbc.insets = new Insets(0, 0, 0, 70);
73 innerContentPane.add(logo, gbc);
74
75 // Add the name of this application
76 JLabel caption = new JLabel("JOSM – " + tr("Java OpenStreetMap Editor"));
77 caption.setFont(GuiHelper.getTitleFont());
78 gbc.gridheight = 1;
79 gbc.gridx = 1;
80 gbc.insets = new Insets(30, 0, 0, 0);
81 innerContentPane.add(caption, gbc);
82
83 // Add the version number
84 JLabel version = new JLabel(tr("Version {0}", Version.getInstance().getVersionString()));
85 gbc.gridy = 1;
86 gbc.insets = new Insets(0, 0, 0, 0);
87 innerContentPane.add(version, gbc);
88
89 // Add a separator to the status text
90 JSeparator separator = new JSeparator(JSeparator.HORIZONTAL);
91 gbc.gridx = 0;
92 gbc.gridy = 2;
93 gbc.gridwidth = 2;
94 gbc.fill = GridBagConstraints.HORIZONTAL;
95 gbc.insets = new Insets(15, 0, 5, 0);
96 innerContentPane.add(separator, gbc);
97
98 // Add a status message
99 progressRenderer = new SplashScreenProgressRenderer();
100 gbc.gridy = 3;
101 gbc.insets = new Insets(0, 0, 10, 0);
102 innerContentPane.add(progressRenderer, gbc);
103 progressMonitor = new SplashProgressMonitor(null, this);
104
105 pack();
106
107 WindowGeometry.centerOnScreen(this.getSize(), "gui.geometry").applySafe(this);
108
109 // Add ability to hide splash screen by clicking it
110 addMouseListener(new MouseAdapter() {
111 @Override
112 public void mousePressed(MouseEvent event) {
113 setVisible(false);
114 }
115 });
116 }
117
118 @Override
119 public void stateChanged(ChangeEvent ignore) {
120 progressRenderer.setTasks("<html>"
121 + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>"
122 + "<body height='320'>"
123 + progressMonitor.toString());
124 }
125
126 /**
127 * A task (of a {@link ProgressMonitor}).
128 */
129 private static abstract class Task {
130
131 /**
132 * Returns a HTML representation for this task.
133 */
134 public abstract String toHtml();
135
136 @Override
137 public final String toString() {
138 return toHtml();
139 }
140 }
141
142 /**
143 * A single task (of a {@link ProgressMonitor}) which keeps track of its execution duration
144 * (requires a call to {@link #finish()}).
145 */
146 private static class MeasurableTask extends Task {
147 private final String name;
148 private final long start;
149 private String duration = "";
150
151 public MeasurableTask(String name) {
152 this.name = name;
153 this.start = System.currentTimeMillis();
154 }
155
156 public void finish() {
157 if (!"".equals(duration)) {
158 throw new IllegalStateException("This tasks has already been finished");
159 }
160 duration = tr(" ({0})", Utils.getDurationString(System.currentTimeMillis() - start));
161 }
162
163 @Override
164 public String toHtml() {
165 return name + "<i style='color: #666666;'>" + duration + "</i>";
166 }
167
168 @Override
169 public boolean equals(Object o) {
170 if (this == o) return true;
171 if (o == null || getClass() != o.getClass()) return false;
172 MeasurableTask that = (MeasurableTask) o;
173 return Objects.equals(name, that.name);
174 }
175
176 @Override
177 public int hashCode() {
178 return Objects.hashCode(name);
179 }
180 }
181
182 /**
183 * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
184 */
185 public static class SplashProgressMonitor extends Task implements ProgressMonitor {
186
187 private final String name;
188 private final ChangeListener listener;
189 private final List<Task> tasks = Collections.synchronizedList(new ArrayList<Task>());
190 private SplashProgressMonitor latestSubtask;
191
192 public SplashProgressMonitor(String name, ChangeListener listener) {
193 this.name = name;
194 this.listener = listener;
195 }
196
197 @Override
198 public String toHtml() {
199 synchronized (tasks) {
200 return Utils.firstNonNull(name, "") + (tasks.isEmpty() ? "" : Utils.joinAsHtmlUnorderedList(tasks));
201 }
202 }
203
204 @Override
205 public void beginTask(String title) {
206 if (title != null) {
207 final MeasurableTask task = new MeasurableTask(title);
208 tasks.add(task);
209 listener.stateChanged(null);
210 }
211 }
212
213 @Override
214 public void beginTask(String title, int ticks) {
215 this.beginTask(title);
216 }
217
218 @Override
219 public void setCustomText(String text) {
220 this.beginTask(text);
221 }
222
223 @Override
224 public void setExtraText(String text) {
225 this.beginTask(text);
226 }
227
228 @Override
229 public void indeterminateSubTask(String title) {
230 this.subTask(title);
231 }
232
233 @Override
234 public void subTask(String title) {
235 latestSubtask = new SplashProgressMonitor(title, listener);
236 tasks.add(latestSubtask);
237 listener.stateChanged(null);
238 }
239
240 @Override
241 public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
242 return latestSubtask;
243 }
244
245 @Override
246 @Deprecated
247 public void finishTask() {
248 }
249
250 public void finishTask(String title) {
251 final Task task = Utils.find(tasks, Predicates.<Task>equalTo(new MeasurableTask(title)));
252 if (task != null && task instanceof MeasurableTask) {
253 ((MeasurableTask) task).finish();
254 Main.debug(tr("{0} completed in {1}", title, ((MeasurableTask) task).duration));
255 listener.stateChanged(null);
256 }
257 }
258
259 @Override
260 public void invalidate() {
261 }
262
263 @Override
264 public void setTicksCount(int ticks) {
265 }
266
267 @Override
268 public int getTicksCount() {
269 return 0;
270 }
271
272 @Override
273 public void setTicks(int ticks) {
274 }
275
276 @Override
277 public int getTicks() {
278 return 0;
279 }
280
281 @Override
282 public void worked(int ticks) {
283 }
284
285 @Override
286 public boolean isCanceled() {
287 return false;
288 }
289
290 @Override
291 public void cancel() {
292 }
293
294 @Override
295 public void addCancelListener(CancelListener listener) {
296 }
297
298 @Override
299 public void removeCancelListener(CancelListener listener) {
300 }
301
302 @Override
303 public void appendLogMessage(String message) {
304 }
305
306 @Override
307 public void setProgressTaskId(ProgressTaskId taskId) {
308 }
309
310 @Override
311 public ProgressTaskId getProgressTaskId() {
312 return null;
313 }
314
315 @Override
316 public Component getWindowParent() {
317 return Main.parent;
318 }
319 }
320
321 /**
322 * Returns the progress monitor.
323 * @return The progress monitor
324 */
325 public SplashProgressMonitor getProgressMonitor() {
326 return progressMonitor;
327 }
328
329 private static class SplashScreenProgressRenderer extends JPanel {
330 private JLabel lblTaskTitle;
331 private JProgressBar progressBar;
332
333 protected void build() {
334 setLayout(new GridBagLayout());
335 GridBagConstraints gc = new GridBagConstraints();
336 gc.gridx = 0;
337 gc.gridy = 0;
338 gc.fill = GridBagConstraints.HORIZONTAL;
339 gc.weightx = 1.0;
340 gc.weighty = 0.0;
341 gc.insets = new Insets(5,0,0,0);
342 add(lblTaskTitle = new JLabel(" "), gc);
343
344 gc.gridy = 1;
345 gc.insets = new Insets(15,0,0,0);
346 add(progressBar = new JProgressBar(JProgressBar.HORIZONTAL), gc);
347 progressBar.setIndeterminate(true);
348 }
349
350 public SplashScreenProgressRenderer() {
351 build();
352 }
353
354 @Override
355 public void paint(Graphics g) {
356 try {
357 super.paint(g);
358 } catch (NullPointerException ignore) {
359 // NullPointerException at javax.swing.text.html.StyleSheet$ListPainter.paint
360 }
361 }
362
363 public void setTasks(String tasks) {
364 lblTaskTitle.setText(tasks);
365 repaint();
366 }
367 }
368}
Note: See TracBrowser for help on using the repository browser.