SplashScreen JDK 1.6)

Description

publicfinal class SplashScreen

The splash screen can be created at application startup, before the Java Virtual Machine (JVM) starts.

The splash screen can be created at application startup, before the Java Virtual Machine (JVM) starts. The splash screen is displayed as an undecorated window containing an image. You can use GIF, JPEG, and PNG files for the image. Animation (for GIF) and transparency (for GIF, PNG) are supported. The window is positioned at the center of the screen (the position on multi-monitor systems is not specified - it is platform and implementation dependent). The window is closed automatically as soon as the first window is displayed by Swing/AWT (may be also closed manually using the Java API, see below).

There are two ways to show the native splash screen:

If your application is run from the command line or from a shortcut, use the "-splash:" Java application launcher option to show a splash screen.
For example:
```
 java -splash:filename.gif Test
 
```
If your application is packaged in a jar file, you can use the "SplashScreen-Image" option in a manifest file to show a splash screen. Place the image in the jar archive and specify the path in the option. The path should not have a leading slash.
For example, in the manifest.mf file:
```
 Manifest-Version: 1.0
 Main-Class: Test
 SplashScreen-Image: filename.gif
 
```
The command line interface has higher precedence over the manifest setting.

The SplashScreen class provides the API for controlling the splash screen. This class may be used to close the splash screen, change the splash screen image, get the image position/size and paint in the splash screen. It cannot be used to create the splash screen; you should use the command line or manifest file option for that.

This class cannot be instantiated. Only a single instance of this class can exist, and it may be obtained using the SplashScreen.getSplashScreen() static method. In case the splash screen has not been created at application startup via the command line or manifest file option, the getSplashScreen method returns null.

See also:

Methods

Hide/Show inherited methods

publicsynchronized void close () throws IllegalStateException

Hides the splash screen, closes the window, and releases all associated resources.

public Graphics2D createGraphics () throws IllegalStateException

Creates a graphics context (as a Graphics2D object) for the splash screen overlay image, which allows you to draw over the splash screen.

Creates a graphics context (as a Graphics2D object) for the splash
screen overlay image, which allows you to draw over the splash screen.
Note that you do not draw on the main image but on the image that is
displayed over the main image using alpha blending. Also note that drawing
on the overlay image does not necessarily update the contents of splash
screen window. You should call update() on the
SplashScreen when you want the splash screen to be
updated immediately.
Returns: graphics context for the splash screen overlay surface
Throws:
- IllegalStateException - if the splash screen has already been closed

public Rectangle getBounds () throws IllegalStateException

Returns the bounds of the splash screen window as a Rectangle.

publicsynchronized URL getImageURL () throws IllegalStateException

Returns the current splash screen image.

public Dimension getSize () throws IllegalStateException

Returns the size of the splash screen window as a Dimension.

publicstaticsynchronized SplashScreen getSplashScreen ()

Returns the SplashScreen object used for Java startup splash screen control.

Returns the SplashScreen object used for
Java startup splash screen control.
Returns: the {@link SplashScreen} instance, or null if there is none or it has already been closed
Throws:
- UnsupportedOperationException - if the splash screen feature is not supported by the current toolkit
- HeadlessException - if {@code GraphicsEnvironment.isHeadless()} returns true

public boolean isVisible ()

Determines whether the splash screen is visible.

public void setImageURL (URL imageURL) throws NullPointerException IOException IllegalStateException

Changes the splash screen image.

Changes the splash screen image. The new image is loaded from the
specified URL; GIF, JPEG and PNG image formats are supported.
The method returns after the image has finished loading and the window
has been updated.
The splash screen window is resized according to the size of
the image and is centered on the screen.
Parameters:
- imageURL - the non-null URL for the new splash screen image
Throws:
- NullPointerException - if {@code imageURL} is null
- IOException - if there was an error while loading the image
- IllegalStateException - if the splash screen has already been closed

public void update () throws IllegalStateException

Updates the splash window with current contents of the overlay image.