Package org.nuiton.jaxx.widgets.extra

Class SplashScreen

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
org.nuiton.jaxx.widgets.extra.SplashScreen
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
public class SplashScreen
extends javax.swing.JFrame
Author:
kmorin - morin@codelutin.com
See Also:
Serialized Form

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    protected class  SplashScreen.FrameHider  
    protected class  SplashScreen.ImageAnimator  
    static class  SplashScreen.Title  

    Nested classes/interfaces inherited from class javax.swing.JFrame

    javax.swing.JFrame.AccessibleJFrame

    Nested classes/interfaces inherited from class java.awt.Frame

    java.awt.Frame.AccessibleAWTFrame

    Nested classes/interfaces inherited from class java.awt.Window

    java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

    Nested classes/interfaces inherited from class java.awt.Container

    java.awt.Container.AccessibleAWTContainer

    Nested classes/interfaces inherited from class java.awt.Component

    java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected boolean alphaUp  
    protected SplashScreen.Title applicationTitle  
    protected float currentAlpha  
    protected java.awt.Composite currentComposite  
    protected java.awt.Image currentImage  
    protected int currentStep  
    static long DEFAULT_REMANENCE  
    static int DEFAULT_STEPPING_BOTTOM_INSET  
    static int DEFAULT_STEPPING_LEFT_INSET  
    static int DEFAULT_STEPPING_RIGHT_INSET  
    static java.awt.Composite defaultComposite  
    protected SplashScreen.ImageAnimator imageAnimator  
    protected javax.swing.JPanel jContentPane  
    protected long remanence  
    protected java.awt.Image splashImage  
    protected javax.swing.JPanel splashPane  
    protected java.awt.Image[] stepImages  
    protected int steppingBottomInset  
    protected int steppingLeftInset  
    protected int steppingRightInset  

    Fields inherited from class javax.swing.JFrame

    accessibleContext, rootPane, rootPaneCheckingEnabled

    Fields inherited from class java.awt.Frame

    CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

    Fields inherited from class java.awt.Component

    BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

    Fields inherited from interface java.awt.image.ImageObserver

    ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

    Fields inherited from interface javax.swing.WindowConstants

    DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

  • Constructor Summary

    Constructors
    Constructor Description
    SplashScreen​(java.lang.String splashImagePath)  
    SplashScreen​(java.lang.String splashImagePath, SplashScreen.Title applicationTitle)  
    SplashScreen​(java.lang.String splashImagePath, SplashScreen.Title applicationTitle, java.lang.String[] stepImagesPaths)  

  • Method Summary

    Modifier and Type Method Description
    protected void animateImage()  
    void complete()  
    SplashScreen.Title getApplicationTitle()  
    java.awt.Composite getCompositeFor​(int step)  
    java.awt.Composite getCurrentComposite()  
    int getCurrentStep()  
    protected java.awt.Image getImage​(java.lang.String imagePath)  
    protected javax.swing.JPanel getJContentPane()  
    long getRemanence()  
    java.awt.Image getSplashImage()  
    protected javax.swing.JPanel getSplashPane()  
    protected java.awt.Image getStepImage​(int i)  
    java.awt.Image[] getStepImages()  
    int getSteppingBottomInset()  
    int getSteppingLeftInset()  
    int getSteppingRightInset()  
    protected void initialize​(java.lang.String splashImagePath, java.lang.String[] stepIconsPaths)  
    protected void initializeUI()  
    static void main​(java.lang.String[] args)  
    void nextStep()  
    protected void paintSplash​(java.awt.Graphics g)  
    protected void positionAtCenter​(int width, int height)
    Positions the window at the centre of the screen, taking into account the specified width and height
    void setCurrentComposite​(java.awt.Composite currentComposite)  
    void setCurrentStep​(int currentStep)  
    void setRemanence​(long remanence)  
    void setSteppingBottomInset​(int steppingBottomInset)  
    void setSteppingLeftInset​(int steppingLeftInset)  
    void setSteppingRightInset​(int steppingRightInset)  

    Methods inherited from class javax.swing.JFrame

    addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

    Methods inherited from class java.awt.Frame

    addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

    Methods inherited from class java.awt.Window

    addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

    Methods inherited from class java.awt.Container

    add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

    Methods inherited from class java.awt.Component

    action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.awt.MenuContainer

    getFont, postEvent

  • Field Details

    • DEFAULT_REMANENCE

      public static final long DEFAULT_REMANENCE
      See Also:
      Constant Field Values

    • DEFAULT_STEPPING_LEFT_INSET

      public static final int DEFAULT_STEPPING_LEFT_INSET
      See Also:
      Constant Field Values

    • DEFAULT_STEPPING_RIGHT_INSET

      public static final int DEFAULT_STEPPING_RIGHT_INSET
      See Also:
      Constant Field Values

    • DEFAULT_STEPPING_BOTTOM_INSET

      public static final int DEFAULT_STEPPING_BOTTOM_INSET
      See Also:
      Constant Field Values

    • defaultComposite

      public static final java.awt.Composite defaultComposite

    • remanence

      protected long remanence

    • splashImage

      protected java.awt.Image splashImage

    • applicationTitle

      protected SplashScreen.Title applicationTitle

    • stepImages

      protected java.awt.Image[] stepImages

    • currentStep

      protected int currentStep

    • steppingLeftInset

      protected int steppingLeftInset

    • steppingRightInset

      protected int steppingRightInset

    • steppingBottomInset

      protected int steppingBottomInset

    • currentImage

      protected java.awt.Image currentImage

    • currentComposite

      protected java.awt.Composite currentComposite

    • imageAnimator

      protected SplashScreen.ImageAnimator imageAnimator

    • currentAlpha

      protected float currentAlpha

    • alphaUp

      protected boolean alphaUp

    • jContentPane

      protected javax.swing.JPanel jContentPane

    • splashPane

      protected javax.swing.JPanel splashPane

  • Constructor Details

    • SplashScreen

      public SplashScreen​(java.lang.String splashImagePath)

    • SplashScreen

      public SplashScreen​(java.lang.String splashImagePath, SplashScreen.Title applicationTitle)

    • SplashScreen

      public SplashScreen​(java.lang.String splashImagePath, SplashScreen.Title applicationTitle, java.lang.String[] stepImagesPaths)

  • Method Details

    • getSteppingLeftInset

      public int getSteppingLeftInset()
      Returns:
      Returns the steppingInset.

    • setSteppingLeftInset

      public void setSteppingLeftInset​(int steppingLeftInset)
      Parameters:
      steppingLeftInset - The steppingInset to set.

    • getSteppingRightInset

      public int getSteppingRightInset()
      Returns:
      Returns the steppingRightInset.

    • setSteppingRightInset

      public void setSteppingRightInset​(int steppingRightInset)
      Parameters:
      steppingRightInset - The steppingRightInset to set.

    • getApplicationTitle

      public SplashScreen.Title getApplicationTitle()
      Returns:
      Returns the applicationTitle.

    • getCurrentStep

      public int getCurrentStep()
      Returns:
      Returns the currentStep.

    • setCurrentStep

      public void setCurrentStep​(int currentStep)
      Parameters:
      currentStep - The currentStep to set.

    • getSplashImage

      public java.awt.Image getSplashImage()
      Returns:
      Returns the splashImage.

    • getStepImages

      public java.awt.Image[] getStepImages()
      Returns:
      Returns the stepImages.

    • getSteppingBottomInset

      public int getSteppingBottomInset()
      Returns:
      Returns the steppingBottomInset.

    • setSteppingBottomInset

      public void setSteppingBottomInset​(int steppingBottomInset)
      Parameters:
      steppingBottomInset - The steppingBottomInset to set.

    • getCurrentComposite

      public java.awt.Composite getCurrentComposite()
      Returns:
      Returns the currentComposite.

    • setCurrentComposite

      public void setCurrentComposite​(java.awt.Composite currentComposite)
      Parameters:
      currentComposite - The currentComposite to set.

    • getRemanence

      public long getRemanence()

    • setRemanence

      public void setRemanence​(long remanence)

    • nextStep

      public void nextStep()

    • complete

      public void complete()

    • animateImage

      protected void animateImage()

    • getStepImage

      protected java.awt.Image getStepImage​(int i)

    • getCompositeFor

      public java.awt.Composite getCompositeFor​(int step)
      Parameters:
      step - the required step
      Returns:
      Returns the currentComposite.

    • paintSplash

      protected void paintSplash​(java.awt.Graphics g)

    • initialize

      protected void initialize​(java.lang.String splashImagePath, java.lang.String[] stepIconsPaths)

    • getImage

      protected java.awt.Image getImage​(java.lang.String imagePath)

    • positionAtCenter

      protected void positionAtCenter​(int width, int height)
      Positions the window at the centre of the screen, taking into account the specified width and height

    • initializeUI

      protected void initializeUI()

    • getJContentPane

      protected javax.swing.JPanel getJContentPane()

    • getSplashPane

      protected javax.swing.JPanel getSplashPane()

    • main

      public static void main​(java.lang.String[] args)