Package edu.wisc.ssec.mcidasv.util

Class WelcomeWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

edu.wisc.ssec.mcidasv.util.WelcomeWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class WelcomeWindow
extends JDialog

WelcomeWindow is really just intended to try to detect known hardware problems and inform the user about any problems.

The current implementation does not perform any detection, but expect this to change.

See Also:

• Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	autoQuit	Whether or not the window should automatically close.
private final long	autoQuitDelay	Delay in milliseconds for auto-quitting.
private final JPanel	buttonPanel
private final URL	contents	Java-friendly location of the path to the welcome message.
static final long	DEFAULT_QUIT_DELAY	Default auto-quit delay (in milliseconds).
private static final String	ERROR_MESSAGE	Message to display if there was a problem loading WELCOME_HTML.
private static final org.slf4j.Logger	logger
private static final String	LOGO_PATH	Path to "header" image.
private final JLabel	logoLabel
private final JPanel	logoPanel
private final JPanel	mainPanel
private final JButton	quitButton
private final JScrollPane	scrollPane
private final JButton	startButton
private final JTextPane	textPane
private static final String	WELCOME_HTML	Path to the HTML to display within textPane.
private static final Dimension	WINDOW_SIZE	Dimensions of the welcome window frame.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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
WelcomeWindow()	Creates new form WelcomeWindow.
WelcomeWindow(boolean autoQuit, long delay)

Method Summary

Modifier and Type	Method	Description
private void	formWindowClosing(WindowEvent evt)	Handles the user opting to close the welcome window JFrame.
private void	initComponents()	This method is called from within the constructor to initialize the form.
static void	main(String[] args)	Kick the tires.
private void	quitButtonActionPerformed(ActionEvent evt)	Handles the user clicking on quitButton.
void	setVisible(boolean visible)	Show or close the Welcome Window.
private void	startButtonActionPerformed(ActionEvent evt)	Handles the user clicking on startButton.
private void	textPaneHyperlinkUpdate(HyperlinkEvent evt)	Listens to textPane in order to handle the user clicking on HTML links.

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

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, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, remove, 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

Field Details

logger

private static final org.slf4j.Logger logger

LOGO_PATH

private static final String LOGO_PATH

Path to "header" image.

See Also:

• Constant Field Values

WELCOME_HTML

private static final String WELCOME_HTML

Path to the HTML to display within textPane.

See Also:

• Constant Field Values

ERROR_MESSAGE

private static final String ERROR_MESSAGE

Message to display if there was a problem loading WELCOME_HTML.

See Also:

• Constant Field Values

WINDOW_SIZE

private static final Dimension WINDOW_SIZE

Dimensions of the welcome window frame.

DEFAULT_QUIT_DELAY

public static final long DEFAULT_QUIT_DELAY

Default auto-quit delay (in milliseconds).

See Also:

• Constant Field Values

contents

private final URL contents

Java-friendly location of the path to the welcome message.

autoQuit

private final boolean autoQuit

Whether or not the window should automatically close.

autoQuitDelay

private final long autoQuitDelay

Delay in milliseconds for auto-quitting.

buttonPanel

private final JPanel buttonPanel

logoLabel

private final JLabel logoLabel

logoPanel

private final JPanel logoPanel

mainPanel

private final JPanel mainPanel

quitButton

private final JButton quitButton

scrollPane

private final JScrollPane scrollPane

startButton

private final JButton startButton

textPane

private final JTextPane textPane

Constructor Details

WelcomeWindow

public WelcomeWindow()

Creates new form WelcomeWindow.

WelcomeWindow

public WelcomeWindow(boolean autoQuit,
 long delay)

Method Details

initComponents

private void initComponents()

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

setVisible

public void setVisible(boolean visible)

Show or close the Welcome Window.

Overridden in McV to handle auto-quitting. If we're supposed to auto-quit, a thread will be started that calls AbstractButton.doClick().

Overrides:

setVisible in class Dialog

Parameters:

visible - Whether or not the dialog should be opened or closed.

startButtonActionPerformed

private void startButtonActionPerformed(ActionEvent evt)

Handles the user clicking on startButton.

Parameters:

evt - Event to handle. Currently ignored.

quitButtonActionPerformed

private void quitButtonActionPerformed(ActionEvent evt)

Handles the user clicking on quitButton. Doesn't do anything aside from handing off things to formWindowClosing(WindowEvent)

Parameters:

evt - Event to handle. Currently ignored.

See Also:

• formWindowClosing(WindowEvent)

formWindowClosing

private void formWindowClosing(WindowEvent evt)

Handles the user opting to close the welcome window JFrame. Executes System.exit(1) in an effort to signal to the startup scripts that window terminated "abnormally".

An abnormal termination will result in the startup script terminating the launch of McIDAS-V.

Parameters:

evt - Event to handle. Currently ignored.

textPaneHyperlinkUpdate

private void textPaneHyperlinkUpdate(HyperlinkEvent evt)

Listens to textPane in order to handle the user clicking on HTML links.

Parameters:

evt - Event to handle. Anything other than an "ACTIVATED" HyperlinkEvent.EventType is ignored.

See Also:

• WebBrowser.browse(String)

main

public static void main(String[] args)

Kick the tires.

Parameters:

args - Command line arguments