/
Application.java
481 lines (451 loc) · 17.6 KB
/
Application.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
/*
* Copyright (c) 2010, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.application;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.List;
import java.util.Map;
import javafx.application.Preloader.PreloaderNotification;
import javafx.scene.Scene;
import javafx.stage.Stage;
import com.sun.javafx.application.LauncherImpl;
import com.sun.javafx.application.ParametersImpl;
import com.sun.javafx.application.PlatformImpl;
import com.sun.javafx.css.StyleManager;
/**
* Application class from which JavaFX applications extend.
*
* <p><b>Life-cycle</b></p>
* <p>
* The entry point for JavaFX applications is the Application class. The
* JavaFX runtime does the following, in order, whenever an application is
* launched:
* </p>
* <ol>
* <li>Constructs an instance of the specified Application class</li>
* <li>Calls the {@link #init} method</li>
* <li>Calls the {@link #start} method</li>
* <li>Waits for the application to finish, which happens when either of
* the following occur:
* <ul>
* <li>the application calls {@link Platform#exit}</li>
* <li>the last window has been closed and the {@code implicitExit}
* attribute on {@code Platform} is true</li>
* </ul></li>
* <li>Calls the {@link #stop} method</li>
* </ol>
* <p>Note that the {@code start} method is abstract and must be overridden.
* The {@code init} and {@code stop} methods have concrete implementations
* that do nothing.</p>
*
* <p>Calling {@link Platform#exit} is the preferred way to explicitly terminate
* a JavaFX Application. Directly calling {@link System#exit} is
* an acceptable alternative, but doesn't allow the Application {@link #stop}
* method to run.
* </p>
*
* <p>A JavaFX Application should not attempt to use JavaFX after the
* FX toolkit has terminated or from a ShutdownHook, that is, after the
* {@link #stop} method returns or {@link System#exit} is called.
* </p>
*
* <p><b>Parameters</b></p>
* <p>
* Application parameters are available by calling the {@link #getParameters}
* method from the {@link #init} method, or any time after the {@code init}
* method has been called.
* </p>
*
* <p><b>Threading</b></p>
* <p>
* JavaFX creates an application thread for running the application start
* method, processing input events, and running animation timelines. Creation
* of JavaFX {@link Scene} and {@link Stage} objects as well as modification of
* scene graph operations to <em>live</em> objects (those objects already
* attached to a scene) must be done on the JavaFX application thread.
* </p>
*
* <p>
* The Java launcher loads and initializes the specified Application class
* on the JavaFX Application Thread. If there is no main method in the
* Application class, or if the main method calls Application.launch(), then
* an instance of the Application is then constructed on the JavaFX Application
* Thread.
* </p>
*
* <p>
* The {@code init} method is called on the launcher thread, not on the
* JavaFX Application Thread.
* This means that an application must not construct a {@link Scene}
* or a {@link Stage} in the {@code init} method.
* An application may construct other JavaFX objects in the {@code init}
* method.
* </p>
*
* <p>
* All the unhandled exceptions on the JavaFX application thread that occur during
* event dispatching, running animation timelines, or any other code, are forwarded
* to the thread's {@link java.lang.Thread.UncaughtExceptionHandler uncaught
* exception handler}.
* </p>
*
* <p><b>Example</b></p>
* <p>The following example will illustrate a simple JavaFX application.</p>
* <pre><code>
import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.scene.shape.Circle;
import javafx.stage.Stage;
public class MyApp extends Application {
public void start(Stage stage) {
Circle circ = new Circle(40, 40, 30);
Group root = new Group(circ);
Scene scene = new Scene(root, 400, 300);
stage.setTitle("My JavaFX Application");
stage.setScene(scene);
stage.show();
}
}
* </code></pre>
*
* <p>The above example will produce the following:</p>
* <p><img src="doc-files/Application.png"/></p>
* @since JavaFX 2.0
*/
public abstract class Application {
/**
* Constant for user agent stylesheet for the "Caspian" theme. Caspian
* is the theme that shipped as default in JavaFX 2.x.
* @since JavaFX 8.0
*/
public static final String STYLESHEET_CASPIAN = "CASPIAN";
/**
* Constant for user agent stylesheet for the "Modena" theme. Modena
* is the default theme for JavaFX 8.x.
* @since JavaFX 8.0
*/
public static final String STYLESHEET_MODENA = "MODENA";
/**
* Launch a standalone application. This method is typically called
* from the main method(). It must not be called more than once or an
* exception will be thrown.
*
* <p>
* The launch method does not return until the application has exited,
* either via a call to Platform.exit or all of the application windows
* have been closed.
*
* <p>
* Typical usage is:
* <ul>
* <pre>
* public static void main(String[] args) {
* Application.launch(MyApp.class, args);
* }
* </pre>
* </ul>
* where <code>MyApp</code> is a subclass of Application.
*
* @param appClass the application class that is constructed and executed
* by the launcher.
* @param args the command line arguments passed to the application.
* An application may get these parameters using the
* {@link #getParameters()} method.
*
* @throws IllegalStateException if this method is called more than once.
* @throws IllegalArgumentException if <code>appClass</code> is not a
* subclass of <code>Application</code>.
*/
public static void launch(Class<? extends Application> appClass, String... args) {
LauncherImpl.launchApplication(appClass, args);
}
/**
* Launch a standalone application. This method is typically called
* from the main method(). It must not be called more than once or an
* exception will be thrown.
* This is equivalent to launch(TheClass.class, args) where TheClass is the
* immediately enclosing class of the method that called launch. It must
* be a subclass of Application or a RuntimeException will be thrown.
*
* <p>
* The launch method does not return until the application has exited,
* either via a call to Platform.exit or all of the application windows
* have been closed.
*
* <p>
* Typical usage is:
* <ul>
* <pre>
* public static void main(String[] args) {
* Application.launch(args);
* }
* </pre>
* </ul>
*
* @param args the command line arguments passed to the application.
* An application may get these parameters using the
* {@link #getParameters()} method.
*
* @throws IllegalStateException if this method is called more than once.
*/
public static void launch(String... args) {
// Figure out the right class to call
StackTraceElement[] cause = Thread.currentThread().getStackTrace();
boolean foundThisMethod = false;
String callingClassName = null;
for (StackTraceElement se : cause) {
// Skip entries until we get to the entry for this class
String className = se.getClassName();
String methodName = se.getMethodName();
if (foundThisMethod) {
callingClassName = className;
break;
} else if (Application.class.getName().equals(className)
&& "launch".equals(methodName)) {
foundThisMethod = true;
}
}
if (callingClassName == null) {
throw new RuntimeException("Error: unable to determine Application class");
}
try {
Class theClass = Class.forName(callingClassName, false,
Thread.currentThread().getContextClassLoader());
if (Application.class.isAssignableFrom(theClass)) {
Class<? extends Application> appClass = theClass;
LauncherImpl.launchApplication(appClass, args);
} else {
throw new RuntimeException("Error: " + theClass
+ " is not a subclass of javafx.application.Application");
}
} catch (RuntimeException ex) {
throw ex;
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
/**
* Constructs a new {@code Application} instance.
*/
public Application() {
}
/**
* The application initialization method. This method is called immediately
* after the Application class is loaded and constructed. An application may
* override this method to perform initialization prior to the actual starting
* of the application.
*
* <p>
* The implementation of this method provided by the Application class does nothing.
* </p>
*
* <p>
* NOTE: This method is not called on the JavaFX Application Thread. An
* application must not construct a Scene or a Stage in this
* method.
* An application may construct other JavaFX objects in this method.
* </p>
*/
public void init() throws Exception {
}
/**
* The main entry point for all JavaFX applications.
* The start method is called after the init method has returned,
* and after the system is ready for the application to begin running.
*
* <p>
* NOTE: This method is called on the JavaFX Application Thread.
* </p>
*
* @param primaryStage the primary stage for this application, onto which
* the application scene can be set. The primary stage will be embedded in
* the browser if the application was launched as an applet.
* Applications may create other stages, if needed, but they will not be
* primary stages and will not be embedded in the browser.
*/
public abstract void start(Stage primaryStage) throws Exception;
/**
* This method is called when the application should stop, and provides a
* convenient place to prepare for application exit and destroy resources.
*
* <p>
* The implementation of this method provided by the Application class does nothing.
* </p>
*
* <p>
* NOTE: This method is called on the JavaFX Application Thread.
* </p>
*/
public void stop() throws Exception {
}
private HostServices hostServices = null;
/**
* Gets the HostServices provider for this application. This provides
* the ability to get the code base and document base for this application,
* and to access the enclosing web page.
*
* @return the HostServices provider
*/
public final HostServices getHostServices() {
synchronized (this) {
if (hostServices == null) {
hostServices = new HostServices(this);
}
return hostServices;
}
}
/**
* Retrieves the parameters for this Application, including any arguments
* passed on the command line and any parameters specified in a JNLP file
* for an applet or WebStart application.
*
* <p>
* NOTE: this method should not be called from the Application constructor,
* as it will return null. It may be called in the init() method or any
* time after that.
* </p>
*
* @return the parameters for this Application, or null if called from the
* constructor.
*/
public final Parameters getParameters() {
return ParametersImpl.getParameters(this);
}
/**
* Notifies the preloader with an application-generated notification.
* Application code calls this method with a PreloaderNotification that is
* delivered to the
* {@link Preloader#handleApplicationNotification
* Preloader.handleApplicationNotification} method.
* This is primarily useful for cases where an application wants the
* preloader to show progress during a long application initialization
* step.
*
* <p>
* NOTE: the notification will be delivered only to the preloader's
* handleApplicationNotification() method; this means, for example, that
* if this method is called with a ProgressNotification, that notification
* will not be delivered to the {@link Preloader#handleProgressNotification
* Preloader.handleProgressNotification}
* method.
* </p>
*
* @param info the application-generated preloader notification
*/
public final void notifyPreloader(PreloaderNotification info) {
LauncherImpl.notifyPreloader(this, info);
}
/**
* Encapsulates the set of parameters for an application. This includes
* arguments passed on the command line, unnamed parameters specified
* in a JNLP file, and <name,value> pairs specified in a JNLP file.
*
* <p>
* Note that the application and the preloader both get the same set
* of parameters for a given run of an application.
* </p>
* @since JavaFX 2.0
*/
public static abstract class Parameters {
/**
* Constructs a new {@code Parameters} instance.
*/
public Parameters() {
}
/**
* Retrieves a read-only list of the raw arguments. This list
* may be empty, but is never null. In the case of a standalone
* application, it is the ordered list of arguments specified on the
* command line. In the case of an applet or WebStart application,
* it includes unnamed parameters as well as named parameters. For
* named parameters, each <name,value> pair is represented as
* a single argument of the form: "--name=value".
*
* @return a read-only list of raw application arguments
*/
public abstract List<String> getRaw();
/**
* Retrieves a read-only list of the unnamed parameters. This list
* may be empty, but is never null. The named parameters, that is
* the parameters that are represented as <name,value> pairs, are
* filtered out.
*
* @return a read-only list of unnamed parameters.
*/
public abstract List<String> getUnnamed();
/**
* Retrieves a read-only map of the named parameters. It may be
* empty, but is never null.
* Named parameters include those <name,value> pairs explicitly
* specified in a JNLP file. It also includes any command line
* arguments of the form: "--name=value".
*
* @return a read-only map of named parameters.
*/
public abstract Map<String, String> getNamed();
}
private static String userAgentStylesheet = null;
/**
* Get the user agent stylesheet used by the whole application. This is
* used to provide default styling for all ui controls and other nodes.
* A value of null means the platform default stylesheet is being used.
* <p>
* NOTE: This method must be called on the JavaFX Application Thread.
* </p>
*
* @return The URL to the stylesheet as a String.
* @since JavaFX 8.0
*/
public static String getUserAgentStylesheet() {
return userAgentStylesheet;
}
/**
* Set the user agent stylesheet used by the whole application. This is used
* to provide default styling for all ui controls and other nodes. Each
* release of JavaFX may have a new default value for this so if you need
* to guarantee consistency you will need to call this method and choose
* what default you would like for your application. A value of null will
* restore the platform default stylesheet. This property can also be set
* on the command line with {@code -Djavafx.userAgentStylesheetUrl=[URL]}
* Setting it on the command line overrides anything set using this method
* in code.
* <p>
* NOTE: This method must be called on the JavaFX Application Thread.
* </p>
*
*
* @param url The URL to the stylesheet as a String.
* @since JavaFX 8.0
*/
public static void setUserAgentStylesheet(String url) {
userAgentStylesheet = url;
if (url == null) {
PlatformImpl.setDefaultPlatformUserAgentStylesheet();
} else {
PlatformImpl.setPlatformUserAgentStylesheet(url);
}
}
}