Class MmsEditValueDialog

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 MmsEditValueDialog
All Implemented Interfaces:
java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class MmsEditValueDialog
extends javax.swing.JDialog
implements java.awt.event.MouseListener

Dialog class to edit a single value. Three buttons, OK, Cancel, and Help are added initially, and more may be added by the caller. The help message may be provided with the constructor, and will be shown automatically when the Help button is clicked.

Author:
Michael Latham
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
(package private)  int m_answer
           
(package private)  int m_btnCnt
           
(package private)  int M_CANCEL
           
(package private)  java.awt.Container m_cp
           
(package private)  int M_HELP
           
(package private)  java.lang.String m_helpMsg
           
(package private)  int M_NO
          Constants
(package private)  javax.swing.JPanel m_pButtons
           
(package private)  javax.swing.JPanel m_pData
           
(package private)  javax.swing.JTextField m_tfValue
           
(package private)  java.lang.String m_value
           
(package private)  int M_YES
           
 
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
MmsEditValueDialog()
          Default constructor
MmsEditValueDialog(javax.swing.JDialog dlg, java.lang.String title, java.lang.String helpMsg)
          Alternate preferred constructor
MmsEditValueDialog(javax.swing.JFrame frame, java.lang.String title, java.lang.String helpMsg, boolean modal)
          Preferred constructor
 
Method Summary
 int addButton(java.lang.String newButtonText)
          Adds a new button and its corresponding answer to the dialog
 void addData(java.lang.String data)
          Adds or sets the data to the dialog
 int getAnswer()
          Returns the answer as set by last button clicked
 java.lang.String getData()
          Get the raw data value from the dialog
 java.lang.String getValue()
          Returns the text in the text field
private  void initialize()
          Called after constructing to prepare for dialog
 void mouseClicked(java.awt.event.MouseEvent me)
          Mouse click event handler
 void mouseEntered(java.awt.event.MouseEvent me)
          mouseEntered - N/A - Invoked when the mouse enters a component.
 void mouseExited(java.awt.event.MouseEvent me)
          mouseEntered - N/A - Invoked when the mouse exits a component.
 void mousePressed(java.awt.event.MouseEvent me)
          mousePressed - N/A - Invoked when a mouse button has been pressed on a component.
 void mouseReleased(java.awt.event.MouseEvent me)
          mouseReleased - N/A - Invoked when a mouse button has been released on a component.
 void setHelpMessage(java.lang.String lHelp)
          Sets the help message string, which will popup if the Help button is clicked
private  void showHelp()
          Pop up simple dialog to show a Help message
 
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

M_NO

final int M_NO
Constants

See Also:
Constant Field Values

M_YES

final int M_YES
See Also:
Constant Field Values

M_CANCEL

final int M_CANCEL
See Also:
Constant Field Values

M_HELP

final int M_HELP
See Also:
Constant Field Values

m_cp

java.awt.Container m_cp

m_pData

javax.swing.JPanel m_pData

m_pButtons

javax.swing.JPanel m_pButtons

m_tfValue

javax.swing.JTextField m_tfValue

m_helpMsg

java.lang.String m_helpMsg

m_value

java.lang.String m_value

m_answer

int m_answer

m_btnCnt

int m_btnCnt
Constructor Detail

MmsEditValueDialog

public MmsEditValueDialog()
Default constructor


MmsEditValueDialog

public MmsEditValueDialog(javax.swing.JFrame frame,
                          java.lang.String title,
                          java.lang.String helpMsg,
                          boolean modal)
Preferred constructor

Parameters:
frame - JFrame object of parent
title - Title of new dialog
helpMsg - Message for help button dialog, if any
modal - True for new dialog to be modal

MmsEditValueDialog

public MmsEditValueDialog(javax.swing.JDialog dlg,
                          java.lang.String title,
                          java.lang.String helpMsg)
Alternate preferred constructor

Parameters:
dlg - Dialog object of parent
title - Title of new dialog
helpMsg - Message for help button dialog, if any
Method Detail

initialize

private void initialize()
Called after constructing to prepare for dialog


addButton

public int addButton(java.lang.String newButtonText)
Adds a new button and its corresponding answer to the dialog

Parameters:
newButtonText - Text to be shown on new button. The button's number index will be returned in m_answer

addData

public void addData(java.lang.String data)
Adds or sets the data to the dialog

Parameters:
data - Text to display in text field, if any

getData

public java.lang.String getData()
Get the raw data value from the dialog

Returns:
Text data value being displayed

getAnswer

public int getAnswer()
Returns the answer as set by last button clicked

Returns:
Button index, where user buttons are > 2

getValue

public java.lang.String getValue()
Returns the text in the text field

Returns:
Value set in edit field

setHelpMessage

public void setHelpMessage(java.lang.String lHelp)
Sets the help message string, which will popup if the Help button is clicked

Parameters:
lHelp - Message to be displayed when help button is clicked

showHelp

private void showHelp()
Pop up simple dialog to show a Help message


mouseClicked

public void mouseClicked(java.awt.event.MouseEvent me)
Mouse click event handler

Specified by:
mouseClicked in interface java.awt.event.MouseListener
Parameters:
me - MouseEvent from a mouse button click

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent me)
mouseEntered - N/A - Invoked when the mouse enters a component.

Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent me)
mouseEntered - N/A - Invoked when the mouse exits a component.

Specified by:
mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent me)
mousePressed - N/A - Invoked when a mouse button has been pressed on a component.

Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent me)
mouseReleased - N/A - Invoked when a mouse button has been released on a component.

Specified by:
mouseReleased in interface java.awt.event.MouseListener