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

Last change on this file since 10621 was 10611, checked in by Don-vip, 9 years ago

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