com.huguesjohnson.hapsby
Class HapsbyMainWindow

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.huguesjohnson.hapsby.HapsbyMainWindow

All Implemented Interfaces:

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

public abstract class HapsbyMainWindow
extends javax.swing.JFrame

User interface for Hapsby application.

Author:

Hugues Johnson

See Also:

Serialized Form

Nested Class Summary

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

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

HapsbyMainWindow(java.lang.String caption)
Creates the window and adds components.

Method Summary

abstract void	actionListener(java.awt.event.ActionEvent e) Method invoked when an action is performed.
void	centerWindow() Centers the window in the middle of the screen.
abstract void	closeWindow() Method invoked when the window is closed.
java.lang.String	getCurrentLookAndFeelName() Returns the class name of the current look and feel.
java.lang.String	getCurrentPropertyValue() Returns the text contained in the "Current Value" JTextField.
SaveGameProperty	getSelectedProperty() Returns the selected property from the properties list (leftPane).
abstract void	listSelectionListener(javax.swing.event.ListSelectionEvent e) Method invoked when the property list selection is changed.
void	setCurrentProperty(SaveGameProperty sgp, int currentValue) Refreshes the edit property panel (rightPane) based on a SaveGameProperty and value from a save game.
void	setCurrentProperty(SaveGameProperty sgp, java.lang.String currentValue) Refreshes the edit property panel (rightPane) based on a SaveGameProperty and value from a save game.
void	setGameDescription(java.lang.String description) Sets the value for the "Save Game Description" field.
void	setLookAndFeel(java.lang.String newLookAndFeel) Changes the look and feel of the window.
void	setProgress(java.lang.String message, int percent) Sets the text and percent complete of the status bar.
void	setPropertyList(java.util.ArrayList<SaveGameProperty> properties) Populates the property list (leftPane).

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

Constructor Detail

HapsbyMainWindow

public HapsbyMainWindow(java.lang.String caption)

Creates the window and adds components.

Method Detail

setLookAndFeel

public void setLookAndFeel(java.lang.String newLookAndFeel)

Changes the look and feel of the window.

Parameters:

newLookAndFeel - Class name of the new look & feel to use.

setGameDescription

public void setGameDescription(java.lang.String description)

Sets the value for the "Save Game Description" field. The description may be plain text or html format.

Parameters:

description - New value for the "Save Game Description" field.

setCurrentProperty

public void setCurrentProperty(SaveGameProperty sgp,
                               int currentValue)

Refreshes the edit property panel (rightPane) based on a SaveGameProperty and value from a save game.

Parameters:

sgp - New SaveGameProperty to display.

currentValue - New current value for the property.

setCurrentProperty

public void setCurrentProperty(SaveGameProperty sgp,
                               java.lang.String currentValue)

Refreshes the edit property panel (rightPane) based on a SaveGameProperty and value from a save game.

Parameters:

sgp - New SaveGameProperty to display.

currentValue - New current value for the property.

getSelectedProperty

public SaveGameProperty getSelectedProperty()

Returns the selected property from the properties list (leftPane).

Returns:

Selected property from property list (leftPane).

setPropertyList

public void setPropertyList(java.util.ArrayList<SaveGameProperty> properties)

Populates the property list (leftPane).

Parameters:

properties - ArrayList of properties to go into the property list (leftPane).

getCurrentPropertyValue

public java.lang.String getCurrentPropertyValue()

Returns the text contained in the "Current Value" JTextField.

Returns:

The text contained in the "Current Value" JTextField.

actionListener

public abstract void actionListener(java.awt.event.ActionEvent e)

Method invoked when an action is performed. Override this routine when creating a new HapsbyMainWindow.

Parameters:

e - ActionEvent received by UI

listSelectionListener

public abstract void listSelectionListener(javax.swing.event.ListSelectionEvent e)

Method invoked when the property list selection is changed. Override this routine when creating a new HapsbyMainWindow.

Parameters:

e - ListSelectionEvent received by UI

closeWindow

public abstract void closeWindow()

Method invoked when the window is closed. Override this routine when creating a new HapsbyMainWindow.

setProgress

public void setProgress(java.lang.String message,
                        int percent)

Sets the text and percent complete of the status bar.

Parameters:

message - The new message to display in the status bar.

percent - The new percent complete to display in the status bar.

centerWindow

public void centerWindow()

Centers the window in the middle of the screen.

getCurrentLookAndFeelName

public java.lang.String getCurrentLookAndFeelName()

Returns the class name of the current look and feel.

Returns:

The class name of the current look and feel.