eu.beesoft.gaia.launcher
Class SplashScreen

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              javax.swing.JWindow
                  eu.beesoft.gaia.launcher.SplashScreen

All Implemented Interfaces:

ProgressMediator, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer

public class SplashScreen
extends javax.swing.JWindow
implements ProgressMediator

A basic implementation of splash screen and ProgressMediator. Creates a main window, displays an image and a progress bar. Override method build() to change the look of for this spash screen.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JWindow.AccessibleJWindow

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JWindow

accessibleContext, rootPane, rootPaneCheckingEnabled

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

Constructor Summary

protected

SplashScreen() Create a new instance of SplashScreen.

Method Summary

protected void	build() Builds a basic splash screen.
void	close() Implementation of ProgressMediator.close() method.
protected byte[]	getImage() Returns an image data for this splash screen.
protected byte[]	getImage(java.lang.String name) Returns a byte array with image data for given image name.
protected java.awt.Component	getImageComponent(byte[] image) Creates a new component (in this implementation JLabel) to display given image.
protected javax.swing.JProgressBar	getProgressBar() Returns a JProgressBar instance which was set by setProgressBar(JProgressBar) method.
int	getProgressRange() Implementation of ProgressMediator.getProgressRange() method.
int	getProgressStep() Implementation of ProgressMediator.getProgressStep() method.
java.lang.String	getProgressText() Implementation of ProgressMediator.getProgressText() method.
boolean	isInterrupted() Implementation of ProgressMediator.isInterrupted() method.
protected void	setProgressBar(javax.swing.JProgressBar progressBar) Sets a JProgressBar instance.
void	setProgressRange(int count) Implementation of ProgressMediator.setProgressRange(int) method.
void	setProgressStep(int step) Implementation of ProgressMediator.setProgressStep(int) method.
void	setProgressText(java.lang.String text) Implementation of ProgressMediator.setProgressText(String) method.

Methods inherited from class javax.swing.JWindow

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update, windowInit

Methods inherited from class java.awt.Window

addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, removeNotify, 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, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, checkImage, checkImage, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

SplashScreen

protected SplashScreen()

Create a new instance of SplashScreen. Sets UI look and feel to system default. Then invokes method build() to buld splash screen. It centers on screen and displays at the end.

Method Detail

build

protected void build()

Builds a basic splash screen. Loads an image via method getImage() and if it is not null, displays it in center area. Then creates a JProgressBar and displays it in bottom.

This method is invoked from constructor. Override it if you need other look for your splash screen.

getImageComponent

protected java.awt.Component getImageComponent(byte[] image)

Creates a new component (in this implementation JLabel) to display given image.

Parameters:

image - - a byte array with image data

Returns:

created component that displays given image

getImage

protected byte[] getImage()

Returns an image data for this splash screen. Resource for image is requested from Launcher instance. If not found, returns null. Otherwise it invokes getImage(String) method to load data from resource.

This method is invoked from build() method.

Returns:

image data or null

getImage

protected byte[] getImage(java.lang.String name)

Returns a byte array with image data for given image name. A resource is first obtained from Launcher.getFile(String) method. If this is not successfull, it tries to get from file system, and if this fails, from a class path.

Parameters:

name - - a name of resource with image data

Returns:

data for image

Throws:

java.lang.RuntimeException - if resource with given name not found or some I/O error occured

setProgressBar

protected void setProgressBar(javax.swing.JProgressBar progressBar)

Sets a JProgressBar instance. This method does not set it to UI, it just remembers it for ProgressMediator purposes.

Parameters:

progressBar - - a progress bar to set

getProgressBar

protected javax.swing.JProgressBar getProgressBar()

Returns a JProgressBar instance which was set by setProgressBar(JProgressBar) method.

Returns:

progress bar

getProgressRange

public int getProgressRange()

Implementation of ProgressMediator.getProgressRange() method.

Specified by:

getProgressRange in interface ProgressMediator

Returns:

maximum progress value

setProgressRange

public void setProgressRange(int count)

Implementation of ProgressMediator.setProgressRange(int) method.

Specified by:

setProgressRange in interface ProgressMediator

Parameters:

count - - maximum progress value

getProgressStep

public int getProgressStep()

Implementation of ProgressMediator.getProgressStep() method.

Specified by:

getProgressStep in interface ProgressMediator

Returns:

current progress step

setProgressStep

public void setProgressStep(int step)

Implementation of ProgressMediator.setProgressStep(int) method.

Specified by:

setProgressStep in interface ProgressMediator

Parameters:

step - - a progress step to set

getProgressText

public java.lang.String getProgressText()

Implementation of ProgressMediator.getProgressText() method.

Specified by:

getProgressText in interface ProgressMediator

Returns:

progress text

setProgressText

public void setProgressText(java.lang.String text)

Implementation of ProgressMediator.setProgressText(String) method.

Specified by:

setProgressText in interface ProgressMediator

Parameters:

text - - a text to set

isInterrupted

public boolean isInterrupted()

Implementation of ProgressMediator.isInterrupted() method. Returns false by default.

Specified by:

isInterrupted in interface ProgressMediator

Returns:

false

close

public void close()

Implementation of ProgressMediator.close() method. Disposes this window and set progress mediator in Launcher to null.

Specified by:

close in interface ProgressMediator