Package com.luciad.lucy.gui

Class TLcySplashScreenMediator

java.lang.Object
com.luciad.lucy.gui.TLcySplashScreenMediator
public class TLcySplashScreenMediator extends Object
Utility class which contains utility methods to show the progress of the add-on loading on a splash screen. It works together with Java's splash screen support (configured using -splash or in the manifest file). The splash screen uses the following ILcyLucyEnv listeners to update its status, text and progress:
  • ILcyAddOnContainerListener to display the loaded add-on names as text
  • ILcyLucyEnvListener to determine when to dispose the splash screen
  • ILcdStatusListener to display the progress in a progress bar
Since:
2012.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    install(ILcyLucyEnv aLucyEnv, Point aRelativeTextLocation, Font aFont, Color aFontColor)
    Paints the add-on loading progress information on top of the native Java splash screen.
    static void
    install(ILcyLucyEnv aLucyEnv, String aImageFilename, boolean aShowText, Point aRelativeTextLocation, Font aFont, Color aFontColor, boolean aShowProgressBar, int aProgressBarHeight, Color aProgressBarColor)
    Creates a splash screen showing the add-ons that are loaded and a progress bar at the bottom of the splash screen.
    static void
    install(ILcyLucyEnv aLucyEnv, String aImageFilename, Point aRelativeTextLocation, Font aFont, Color aFontColor)
    (Creates and) updates the splash screen to show the add-on loading progress information.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • install

      public static void install(ILcyLucyEnv aLucyEnv, Point aRelativeTextLocation, Font aFont, Color aFontColor)
      Paints the add-on loading progress information on top of the native Java splash screen. This method requires a native Java splash screen to be active. See java.awt.SplashScreen on how to activate the Java splash screen.
      Parameters:
      aLucyEnv - The ILcyLucyEnv
      aRelativeTextLocation - Location of the text, relative to the edge of the splash screen. A positive x or y value means relative from the left or top side. A negative x or y value means relative from the right or bottom side. For example, if a y-value of -10 is specified, the bottom of the text is 10 pixels from the bottom of the splash screen.
      aFont - The font to use for the text.
      aFontColor - The font color.

    • install

      public static void install(ILcyLucyEnv aLucyEnv, String aImageFilename, Point aRelativeTextLocation, Font aFont, Color aFontColor)
      (Creates and) updates the splash screen to show the add-on loading progress information. This method works regardless whether a native Java splash screen is active or not. When a native Java splash screen is present, progress info will be painted on top of that splash screen. When no native Java splash screen is present, a splash screen will be created and shown. See java.awt.SplashScreen on how to activate the Java splash screen.
      Parameters:
      aLucyEnv - The ILcyLucyEnv
      aImageFilename - The location of the image to use as splash screen.
      aRelativeTextLocation - Location of the text, relative to the edge of the splash screen. A positive x or y value means relative from the left or top side. A negative x or y value means relative from the right or bottom side. For example, if a y-value of -10 is specified, the bottom of the text is 10 pixels from the bottom of the splash screen.
      aFont - The font to use for the text.
      aFontColor - The font color.

    • install

      public static void install(ILcyLucyEnv aLucyEnv, String aImageFilename, boolean aShowText, Point aRelativeTextLocation, Font aFont, Color aFontColor, boolean aShowProgressBar, int aProgressBarHeight, Color aProgressBarColor)
      Creates a splash screen showing the add-ons that are loaded and a progress bar at the bottom of the splash screen. This method works regardless whether a native Java splash screen is active or not. When a native Java splash screen is present, progress info will be painted on top of that splash screen. When no native Java splash screen is present, a splash screen will be created and shown. See java.awt.SplashScreen on how to activate the Java splash screen.
      Parameters:
      aLucyEnv - The ILcyLucyEnv
      aImageFilename - The location of the image to use as splash screen.
      aShowText - true when the add-on which is currently loading should be displayed as text on the splash screen.
      aRelativeTextLocation - Location of the text, relative to the edge of the splash screen. A positive x or y value means relative from the left or top side. A negative x or y value means relative from the right or bottom side. For example, if a y-value of -10 is specified, the bottom of the text is 10 pixels from the bottom of the splash screen.
      aFont - The font to use for the text.
      aFontColor - The font color.
      aShowProgressBar - true when a progress bar should be shown
      aProgressBarHeight - The height of the progress bar
      aProgressBarColor - The color to use for the progress bar