APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt

public final Class SplashScreen

extends Object
Class Inheritance
Imports
java.io.IOException, .File, java.awt.image.*, java.net.URL, .URLConnection, sun.util.logging.PlatformLogger, sun.awt.image.SunWritableRaster
The splash screen can be displayed 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, or PNG files for the image. Animation is supported for the GIF format, while transparency is supported both for GIF and PNG. 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 splash screen 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).

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

If the Java implementation provides the command-line interface and you run your application by using the command line or a shortcut, use the Java application launcher option to show a splash screen. The Oracle reference implementation allows you to specify the splash screen image location with the -splash: option.
For example: 

java -splash:filename.gif Test
HiDPI scaled image is also supported. Unscaled image name i.e. filename.gif should be passed in manifest.mf/-splash: option for all image types irrespective of HiDPI and Non-HiDPI. Following is the naming convention for scaled images. Screen scale 1.25: [email protected] Screen scale 1.50: [email protected] Screen scale 2: [email protected] and [email protected] both are supported Screen scale 2.50: [email protected] Screen scale 3: [email protected] and [email protected] both are supported The command line interface has higher precedence over the manifest setting.

The splash screen will be displayed as faithfully as possible to present the whole splash screen image given the limitations of the target platform and display.

It is implied that the specified image is presented on the screen "as is", i.e. preserving the exact color values as specified in the image file. Under certain circumstances, though, the presented image may differ, e.g. when applying color dithering to present a 32 bits per pixel (bpp) image on a 16 or 8 bpp screen. The native platform display configuration may also affect the colors of the displayed image (e.g. color profiles, etc.)

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 splash screen native window position/size, and paint in the splash screen. It cannot be used to create the splash screen. You should use the options provided by the Java implementation for that.

This class cannot be instantiated. Only a single instance of this class can exist, and it may be obtained by using the 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.

Author
Oleg Semenov
Since
1.6

Field Summary

Modifier and TypeField and Description
private BufferedImage
image

private URL
imageURL

private static final PlatformLogger
log

private final long
splashPtr

private static SplashScreen
theInstance

The instance reference for the singleton.

private static boolean
wasClosed

Constructor Summary

AccessConstructor and Description
pack-priv
SplashScreen(long ptr)

Method Summary

Modifier and TypeMethod and Description
private static native void
_close(long splashPtr)

private static native Rectangle
_getBounds(long splashPtr)

private static native String
_getImageFileName(long splashPtr)

private static native String
_getImageJarName(long SplashPtr)

private static native long
_getInstance()

private static native float
_getScaleFactor(long SplashPtr)

private static native boolean
_isVisible(long splashPtr)

private static native boolean
_setImageData(long SplashPtr, byte[] data)

private static native void
_update(long splashPtr, int[] data, int x, int y, int width, int height, int scanlineStride)

private void
checkVisible()

public void
close()

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

public Graphics2D

Returns:

graphics context for the splash screen overlay surface
createGraphics()

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

public Rectangle

Returns:

a Rectangle containing the splash screen bounds
getBounds()

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

public URL

Returns:

URL for the current splash screen image file
getImageURL()

Returns the current splash screen image.

public Dimension

Returns:

a Dimension object indicating the splash screen size
getSize()

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

public static SplashScreen

Returns:

the SplashScreen instance, or null if there is none or it has already been closed
getSplashScreen()

Returns the SplashScreen object used for Java startup splash screen control on systems that support display.

public boolean

Returns:

true if the splash screen is visible (has not been closed yet), false otherwise
isVisible()

Determines whether the splash screen is visible.

pack-priv static void
markClosed()

public void
setImageURL(URL
the non-null URL for the new splash screen image
imageURL)

Changes the splash screen image.

public void
update()

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

imageback to summary
private BufferedImage image
imageURLback to summary
private URL imageURL
logback to summary
private static final PlatformLogger log
splashPtrback to summary
private final long splashPtr
theInstanceback to summary
private static SplashScreen theInstance

The instance reference for the singleton. (null if no instance exists yet.)

See Also
getSplashScreen, close
wasClosedback to summary
private static boolean wasClosed

Constructor Detail

SplashScreenback to summary
pack-priv SplashScreen(long ptr)

Method Detail

_closeback to summary
private static native void _close(long splashPtr)
_getBoundsback to summary
private static native Rectangle _getBounds(long splashPtr)
_getImageFileNameback to summary
private static native String _getImageFileName(long splashPtr)
_getImageJarNameback to summary
private static native String _getImageJarName(long SplashPtr)
_getInstanceback to summary
private static native long _getInstance()
_getScaleFactorback to summary
private static native float _getScaleFactor(long SplashPtr)
_isVisibleback to summary
private static native boolean _isVisible(long splashPtr)
_setImageDataback to summary
private static native boolean _setImageData(long SplashPtr, byte[] data)
_updateback to summary
private static native void _update(long splashPtr, int[] data, int x, int y, int width, int height, int scanlineStride)
checkVisibleback to summary
private void checkVisible()
closeback to summary
public void close() throws IllegalStateException

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

Exceptions
IllegalStateException:
if the splash screen has already been closed
createGraphicsback to summary
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. 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.

The pixel (0, 0) in the coordinate space of the graphics context corresponds to the origin of the splash screen native window bounds (see getBounds()).

Returns:Graphics2D

graphics context for the splash screen overlay surface

Exceptions
IllegalStateException:
if the splash screen has already been closed
getBoundsback to summary
public Rectangle getBounds() throws IllegalStateException

Returns the bounds of the splash screen window as a Rectangle. This may be useful if, for example, you want to replace the splash screen with your window at the same location.

You cannot control the size or position of the splash screen. The splash screen size is adjusted automatically when the image changes.

The image may contain transparent areas, and thus the reported bounds may be larger than the visible splash screen image on the screen.

Returns:Rectangle

a Rectangle containing the splash screen bounds

Exceptions
IllegalStateException:
if the splash screen has already been closed
getImageURLback to summary
public URL getImageURL() throws IllegalStateException

Returns the current splash screen image.

Returns:URL

URL for the current splash screen image file

Annotations
@SuppressWarnings:deprecation
Exceptions
IllegalStateException:
if the splash screen has already been closed
getSizeback to summary
public Dimension getSize() throws IllegalStateException

Returns the size of the splash screen window as a Dimension. This may be useful if, for example, you want to draw on the splash screen overlay surface.

You cannot control the size or position of the splash screen. The splash screen size is adjusted automatically when the image changes.

The image may contain transparent areas, and thus the reported size may be larger than the visible splash screen image on the screen.

Returns:Dimension

a Dimension object indicating the splash screen size

Exceptions
IllegalStateException:
if the splash screen has already been closed
getSplashScreenback to summary
public static SplashScreen getSplashScreen()

Returns the SplashScreen object used for Java startup splash screen control on systems that support display.

Returns:SplashScreen

the SplashScreen instance, or null if there is none or it has already been closed

Annotations
@SuppressWarnings:restricted
Exceptions
UnsupportedOperationException:
if the splash screen feature is not supported by the current toolkit
HeadlessException:
if GraphicsEnvironment.isHeadless() returns true
isVisibleback to summary
public boolean isVisible()

Determines whether the splash screen is visible. The splash screen may be hidden using close(), it is also hidden automatically when the first AWT/Swing window is made visible.

Note that the native platform may delay presenting the splash screen native window on the screen. The return value of true for this method only guarantees that the conditions to hide the splash screen window have not occurred yet.

Returns:boolean

true if the splash screen is visible (has not been closed yet), false otherwise

markClosedback to summary
pack-priv static void markClosed()
setImageURLback to summary
public void setImageURL(URL imageURL) throws NullPointerException, IOException, IllegalStateException

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:URL

the non-null URL for the new splash screen image

Exceptions
NullPointerException:
if imageURL is null
IOException:
if there was an error while loading the image
IllegalStateException:
if the splash screen has already been closed
updateback to summary
public void update() throws IllegalStateException

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

Exceptions
IllegalStateException:
if the overlay image does not exist; for example, if createGraphics has never been called, or if the splash screen has already been closed