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

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

see #11355 - Splash screen: attempt to fix dialog height issue (2)
  • Property svn:eol-style set to native
File size: 10.9 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(progressMonitor.toString());
121 }
122
123 /**
124 * A task (of a {@link ProgressMonitor}).
125 */
126 private static abstract class Task {
127
128 /**
129 * Returns a HTML representation for this task.
130 */
131 public abstract String toHtml();
132
133 @Override
134 public final String toString() {
135 return toHtml();
136 }
137 }
138
139 /**
140 * A single task (of a {@link ProgressMonitor}) which keeps track of its execution duration
141 * (requires a call to {@link #finish()}).
142 */
143 private static class MeasurableTask extends Task {
144 private final String name;
145 private final long start;
146 private String duration = "";
147
148 public MeasurableTask(String name) {
149 this.name = name;
150 this.start = System.currentTimeMillis();
151 }
152
153 public void finish() {
154 if (!"".equals(duration)) {
155 throw new IllegalStateException("This tasks has already been finished");
156 }
157 duration = tr(" ({0})", Utils.getDurationString(System.currentTimeMillis() - start));
158 }
159
160 @Override
161 public String toHtml() {
162 return name + "<i style='color: #666666;'>" + duration + "</i>";
163 }
164
165 @Override
166 public boolean equals(Object o) {
167 if (this == o) return true;
168 if (o == null || getClass() != o.getClass()) return false;
169 MeasurableTask that = (MeasurableTask) o;
170 return Objects.equals(name, that.name);
171 }
172
173 @Override
174 public int hashCode() {
175 return Objects.hashCode(name);
176 }
177 }
178
179 /**
180 * A {@link ProgressMonitor} which stores the (sub)tasks in a tree.
181 */
182 public static class SplashProgressMonitor extends Task implements ProgressMonitor {
183
184 private final String name;
185 private final ChangeListener listener;
186 private final List<Task> tasks = Collections.synchronizedList(new ArrayList<Task>());
187 private SplashProgressMonitor latestSubtask;
188
189 public SplashProgressMonitor(String name, ChangeListener listener) {
190 this.name = name;
191 this.listener = listener;
192 }
193
194 @Override
195 public String toHtml() {
196 synchronized (tasks) {
197 return Utils.firstNonNull(name, "") + (tasks.isEmpty() ? "" : Utils.joinAsHtmlUnorderedList(tasks));
198 }
199 }
200
201 @Override
202 public void beginTask(String title) {
203 if (title != null) {
204 final MeasurableTask task = new MeasurableTask(title);
205 tasks.add(task);
206 listener.stateChanged(null);
207 }
208 }
209
210 @Override
211 public void beginTask(String title, int ticks) {
212 this.beginTask(title);
213 }
214
215 @Override
216 public void setCustomText(String text) {
217 this.beginTask(text);
218 }
219
220 @Override
221 public void setExtraText(String text) {
222 this.beginTask(text);
223 }
224
225 @Override
226 public void indeterminateSubTask(String title) {
227 this.subTask(title);
228 }
229
230 @Override
231 public void subTask(String title) {
232 latestSubtask = new SplashProgressMonitor(title, listener);
233 tasks.add(latestSubtask);
234 listener.stateChanged(null);
235 }
236
237 @Override
238 public ProgressMonitor createSubTaskMonitor(int ticks, boolean internal) {
239 return latestSubtask;
240 }
241
242 @Override
243 @Deprecated
244 public void finishTask() {
245 }
246
247 public void finishTask(String title) {
248 final Task task = Utils.find(tasks, Predicates.<Task>equalTo(new MeasurableTask(title)));
249 if (task != null && task instanceof MeasurableTask) {
250 ((MeasurableTask) task).finish();
251 Main.debug(tr("{0} completed in {1}", title, ((MeasurableTask) task).duration));
252 listener.stateChanged(null);
253 }
254 }
255
256 @Override
257 public void invalidate() {
258 }
259
260 @Override
261 public void setTicksCount(int ticks) {
262 }
263
264 @Override
265 public int getTicksCount() {
266 return 0;
267 }
268
269 @Override
270 public void setTicks(int ticks) {
271 }
272
273 @Override
274 public int getTicks() {
275 return 0;
276 }
277
278 @Override
279 public void worked(int ticks) {
280 }
281
282 @Override
283 public boolean isCanceled() {
284 return false;
285 }
286
287 @Override
288 public void cancel() {
289 }
290
291 @Override
292 public void addCancelListener(CancelListener listener) {
293 }
294
295 @Override
296 public void removeCancelListener(CancelListener listener) {
297 }
298
299 @Override
300 public void appendLogMessage(String message) {
301 }
302
303 @Override
304 public void setProgressTaskId(ProgressTaskId taskId) {
305 }
306
307 @Override
308 public ProgressTaskId getProgressTaskId() {
309 return null;
310 }
311
312 @Override
313 public Component getWindowParent() {
314 return Main.parent;
315 }
316 }
317
318 /**
319 * Returns the progress monitor.
320 * @return The progress monitor
321 */
322 public SplashProgressMonitor getProgressMonitor() {
323 return progressMonitor;
324 }
325
326 private static class SplashScreenProgressRenderer extends JPanel {
327 private JLabel lblTaskTitle;
328 private JProgressBar progressBar;
329 private static final String labelHtml = "<html>"
330 + "<style>ul {margin-top: 0; margin-bottom: 0; padding: 0;} li {margin: 0; padding: 0;}</style>"
331 + "<body height='320'>";
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(labelHtml), 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(labelHtml + tasks);
365 repaint();
366 }
367 }
368}
Note: See TracBrowser for help on using the repository browser.