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

Last change on this file was 19373, checked in by stoecker, 12 months ago

add a note why the deprecated function cannot be removed
  • Property svn:eol-style set to native
File size: 13.4 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.Optional;
18import java.util.concurrent.CopyOnWriteArrayList;
19
20import javax.swing.BorderFactory;
21import javax.swing.JComponent;
22import javax.swing.JFrame;
23import javax.swing.JLabel;
24import javax.swing.JPanel;
25import javax.swing.JProgressBar;
26import javax.swing.JScrollPane;
27import javax.swing.JSeparator;
28import javax.swing.ScrollPaneConstants;
29import javax.swing.border.Border;
30import javax.swing.border.EmptyBorder;
31import javax.swing.border.EtchedBorder;
32import javax.swing.event.ChangeEvent;
33import javax.swing.event.ChangeListener;
34
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.util.WindowGeometry;
40import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
41import org.openstreetmap.josm.tools.GBC;
42import org.openstreetmap.josm.tools.ImageProvider;
43import org.openstreetmap.josm.tools.Logging;
44import org.openstreetmap.josm.tools.Stopwatch;
45import org.openstreetmap.josm.tools.Utils;
46
47/**
48 * Show a splash screen so the user knows what is happening during startup.
49 * @since 976
50 */
51public class SplashScreen extends JFrame implements ChangeListener {
52
53 private final transient SplashProgressMonitor progressMonitor;
54 private final SplashScreenProgressRenderer progressRenderer;
55
56 /**
57 * Constructs a new {@code SplashScreen}.
58 */
59 public SplashScreen() {
60 setUndecorated(true);
61
62 // Add a nice border to the main splash screen
63 Container contentPane = this.getContentPane();
64 Border margin = new EtchedBorder(1, Color.white, Color.gray);
65 if (contentPane instanceof JComponent) {
66 ((JComponent) contentPane).setBorder(margin);
67 }
68
69 // Add a margin from the border to the content
70 JPanel innerContentPane = new JPanel(new GridBagLayout());
71 innerContentPane.setBorder(new EmptyBorder(10, 10, 2, 10));
72 contentPane.add(innerContentPane);
73
74 // Add the logo
75 JLabel logo = new JLabel(ImageProvider.get("logo.svg", ImageProvider.ImageSizes.SPLASH_LOGO));
76 GridBagConstraints gbc = new GridBagConstraints();
77 gbc.gridheight = 2;
78 gbc.insets = new Insets(0, 0, 0, 70);
79 innerContentPane.add(logo, gbc);
80
81 // Add the name of this application
82 JLabel caption = new JLabel("JOSM – " + tr("Java OpenStreetMap Editor"));
83 caption.setFont(GuiHelper.getTitleFont());
84 gbc.gridheight = 1;
85 gbc.gridx = 1;
86 gbc.insets = new Insets(30, 0, 0, 0);
87 innerContentPane.add(caption, gbc);
88
89 // Add the version number
90 JLabel version = new JLabel(tr("Version {0}", Version.getInstance().getVersionString()));
91 gbc.gridy = 1;
92 gbc.insets = new Insets(0, 0, 0, 0);
93 innerContentPane.add(version, gbc);
94
95 // Add a separator to the status text
96 JSeparator separator = new JSeparator(JSeparator.HORIZONTAL);
97 gbc.gridx = 0;
98 gbc.gridy = 2;
99 gbc.gridwidth = 2;
100 gbc.fill = GridBagConstraints.HORIZONTAL;
101 gbc.insets = new Insets(15, 0, 5, 0);
102 innerContentPane.add(separator, gbc);
103
104 // Add a status message
105 progressRenderer = new SplashScreenProgressRenderer();
106 gbc.gridy = 3;
107 gbc.insets = new Insets(0, 0, 10, 0);
108 innerContentPane.add(progressRenderer, gbc);
109 progressMonitor = new SplashProgressMonitor(null, this);
110
111 pack();
112
113 WindowGeometry.centerOnScreen(this.getSize(), WindowGeometry.PREF_KEY_GUI_GEOMETRY).applySafe(this);
114
115 // Add ability to hide splash screen by clicking it
116 addMouseListener(new MouseAdapter() {
117 @Override
118 public void mousePressed(MouseEvent event) {
119 setVisible(false);
120 }
121 });
122 }
123
124 @Override
125 public void stateChanged(ChangeEvent ignore) {
126 GuiHelper.runInEDT(() -> progressRenderer.setTasks(progressMonitor.toString()));
127 }
128
129 /**
130 * A task (of a {@link ProgressMonitor}).
131 */
132 private abstract static class Task {
133
134 /**
135 * Returns a HTML representation for this task.
136 * @param sb a {@code StringBuilder} used to build the HTML code
137 * @return {@code sb}
138 */
139 public abstract StringBuilder toHtml(StringBuilder sb);
140
141 @Override
142 public final String toString() {
143 return toHtml(new StringBuilder(1024)).toString();
144 }
145 }
146
147 /**
148 * A single task (of a {@link ProgressMonitor}) which keeps track of its execution duration
149 * (requires a call to {@link #finish()}).
150 */
151 private static class MeasurableTask extends Task {
152 private final String name;
153 private final Stopwatch stopwatch;
154 private String duration = "";
155
156 MeasurableTask(String name) {
157 this.name = name;
158 this.stopwatch = Stopwatch.createStarted();
159 }
160
161 public void finish() {
162 if (isFinished()) {
163 throw new IllegalStateException("This task has already been finished: " + name);
164 }
165 if (stopwatch.elapsed() >= 0) {
166 Logging.debug(stopwatch.toString(name));
167 duration = tr(" ({0})", stopwatch);
168 }
169 }
170
171 /**
172 * Determines if this task has been finished.
173 * @return {@code true} if this task has been finished
174 */
175 public boolean isFinished() {
176 return !duration.isEmpty();
177 }
178
179 @Override
180 public StringBuilder toHtml(StringBuilder sb) {
181 return sb.append(name).append("<i style='color: #666666;'>").append(duration).append("</i>");
182 }
183
184 @Override
185 public boolean equals(Object o) {
186 if (this == o) return true;
187 if (o == null || getClass() != o.getClass()) return false;
188 MeasurableTask that = (MeasurableTask) o;
189 return Objects.equals(name, that.name)
190 && isFinished() == that.isFinished();
191 }
192
193 @Override
194 public int hashCode() {
195 return Objects.hashCode(name);
196 }
197 }
198
199 /**
200 * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
201 */
202 public static class SplashProgressMonitor extends Task implements ProgressMonitor {
203
204 private final String name;
205 private final ChangeListener listener;
206 private final List<Task> tasks = new CopyOnWriteArrayList<>();
207 private SplashProgressMonitor latestSubtask;
208
209 /**
210 * Constructs a new {@code SplashProgressMonitor}.
211 * @param name name
212 * @param listener change listener
213 */
214 public SplashProgressMonitor(String name, ChangeListener listener) {
215 this.name = name;
216 this.listener = listener;
217 }
218
219 @Override
220 public StringBuilder toHtml(StringBuilder sb) {
221 sb.append(Utils.firstNonNull(name, ""));
222 if (!tasks.isEmpty()) {
223 sb.append("<ul>");
224 for (Task i : tasks) {
225 sb.append("<li>");
226 i.toHtml(sb);
227 sb.append("</li>");
228 }
229 sb.append("</ul>");
230 }
231 return sb;
232 }
233
234 @Override
235 public void beginTask(String title) {
236 if (!Utils.isEmpty(title)) {
237 Logging.debug(title);
238 final MeasurableTask task = new MeasurableTask(title);
239 tasks.add(task);
240 listener.stateChanged(new ChangeEvent(this));
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 Logging.debug(title);
267 latestSubtask = new SplashProgressMonitor(title, listener);
268 tasks.add(latestSubtask);
269 listener.stateChanged(new ChangeEvent(this));
270 }
271
272 @Override
273 public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
274 if (latestSubtask != null) {
275 return latestSubtask;
276 } else {
277 // subTask has not been called before, such as for plugin update, #11874
278 return this;
279 }
280 }
281
282 /**
283 * @deprecated Use {@link #finishTask(String)} instead.
284 * This function is required by ProgressMonitor interface and cannot be
285 * removed.
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 Optional<Task> taskOptional = tasks.stream()
299 .filter(new MeasurableTask(title)::equals)
300 .filter(MeasurableTask.class::isInstance)
301 .findAny();
302 taskOptional.ifPresent(task -> {
303 ((MeasurableTask) task).finish();
304 listener.stateChanged(new ChangeEvent(this));
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 MainApplication.getMainFrame();
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 JScrollPane scrollPane = new JScrollPane(lblTaskTitle,
390 ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED, ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
391 private final JProgressBar progressBar = new JProgressBar(JProgressBar.HORIZONTAL);
392 private static final String LABEL_HTML = "<html>"
393 + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>";
394
395 private String lastTasks;
396
397 protected void build() {
398 setLayout(new GridBagLayout());
399
400 JosmEditorPane.makeJLabelLike(lblTaskTitle, false);
401 lblTaskTitle.setText(LABEL_HTML);
402 scrollPane.setPreferredSize(new Dimension(0, 320));
403 scrollPane.setBorder(BorderFactory.createEmptyBorder());
404 add(scrollPane, GBC.eol().insets(5, 5, 0, 0).fill(GridBagConstraints.HORIZONTAL));
405
406 progressBar.setIndeterminate(true);
407 add(progressBar, GBC.eol().insets(5, 15, 0, 0).fill(GridBagConstraints.HORIZONTAL));
408 }
409
410 /**
411 * Constructs a new {@code SplashScreenProgressRenderer}.
412 */
413 SplashScreenProgressRenderer() {
414 build();
415 }
416
417 /**
418 * Sets the tasks to displayed. A HTML formatted list is expected.
419 * @param tasks HTML formatted list of tasks
420 */
421 public void setTasks(String tasks) {
422 // Only update the display when the tasks change
423 if (!Objects.equals(lastTasks, tasks)) {
424 lastTasks = tasks;
425 lblTaskTitle.setText(LABEL_HTML + tasks);
426 lblTaskTitle.setCaretPosition(lblTaskTitle.getDocument().getLength());
427 scrollPane.getHorizontalScrollBar().setValue(0);
428 }
429 }
430 }
431}
Note: See TracBrowser for help on using the repository browser.