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

Last change on this file since 12580 was 12405, checked in by Don-vip, 7 years ago

fix #14938 - robustness to system date changing during startup
  • Property svn:eol-style set to native
File size: 13.0 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.Container;
9import java.awt.Dimension;
10import java.awt.GridBagConstraints;
11import java.awt.GridBagLayout;
12import java.awt.Insets;
13import java.awt.event.MouseAdapter;
14import java.awt.event.MouseEvent;
15import java.util.List;
16import java.util.Objects;
17import java.util.concurrent.CopyOnWriteArrayList;
18
19import javax.swing.BorderFactory;
20import javax.swing.JComponent;
21import javax.swing.JFrame;
22import javax.swing.JLabel;
23import javax.swing.JPanel;
24import javax.swing.JProgressBar;
25import javax.swing.JScrollPane;
26import javax.swing.JSeparator;
27import javax.swing.ScrollPaneConstants;
28import javax.swing.border.Border;
29import javax.swing.border.EmptyBorder;
30import javax.swing.border.EtchedBorder;
31import javax.swing.event.ChangeEvent;
32import javax.swing.event.ChangeListener;
33
34import org.openstreetmap.josm.Main;
35import org.openstreetmap.josm.data.Version;
36import org.openstreetmap.josm.gui.progress.ProgressMonitor;
37import org.openstreetmap.josm.gui.progress.ProgressTaskId;
38import org.openstreetmap.josm.gui.util.GuiHelper;
39import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
40import org.openstreetmap.josm.tools.GBC;
41import org.openstreetmap.josm.tools.ImageProvider;
42import org.openstreetmap.josm.tools.Utils;
43import org.openstreetmap.josm.tools.WindowGeometry;
44
45/**
46 * Show a splash screen so the user knows what is happening during startup.
47 * @since 976
48 */
49public class SplashScreen extends JFrame implements ChangeListener {
50
51 private final transient SplashProgressMonitor progressMonitor;
52 private final SplashScreenProgressRenderer progressRenderer;
53
54 /**
55 * Constructs a new {@code SplashScreen}.
56 */
57 public SplashScreen() {
58 setUndecorated(true);
59
60 // Add a nice border to the main splash screen
61 Container contentPane = this.getContentPane();
62 Border margin = new EtchedBorder(1, Color.white, Color.gray);
63 if (contentPane instanceof JComponent) {
64 ((JComponent) contentPane).setBorder(margin);
65 }
66
67 // Add a margin from the border to the content
68 JPanel innerContentPane = new JPanel(new GridBagLayout());
69 innerContentPane.setBorder(new EmptyBorder(10, 10, 2, 10));
70 contentPane.add(innerContentPane);
71
72 // Add the logo
73 JLabel logo = new JLabel(ImageProvider.get("logo.svg", ImageProvider.ImageSizes.SPLASH_LOGO));
74 GridBagConstraints gbc = new GridBagConstraints();
75 gbc.gridheight = 2;
76 gbc.insets = new Insets(0, 0, 0, 70);
77 innerContentPane.add(logo, gbc);
78
79 // Add the name of this application
80 JLabel caption = new JLabel("JOSM – " + tr("Java OpenStreetMap Editor"));
81 caption.setFont(GuiHelper.getTitleFont());
82 gbc.gridheight = 1;
83 gbc.gridx = 1;
84 gbc.insets = new Insets(30, 0, 0, 0);
85 innerContentPane.add(caption, gbc);
86
87 // Add the version number
88 JLabel version = new JLabel(tr("Version {0}", Version.getInstance().getVersionString()));
89 gbc.gridy = 1;
90 gbc.insets = new Insets(0, 0, 0, 0);
91 innerContentPane.add(version, gbc);
92
93 // Add a separator to the status text
94 JSeparator separator = new JSeparator(JSeparator.HORIZONTAL);
95 gbc.gridx = 0;
96 gbc.gridy = 2;
97 gbc.gridwidth = 2;
98 gbc.fill = GridBagConstraints.HORIZONTAL;
99 gbc.insets = new Insets(15, 0, 5, 0);
100 innerContentPane.add(separator, gbc);
101
102 // Add a status message
103 progressRenderer = new SplashScreenProgressRenderer();
104 gbc.gridy = 3;
105 gbc.insets = new Insets(0, 0, 10, 0);
106 innerContentPane.add(progressRenderer, gbc);
107 progressMonitor = new SplashProgressMonitor(null, this);
108
109 pack();
110
111 WindowGeometry.centerOnScreen(this.getSize(), "gui.geometry").applySafe(this);
112
113 // Add ability to hide splash screen by clicking it
114 addMouseListener(new MouseAdapter() {
115 @Override
116 public void mousePressed(MouseEvent event) {
117 setVisible(false);
118 }
119 });
120 }
121
122 @Override
123 public void stateChanged(ChangeEvent ignore) {
124 GuiHelper.runInEDT(() -> progressRenderer.setTasks(progressMonitor.toString()));
125 }
126
127 /**
128 * A task (of a {@link ProgressMonitor}).
129 */
130 private abstract static class Task {
131
132 /**
133 * Returns a HTML representation for this task.
134 * @param sb a {@code StringBuilder} used to build the HTML code
135 * @return {@code sb}
136 */
137 public abstract StringBuilder toHtml(StringBuilder sb);
138
139 @Override
140 public final String toString() {
141 return toHtml(new StringBuilder(1024)).toString();
142 }
143 }
144
145 /**
146 * A single task (of a {@link ProgressMonitor}) which keeps track of its execution duration
147 * (requires a call to {@link #finish()}).
148 */
149 private static class MeasurableTask extends Task {
150 private final String name;
151 private final long start;
152 private String duration = "";
153
154 MeasurableTask(String name) {
155 this.name = name;
156 this.start = System.currentTimeMillis();
157 }
158
159 public void finish() {
160 if (isFinished()) {
161 throw new IllegalStateException("This task has already been finished: " + name);
162 }
163 long time = System.currentTimeMillis() - start;
164 if (time >= 0) {
165 duration = tr(" ({0})", Utils.getDurationString(time));
166 }
167 }
168
169 /**
170 * Determines if this task has been finished.
171 * @return {@code true} if this task has been finished
172 */
173 public boolean isFinished() {
174 return !duration.isEmpty();
175 }
176
177 @Override
178 public StringBuilder toHtml(StringBuilder sb) {
179 return sb.append(name).append("<i style='color: #666666;'>").append(duration).append("</i>");
180 }
181
182 @Override
183 public boolean equals(Object o) {
184 if (this == o) return true;
185 if (o == null || getClass() != o.getClass()) return false;
186 MeasurableTask that = (MeasurableTask) o;
187 return Objects.equals(name, that.name)
188 && isFinished() == that.isFinished();
189 }
190
191 @Override
192 public int hashCode() {
193 return Objects.hashCode(name);
194 }
195 }
196
197 /**
198 * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
199 */
200 public static class SplashProgressMonitor extends Task implements ProgressMonitor {
201
202 private final String name;
203 private final ChangeListener listener;
204 private final List<Task> tasks = new CopyOnWriteArrayList<>();
205 private SplashProgressMonitor latestSubtask;
206
207 /**
208 * Constructs a new {@code SplashProgressMonitor}.
209 * @param name name
210 * @param listener change listener
211 */
212 public SplashProgressMonitor(String name, ChangeListener listener) {
213 this.name = name;
214 this.listener = listener;
215 }
216
217 @Override
218 public StringBuilder toHtml(StringBuilder sb) {
219 sb.append(Utils.firstNonNull(name, ""));
220 if (!tasks.isEmpty()) {
221 sb.append("<ul>");
222 for (Task i : tasks) {
223 sb.append("<li>");
224 i.toHtml(sb);
225 sb.append("</li>");
226 }
227 sb.append("</ul>");
228 }
229 return sb;
230 }
231
232 @Override
233 public void beginTask(String title) {
234 if (title != null && !title.isEmpty()) {
235 if (Main.isDebugEnabled()) {
236 Main.debug(title);
237 }
238 final MeasurableTask task = new MeasurableTask(title);
239 tasks.add(task);
240 listener.stateChanged(null);
241 }
242 }
243
244 @Override
245 public void beginTask(String title, int ticks) {
246 this.beginTask(title);
247 }
248
249 @Override
250 public void setCustomText(String text) {
251 this.beginTask(text);
252 }
253
254 @Override
255 public void setExtraText(String text) {
256 this.beginTask(text);
257 }
258
259 @Override
260 public void indeterminateSubTask(String title) {
261 this.subTask(title);
262 }
263
264 @Override
265 public void subTask(String title) {
266 if (Main.isDebugEnabled()) {
267 Main.debug(title);
268 }
269 latestSubtask = new SplashProgressMonitor(title, listener);
270 tasks.add(latestSubtask);
271 listener.stateChanged(null);
272 }
273
274 @Override
275 public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
276 if (latestSubtask != null) {
277 return latestSubtask;
278 } else {
279 // subTask has not been called before, such as for plugin update, #11874
280 return this;
281 }
282 }
283
284 /**
285 * @deprecated Use {@link #finishTask(String)} instead.
286 */
287 @Override
288 @Deprecated
289 public void finishTask() {
290 // Not used
291 }
292
293 /**
294 * Displays the given task as finished.
295 * @param title the task title
296 */
297 public void finishTask(String title) {
298 final Task task = Utils.find(tasks, new MeasurableTask(title)::equals);
299 if (task instanceof MeasurableTask) {
300 ((MeasurableTask) task).finish();
301 if (Main.isDebugEnabled()) {
302 Main.debug(tr("{0} completed in {1}", title, ((MeasurableTask) task).duration));
303 }
304 listener.stateChanged(null);
305 }
306 }
307
308 @Override
309 public void invalidate() {
310 // Not used
311 }
312
313 @Override
314 public void setTicksCount(int ticks) {
315 // Not used
316 }
317
318 @Override
319 public int getTicksCount() {
320 return 0;
321 }
322
323 @Override
324 public void setTicks(int ticks) {
325 // Not used
326 }
327
328 @Override
329 public int getTicks() {
330 return 0;
331 }
332
333 @Override
334 public void worked(int ticks) {
335 // Not used
336 }
337
338 @Override
339 public boolean isCanceled() {
340 return false;
341 }
342
343 @Override
344 public void cancel() {
345 // Not used
346 }
347
348 @Override
349 public void addCancelListener(CancelListener listener) {
350 // Not used
351 }
352
353 @Override
354 public void removeCancelListener(CancelListener listener) {
355 // Not used
356 }
357
358 @Override
359 public void appendLogMessage(String message) {
360 // Not used
361 }
362
363 @Override
364 public void setProgressTaskId(ProgressTaskId taskId) {
365 // Not used
366 }
367
368 @Override
369 public ProgressTaskId getProgressTaskId() {
370 return null;
371 }
372
373 @Override
374 public Component getWindowParent() {
375 return Main.parent;
376 }
377 }
378
379 /**
380 * Returns the progress monitor.
381 * @return The progress monitor
382 */
383 public SplashProgressMonitor getProgressMonitor() {
384 return progressMonitor;
385 }
386
387 private static class SplashScreenProgressRenderer extends JPanel {
388 private final JosmEditorPane lblTaskTitle = new JosmEditorPane();
389 private final JProgressBar progressBar = new JProgressBar(JProgressBar.HORIZONTAL);
390 private static final String LABEL_HTML = "<html>"
391 + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>";
392
393 protected void build() {
394 setLayout(new GridBagLayout());
395
396 JosmEditorPane.makeJLabelLike(lblTaskTitle, false);
397 lblTaskTitle.setText(LABEL_HTML);
398 final JScrollPane scrollPane = new JScrollPane(lblTaskTitle,
399 ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED, ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
400 scrollPane.setPreferredSize(new Dimension(0, 320));
401 scrollPane.setBorder(BorderFactory.createEmptyBorder());
402 add(scrollPane, GBC.eol().insets(5, 5, 0, 0).fill(GridBagConstraints.HORIZONTAL));
403
404 progressBar.setIndeterminate(true);
405 add(progressBar, GBC.eol().insets(5, 15, 0, 0).fill(GridBagConstraints.HORIZONTAL));
406 }
407
408 /**
409 * Constructs a new {@code SplashScreenProgressRenderer}.
410 */
411 SplashScreenProgressRenderer() {
412 build();
413 }
414
415 /**
416 * Sets the tasks to displayed. A HTML formatted list is expected.
417 * @param tasks HTML formatted list of tasks
418 */
419 public void setTasks(String tasks) {
420 lblTaskTitle.setText(LABEL_HTML + tasks);
421 lblTaskTitle.setCaretPosition(lblTaskTitle.getDocument().getLength());
422 }
423 }
424}
Note: See TracBrowser for help on using the repository browser.