org.ceryle.ui
Class WelcomeWindow

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              javax.swing.JWindow
                  org.ceryle.ui.WelcomeWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, MessageWriter

public class WelcomeWindow
extends JWindow
implements MessageWriter

A class that creates a simple window to be displayed during the startup of the application, with a small message area to show startup messages.

This expects three System properties to be previously set:

Application version number:

"http://purl.org/ceryle/prop/#application-version-number"

Application version name:

"http://purl.org/ceryle/prop/#application-version-name"

Application name:

"http://purl.org/ceryle/prop/#application-name"

Since:

JDK1.3

Version:

$Id: WelcomeWindow.java,v 3.9 2007-06-15 12:09:40 altheim Exp $

Author:

Murray Altheim

See Also:

Serialized Form

Nested Class Summary

class

WelcomeWindow.WindowEventHandler The listener class to handle the closing of a window.

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

JWindow.AccessibleJWindow

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static boolean	animateColors When true, the message area's colors are animated during display.
static int	height
static String	welcomeAnimeImage
static String	welcomeImage The filename of the welcome image.
static int	width

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

Method Summary

static WelcomeWindow	getInstance(MessageHandler messagehandler) As this is a singleton class, returns the single instance of this class.
boolean	isComplete() Returns the state of the boolean complete, which is set true once the trailer is finished.
String	writeMessage(int status, String message) Writes the String message to the message area, implementing the MessageWriter API.
void	writeMessage(String message) Writes the String message to the message area, implementing the MessageWriter API.
void	writeStatus(String message) Writes the String message to the message area, implementing the MessageWriter API.
void	writeTrailer() Show the window and write opening trailer messages with a slight delay between.

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, 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, 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, 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

Field Detail

animateColors

public static boolean animateColors

When true, the message area's colors are animated during display.

welcomeImage

public static String welcomeImage

The filename of the welcome image.

welcomeAnimeImage

public static String welcomeAnimeImage

width

public static int width

height

public static int height

Method Detail

getInstance

public static WelcomeWindow getInstance(MessageHandler messagehandler)

As this is a singleton class, returns the single instance of this class.

writeTrailer

public void writeTrailer()

Show the window and write opening trailer messages with a slight delay between. Returns true upon completion.

isComplete

public boolean isComplete()

Returns the state of the boolean complete, which is set true once the trailer is finished.

writeMessage

public void writeMessage(String message)

Writes the String message to the message area, implementing the MessageWriter API.

Specified by:

writeMessage in interface MessageWriter

writeMessage

public String writeMessage(int status,
                           String message)

Writes the String message to the message area, implementing the MessageWriter API.

Specified by:

writeMessage in interface MessageWriter

Returns:

the String value of the message, including any changes made.

See Also:

MessageHandler

writeStatus

public void writeStatus(String message)

Writes the String message to the message area, implementing the MessageWriter API.

Specified by:

writeStatus in interface MessageWriter