javoids
Class KeyDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by javoids.KeyDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class KeyDialog
extends javax.swing.JDialog

A class to allow the user to respecify the action taken by the keys on the user's keyboard.

Author:
mallette
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
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
private  java.awt.BorderLayout borderLayout1
          a layout for panels
private  javax.swing.JButton[][] buttonList
          a list of all keyboard buttons in the panel
private  javax.swing.JPanel buttonPanel
          a panel to hold the okay/cancel buttons
private  javax.swing.JButton cancelButton
          cancel button
private  java.lang.String currentKey
          the currently selected key
private  javax.swing.JMenuItem keyFileExitItem
          the file | exit menu item
private  javax.swing.JMenu keyFileMenu
          the file menu
private  javax.swing.JMenuItem keyFileOpenItem
          the file | open menu item
private  javax.swing.JMenuItem keyFileSaveItem
          the file | save menu item
private  javax.swing.JMenuBar KeyMainMenu
          the main menu for this dialog
private  KeyMap keyMap
          aa mapping of key names to key values
private  javax.swing.JPopupMenu menuPopup
          popup menu
private  javax.swing.JButton okButton
          okay button
private  javax.swing.JPanel panel
          a panel to hold the screen controls
private  javax.swing.JScrollPane scrollPane
          a scroll pane to controll scrolling in the dialog
private static long serialVersionUID
          This is the version used for serializing/deserializing (storing/retrieving) this object
private  boolean successStatus
          Was the result successful?
private  javax.swing.JPanel tablePanel
          a panel to hold the keyboar buttons
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
KeyDialog()
          Constructor (default)
KeyDialog(java.awt.Frame frame, java.lang.String title, boolean modal)
          Constructor
 
Method Summary
 void actionPerformedButton(java.awt.event.ActionEvent actionEvent)
          Perform the action specified.
 void actionPerformedMenu(java.awt.event.ActionEvent actionEvent)
          Store an action for a key to perform when pressed.
(package private)  void cancelButton_actionPerformed(java.awt.event.ActionEvent actionEvent)
          Cancel your changes.
(package private)  KeyMap getKeyMap()
           
 boolean getSuccessStatus()
           
(package private)  void keyFileExitItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
          Exit the dialog and abandon your changes.
(package private)  void keyFileOpenItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
          Open a keymap and update the key dialog with those values.
(package private)  void keyFileSaveItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
          Save the keymap from this dialog.
(package private)  void mouseMovedButton(java.awt.event.MouseEvent mouseEvent)
          Upodate the tooltip when the mouse moves.
(package private)  void okButton_actionPerformed(java.awt.event.ActionEvent actionEvent)
          The dialog ended successfully so exit the dialog.
private  void resizeButtons()
          Resize all of the buttons.
private  void setButtonBounds(javax.swing.JButton button, java.awt.Insets insets, java.awt.Point location, java.awt.Dimension dimension)
           
private  void setButtonValues()
          Set the values for each button to the keyboard character and the action associated with them.
(package private)  void setKeyMap(KeyMap _keyMap)
           
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
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, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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

serialVersionUID

private static final long serialVersionUID
This is the version used for serializing/deserializing (storing/retrieving) this object

See Also:
Constant Field Values

successStatus

private boolean successStatus
Was the result successful?


KeyMainMenu

private javax.swing.JMenuBar KeyMainMenu
the main menu for this dialog


keyFileMenu

private javax.swing.JMenu keyFileMenu
the file menu


keyFileOpenItem

private javax.swing.JMenuItem keyFileOpenItem
the file | open menu item


keyFileSaveItem

private javax.swing.JMenuItem keyFileSaveItem
the file | save menu item


keyFileExitItem

private javax.swing.JMenuItem keyFileExitItem
the file | exit menu item


scrollPane

private javax.swing.JScrollPane scrollPane
a scroll pane to controll scrolling in the dialog


panel

private javax.swing.JPanel panel
a panel to hold the screen controls


tablePanel

private javax.swing.JPanel tablePanel
a panel to hold the keyboar buttons


borderLayout1

private java.awt.BorderLayout borderLayout1
a layout for panels


keyMap

private KeyMap keyMap
aa mapping of key names to key values


buttonPanel

private javax.swing.JPanel buttonPanel
a panel to hold the okay/cancel buttons


okButton

private javax.swing.JButton okButton
okay button


cancelButton

private javax.swing.JButton cancelButton
cancel button


menuPopup

private javax.swing.JPopupMenu menuPopup
popup menu


currentKey

private java.lang.String currentKey
the currently selected key


buttonList

private transient javax.swing.JButton[][] buttonList
a list of all keyboard buttons in the panel

Constructor Detail

KeyDialog

public KeyDialog(java.awt.Frame frame,
                 java.lang.String title,
                 boolean modal)
Constructor

Parameters:
frame - the owning frame for this dialog
title - the title of this frame
modal - is this a modal dialog?

KeyDialog

public KeyDialog()
Constructor (default)

Method Detail

getKeyMap

KeyMap getKeyMap()
Returns:
a mapping of key names to key values in the form of a KeyMap object.

getSuccessStatus

public boolean getSuccessStatus()
Returns:
whether or not the action of the save was successful

setKeyMap

void setKeyMap(KeyMap _keyMap)
Parameters:
_keyMap - the keymap to use for the dialog

setButtonValues

private void setButtonValues()
Set the values for each button to the keyboard character and the action associated with them.


setButtonBounds

private void setButtonBounds(javax.swing.JButton button,
                             java.awt.Insets insets,
                             java.awt.Point location,
                             java.awt.Dimension dimension)
Parameters:
button - the button to set the bounds of
insets - the inset attributes
location - the location of the button
dimension - the size of the button (width/height)

resizeButtons

private void resizeButtons()
Resize all of the buttons.


keyFileOpenItem_actionPerformed

void keyFileOpenItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
Open a keymap and update the key dialog with those values.

Parameters:
actionEvent - the action to perform

keyFileSaveItem_actionPerformed

void keyFileSaveItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
Save the keymap from this dialog.

Parameters:
actionEvent - the action to perform

keyFileExitItem_actionPerformed

void keyFileExitItem_actionPerformed(java.awt.event.ActionEvent actionEvent)
Exit the dialog and abandon your changes.

Parameters:
actionEvent - the action to perform

okButton_actionPerformed

void okButton_actionPerformed(java.awt.event.ActionEvent actionEvent)
The dialog ended successfully so exit the dialog.

Parameters:
actionEvent - the action to perform

cancelButton_actionPerformed

void cancelButton_actionPerformed(java.awt.event.ActionEvent actionEvent)
Cancel your changes.

Parameters:
actionEvent - the action to perform

mouseMovedButton

void mouseMovedButton(java.awt.event.MouseEvent mouseEvent)
Upodate the tooltip when the mouse moves.

Parameters:
mouseEvent - the mouse event to handle

actionPerformedButton

public void actionPerformedButton(java.awt.event.ActionEvent actionEvent)
Perform the action specified.

Parameters:
actionEvent - the event to process

actionPerformedMenu

public void actionPerformedMenu(java.awt.event.ActionEvent actionEvent)
Store an action for a key to perform when pressed.

Parameters:
actionEvent - the event to process