FileDocCategorySizeDatePackage
SplashScreen.javaAPI DocJava SE 6 API13213Tue Jun 10 00:25:18 BST 2008java.awt

SplashScreen

public final class SplashScreen extends Object
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 {@code 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 {@link #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

Fields Summary
private BufferedImage
image
private long
splashPtr
private boolean
wasClosed
private URL
imageURL
private static SplashScreen
theInstance
The instance reference for the singleton. (null if no instance exists yet.)
Constructors Summary
SplashScreen(long ptr)

 // non-public constructor
        splashPtr = ptr;
        wasClosed = false;
    
Methods Summary
private static native void_close(long splashPtr)

private static native java.awt.Rectangle_getBounds(long splashPtr)

private static native java.lang.String_getImageFileName(long splashPtr)

private static native java.lang.String_getImageJarName(long SplashPtr)

private static native long_getInstance()

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 voidcheckVisible()

        if (!isVisible()) {
            throw new IllegalStateException("no splash screen available");
        }
    
public synchronized voidclose()
Hides the splash screen, closes the window, and releases all associated resources.

throws
IllegalStateException if the splash screen has already been closed

        checkVisible();
        _close(splashPtr);
        image = null;
        wasClosed = true;
        // There should be resetting the theInstance to null to prevent memory 
        // leak. But it brings some more problems with the bug 6382748, so we 
        // let the limited leak to stay.
    
public java.awt.Graphics2DcreateGraphics()
Creates a graphics context (as a {@link 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 {@code update()} on the SplashScreen when you want the splash screen to be updated immediately.

return
graphics context for the splash screen overlay surface
throws
IllegalStateException if the splash screen has already been closed

        if (image==null) {
            Dimension dim = getSize();
            image = new BufferedImage(dim.width, dim.height, BufferedImage.TYPE_INT_ARGB);
        }
        return image.createGraphics();
    
public java.awt.RectanglegetBounds()
Returns the bounds of the splash screen window as a {@link 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.

return
a {@code Rectangle} containing the splash screen bounds
throws
IllegalStateException if the splash screen has already been closed

        checkVisible();
        return _getBounds(splashPtr);
    
public synchronized java.net.URLgetImageURL()
Returns the current splash screen image.

return
URL for the current splash screen image file
throws
IllegalStateException if the splash screen has already been closed

        checkVisible();
        if (imageURL == null) {
            try {
                String fileName = _getImageFileName(splashPtr);
                String jarName = _getImageJarName(splashPtr);
                if (fileName != null) {
                    if (jarName != null) {
                        imageURL = new URL("jar:"+(new File(jarName).toURL().toString())+"!/"+fileName);
                    } else {
                        imageURL = new File(fileName).toURL();
                    }
                }
            }
            catch(java.net.MalformedURLException e) {
                // we'll just return null in this case
            }
        }
        return imageURL;
    
public java.awt.DimensiongetSize()
Returns the size of the splash screen window as a {@link 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.

return
a {@link Dimension} object indicating the splash screen size
throws
IllegalStateException if the splash screen has already been closed

        return getBounds().getSize();
    
public static synchronized java.awt.SplashScreengetSplashScreen()
Returns the {@code SplashScreen} object used for Java startup splash screen control.

throws
UnsupportedOperationException if the splash screen feature is not supported by the current toolkit
throws
HeadlessException if {@code GraphicsEnvironment.isHeadless()} returns true
return
the {@link SplashScreen} instance, or null if there is none or it has already been closed

        if (GraphicsEnvironment.isHeadless()) {
            throw new HeadlessException();
        }
        // SplashScreen class is now a singleton
        if (SplashScreen.theInstance == null) {
            java.security.AccessController.doPrivileged( 
                    new sun.security.action.LoadLibraryAction("splashscreen"));
            long ptr = _getInstance();
            if (ptr == 0) {
                return null;
            }
            if (!_isVisible(ptr)) {
                return null;
            }
            SplashScreen.theInstance = new SplashScreen(ptr);
        }
        return (theInstance.isVisible() ? theInstance : null);
    
public booleanisVisible()
Determines whether the splash screen is visible. The splash screen may be hidden using {@link #close()}, it is also hidden automatically when the first AWT/Swing window is made visible.

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

        return !wasClosed && _isVisible(splashPtr);
    
public voidsetImageURL(java.net.URL imageURL)
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.

param
imageURL the non-null URL for the new splash screen image
throws
NullPointerException if {@code imageURL} is null
throws
IOException if there was an error while loading the image
throws
IllegalStateException if the splash screen has already been closed

        checkVisible();
        URLConnection connection = imageURL.openConnection();
        connection.connect();
        int length = connection.getContentLength();
        java.io.InputStream stream = connection.getInputStream();
        byte[] buf = new byte[length];
        int off = 0;
        while(true) {
            // check for available data
            int available = stream.available();
            if (available <= 0) {
                // no data available... well, let's try reading one byte
                // we'll see what happens then
                available = 1;
            }
            // check for enough room in buffer, realloc if needed
            // the buffer always grows in size 2x minimum
            if (off + available > length) {
                length = off*2;
                if (off + available > length) {
                    length = available+off;
                }
                byte[] oldBuf = buf;
                buf = new byte[length];
                System.arraycopy(oldBuf, 0, buf, 0, off);
            }
            // now read the data
            int result = stream.read(buf, off, available);
            if (result < 0) {
                break;
            }
            off += result;
        }
        synchronized(this) {
            if (!_setImageData(splashPtr, buf)) {
                throw new IOException("Bad image format or i/o error when loading image");
            }
            this.imageURL = imageURL;
        }
    
public voidupdate()
Updates the splash window with current contents of the overlay image.

throws
IllegalStateException if the overlay image does not exist; for example, if {@code createGraphics} has never been called, or if the splash screen has already been closed

        checkVisible();
        if (image == null) {
            throw new IllegalStateException("no overlay image available");
        }
        DataBuffer buf = image.getRaster().getDataBuffer();
        if (!(buf instanceof DataBufferInt)) {
            throw new AssertionError("Overlay image DataBuffer is of invalid type == "+buf.getClass().getName());
        }
        int numBanks = buf.getNumBanks();
        if (numBanks!=1) {
            throw new AssertionError("Invalid number of banks =="+numBanks+" in overlay image DataBuffer");
        }
        if (!(image.getSampleModel() instanceof SinglePixelPackedSampleModel)) {
            throw new AssertionError("Overlay image has invalid sample model == "+image.getSampleModel().getClass().getName());
        }
        SinglePixelPackedSampleModel sm = (SinglePixelPackedSampleModel)image.getSampleModel();
        int scanlineStride = sm.getScanlineStride();
        Rectangle rect = image.getRaster().getBounds();
        int[] data = ((DataBufferInt)buf).getData();
        _update(splashPtr, data, rect.x, rect.y, rect.width, rect.height, scanlineStride);