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

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

findbugs - BC_UNCONFIRMED_CAST_OF_RETURN
  • Property svn:eol-style set to native
File size: 12.7 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 (!"".equals(duration)) {
161 throw new IllegalStateException("This tasks has already been finished");
162 }
163 duration = tr(" ({0})", Utils.getDurationString(System.currentTimeMillis() - start));
164 }
165
166 @Override
167 public StringBuilder toHtml(StringBuilder sb) {
168 return sb.append(name).append("<i style='color: #666666;'>").append(duration).append("</i>");
169 }
170
171 @Override
172 public boolean equals(Object o) {
173 if (this == o) return true;
174 if (o == null || getClass() != o.getClass()) return false;
175 MeasurableTask that = (MeasurableTask) o;
176 return Objects.equals(name, that.name);
177 }
178
179 @Override
180 public int hashCode() {
181 return Objects.hashCode(name);
182 }
183 }
184
185 /**
186 * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
187 */
188 public static class SplashProgressMonitor extends Task implements ProgressMonitor {
189
190 private final String name;
191 private final ChangeListener listener;
192 private final List<Task> tasks = new CopyOnWriteArrayList<>();
193 private SplashProgressMonitor latestSubtask;
194
195 /**
196 * Constructs a new {@code SplashProgressMonitor}.
197 * @param name name
198 * @param listener change listener
199 */
200 public SplashProgressMonitor(String name, ChangeListener listener) {
201 this.name = name;
202 this.listener = listener;
203 }
204
205 @Override
206 public StringBuilder toHtml(StringBuilder sb) {
207 sb.append(Utils.firstNonNull(name, ""));
208 if (!tasks.isEmpty()) {
209 sb.append("<ul>");
210 for (Task i : tasks) {
211 sb.append("<li>");
212 i.toHtml(sb);
213 sb.append("</li>");
214 }
215 sb.append("</ul>");
216 }
217 return sb;
218 }
219
220 @Override
221 public void beginTask(String title) {
222 if (title != null && !title.isEmpty()) {
223 if (Main.isDebugEnabled()) {
224 Main.debug(title);
225 }
226 final MeasurableTask task = new MeasurableTask(title);
227 tasks.add(task);
228 listener.stateChanged(null);
229 }
230 }
231
232 @Override
233 public void beginTask(String title, int ticks) {
234 this.beginTask(title);
235 }
236
237 @Override
238 public void setCustomText(String text) {
239 this.beginTask(text);
240 }
241
242 @Override
243 public void setExtraText(String text) {
244 this.beginTask(text);
245 }
246
247 @Override
248 public void indeterminateSubTask(String title) {
249 this.subTask(title);
250 }
251
252 @Override
253 public void subTask(String title) {
254 if (Main.isDebugEnabled()) {
255 Main.debug(title);
256 }
257 latestSubtask = new SplashProgressMonitor(title, listener);
258 tasks.add(latestSubtask);
259 listener.stateChanged(null);
260 }
261
262 @Override
263 public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
264 if (latestSubtask != null) {
265 return latestSubtask;
266 } else {
267 // subTask has not been called before, such as for plugin update, #11874
268 return this;
269 }
270 }
271
272 /**
273 * @deprecated Use {@link #finishTask(String)} instead.
274 */
275 @Override
276 @Deprecated
277 public void finishTask() {
278 // Not used
279 }
280
281 /**
282 * Displays the given task as finished.
283 * @param title the task title
284 */
285 public void finishTask(String title) {
286 final Task task = Utils.find(tasks, new MeasurableTask(title)::equals);
287 if (task instanceof MeasurableTask) {
288 ((MeasurableTask) task).finish();
289 if (Main.isDebugEnabled()) {
290 Main.debug(tr("{0} completed in {1}", title, ((MeasurableTask) task).duration));
291 }
292 listener.stateChanged(null);
293 }
294 }
295
296 @Override
297 public void invalidate() {
298 // Not used
299 }
300
301 @Override
302 public void setTicksCount(int ticks) {
303 // Not used
304 }
305
306 @Override
307 public int getTicksCount() {
308 return 0;
309 }
310
311 @Override
312 public void setTicks(int ticks) {
313 // Not used
314 }
315
316 @Override
317 public int getTicks() {
318 return 0;
319 }
320
321 @Override
322 public void worked(int ticks) {
323 // Not used
324 }
325
326 @Override
327 public boolean isCanceled() {
328 return false;
329 }
330
331 @Override
332 public void cancel() {
333 // Not used
334 }
335
336 @Override
337 public void addCancelListener(CancelListener listener) {
338 // Not used
339 }
340
341 @Override
342 public void removeCancelListener(CancelListener listener) {
343 // Not used
344 }
345
346 @Override
347 public void appendLogMessage(String message) {
348 // Not used
349 }
350
351 @Override
352 public void setProgressTaskId(ProgressTaskId taskId) {
353 // Not used
354 }
355
356 @Override
357 public ProgressTaskId getProgressTaskId() {
358 return null;
359 }
360
361 @Override
362 public Component getWindowParent() {
363 return Main.parent;
364 }
365 }
366
367 /**
368 * Returns the progress monitor.
369 * @return The progress monitor
370 */
371 public SplashProgressMonitor getProgressMonitor() {
372 return progressMonitor;
373 }
374
375 private static class SplashScreenProgressRenderer extends JPanel {
376 private final JosmEditorPane lblTaskTitle = new JosmEditorPane();
377 private final JProgressBar progressBar = new JProgressBar(JProgressBar.HORIZONTAL);
378 private static final String LABEL_HTML = "<html>"
379 + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>";
380
381 protected void build() {
382 setLayout(new GridBagLayout());
383
384 JosmEditorPane.makeJLabelLike(lblTaskTitle, false);
385 lblTaskTitle.setText(LABEL_HTML);
386 final JScrollPane scrollPane = new JScrollPane(lblTaskTitle,
387 ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED, ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
388 scrollPane.setPreferredSize(new Dimension(0, 320));
389 scrollPane.setBorder(BorderFactory.createEmptyBorder());
390 add(scrollPane, GBC.eol().insets(5, 5, 0, 0).fill(GridBagConstraints.HORIZONTAL));
391
392 progressBar.setIndeterminate(true);
393 add(progressBar, GBC.eol().insets(5, 15, 0, 0).fill(GridBagConstraints.HORIZONTAL));
394 }
395
396 /**
397 * Constructs a new {@code SplashScreenProgressRenderer}.
398 */
399 SplashScreenProgressRenderer() {
400 build();
401 }
402
403 /**
404 * Sets the tasks to displayed. A HTML formatted list is expected.
405 * @param tasks HTML formatted list of tasks
406 */
407 public void setTasks(String tasks) {
408 lblTaskTitle.setText(LABEL_HTML + tasks);
409 lblTaskTitle.setCaretPosition(lblTaskTitle.getDocument().getLength());
410 }
411 }
412}
Note: See TracBrowser for help on using the repository browser.