Class SplashScreen

Method Detail

• getSplashScreen

  public static SplashScreen getSplashScreen()

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

  Returns:

  the 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 GraphicsEnvironment.isHeadless() returns true

• setImageURL

  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 - the non-null URL for the new splash screen image

  Throws:

  NullPointerException - if imageURL is null

  IOException - if there was an error while loading the image

  IllegalStateException - if the splash screen has already been closed

• getImageURL

  public URL getImageURL()
                  throws IllegalStateException

  Returns the current splash screen image.

  Returns:

  URL for the current splash screen image file

  Throws:

  IllegalStateException - if the splash screen has already been closed

• getBounds

  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:

  a Rectangle containing the splash screen bounds

  Throws:

  IllegalStateException - if the splash screen has already been closed

• getSize

  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:

  a Dimension object indicating the splash screen size

  Throws:

  IllegalStateException - if the splash screen has already been closed

• createGraphics

  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:

  graphics context for the splash screen overlay surface

  Throws:

  IllegalStateException - if the splash screen has already been closed

• update

  public void update()
              throws IllegalStateException

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

  Throws:

  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

• close

  public void close()
             throws IllegalStateException

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

  Throws:

  IllegalStateException - if the splash screen has already been closed

• isVisible

  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:

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