org.nuiton.widget
Class SplashScreen

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.nuiton.widget.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

See Also:

Serialized Form

Nested Class Summary

protected class	SplashScreen.FrameHider
protected class	SplashScreen.ImageAnimator

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

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

protected boolean	alphaUp
protected java.lang.String	applicationTitle
protected float	currentAlpha
protected java.awt.Composite	currentComposite
protected java.awt.Image	currentImage
protected int	currentStep
static long	DEFAULT_DURATION
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 long	estimatedDuration
protected SplashScreen.ImageAnimator	imageAnimator
protected javax.swing.JPanel	jContentPane
protected long	remanence
protected java.awt.Image	splashImage
protected javax.swing.JPanel	splashPane
protected java.lang.String[]	stepDescriptions
protected java.awt.Image[]	stepImages
protected int	steppingBottomInset
protected int	steppingLeftInset
protected int	steppingRightInset

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, 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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath)

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath, long estimatedDuration)

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath, long estimatedDuration, java.lang.String[] stepDescriptions)

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath, long estimatedDuration, java.lang.String[] stepDescriptions, java.lang.String[] stepIconsPaths)

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath, java.lang.String[] stepDescriptions)

SplashScreen(java.lang.String applicationTitle, java.lang.String splashImagePath, java.lang.String[] stepDescriptions, java.lang.String[] stepImagesPaths)

Method Summary

protected void	animateImage()
void	complete()
java.lang.String	getApplicationTitle()
java.awt.Composite	getCompositeFor(int step)
java.awt.Composite	getCurrentComposite()
int	getCurrentStep()
long	getEstimatedDuration()
protected java.awt.Image	getImage(java.lang.String imagePath)
protected javax.swing.JPanel	getJContentPane()
java.awt.Image	getSplashImage()
protected javax.swing.JPanel	getSplashPane()
java.lang.String[]	getstepDescriptions()
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	setstepDescriptions(java.lang.String[] stepDescriptions)
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, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, isOpaque, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, 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 Detail

DEFAULT_DURATION

public static final long DEFAULT_DURATION

See Also:

Constant Field Values

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 java.lang.String applicationTitle

estimatedDuration

protected long estimatedDuration

stepDescriptions

protected java.lang.String[] stepDescriptions

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 Detail

SplashScreen

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

SplashScreen

public SplashScreen(java.lang.String applicationTitle,
                    java.lang.String splashImagePath,
                    long estimatedDuration)

SplashScreen

public SplashScreen(java.lang.String applicationTitle,
                    java.lang.String splashImagePath,
                    long estimatedDuration,
                    java.lang.String[] stepDescriptions)

SplashScreen

public SplashScreen(java.lang.String applicationTitle,
                    java.lang.String splashImagePath,
                    java.lang.String[] stepDescriptions)

SplashScreen

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

SplashScreen

public SplashScreen(java.lang.String applicationTitle,
                    java.lang.String splashImagePath,
                    long estimatedDuration,
                    java.lang.String[] stepDescriptions,
                    java.lang.String[] stepIconsPaths)

Method Detail

getstepDescriptions

public java.lang.String[] getstepDescriptions()

Returns:

Returns the stepDescriptions.

setstepDescriptions

public void setstepDescriptions(java.lang.String[] stepDescriptions)

Parameters:

stepDescriptions - The stepDescriptions to set.

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 java.lang.String 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.

getEstimatedDuration

public long getEstimatedDuration()

Returns:

Returns the estimatedDuration.

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.

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)