Class MsgDialog

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

public class MsgDialog
extends javax.swing.JDialog

MsgDialog is a generic dialog pop-up to either show a message, error, or get user input USAGE This dialog is modal, and will hide on close. The caller is responsible for disposal after retrieving any input. The basic steps to invoke are: 1. Construct 2. Set type (MESSAGE is the default) 3. Add message or question (if applicable) 4. Set visible 5. Get answer (if applicable) 6. Get data 7. Dispose Example of basic message: MsgDialog msg = new MsgDialog(this); msg.setType( MsgDialog.MESSAGE ); msg.setData( "This is my message." ); msg.setVisible(true); msg.dispose(); Example of question: MsgDialog msg = new MsgDialog(this); msg.setType( MsgDialog.QUESTION ); msg.setData( "Do you want to continue?" ); msg.setVisible(true); int answer = msg.getAnswer(); msg.dispose(); if (answer == MsgDialog.OK) { //Do stuff } Example of user input: MsgDialog msg = new MsgDialog(this); msg.setType( MsgDialog.INPUT ); msg.setData( "" ); msg.setVisible(true); int answer = msg.getAnswer(); // do not dispose, yet if (answer == MsgDialog.OK) { String value = msg.getInput(); //Do stuff with value } msg.dispose();

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
static int CANCEL
          Constant - MsgDialog answer
private  javax.swing.JPanel contentPane
          Screen component
static int INPUT
          Constant - MsgDialog type
private  javax.swing.JScrollPane jScrollPane1
          Screen component
private  int m_answer
          Answer from user - Ok or Cancel
private  javax.swing.JButton m_cancelBtn
          Button to cancel
private  java.lang.String m_input
          Data user input if type is INPUT
private  int m_modeType
          Mode of MsgDialog - INPUT, QUESTION, or MESSAGE
private  javax.swing.JTextArea m_msgTA
          Text area component for input or message
private  javax.swing.JButton m_okBtn
          Button to acknowledge
private  java.awt.Frame m_parent
          Owner frame of this dialog
private  java.awt.Dialog m_parentDlg
          Owner dialog of this dialog
static int MESSAGE
          Constant - MsgDialog type
static int OK
          Constant - MsgDialog answer
static int QUESTION
          Constant - MsgDialog type
 
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
MsgDialog(java.awt.Dialog w)
          Constructor where parent is a Dialog
MsgDialog(java.awt.Frame w)
          Constructor where parent is a Frame
 
Method Summary
private  void addComponent(java.awt.Container container, java.awt.Component c, int x, int y, int width, int height)
          Add Component Without a Layout Manager (Absolute Positioning)
 int getAnswer()
          Retrieve the answer; use after dialog is released by Ok or Cancel action
 java.lang.String getInput()
          Retrieve user input; use after dialog is released by Ok or Cancel action
private  void initializeComponent()
          Initialize all the components for the GUI
private  void m_cancelBtn_actionPerformed(java.awt.event.ActionEvent e)
          Cancel Button action handler
private  void m_okBtn_actionPerformed(java.awt.event.ActionEvent e)
          OK Button action handler
private  void postInitialize()
          Post initialization default setup
 void setData(java.lang.String dataStr)
          Set message or question to be displayed and acknowledged
 void setType(int modeType)
          Set the mode type for this MsgDialog
 
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

MESSAGE

public static final int MESSAGE
Constant - MsgDialog type

See Also:
Constant Field Values

QUESTION

public static final int QUESTION
Constant - MsgDialog type

See Also:
Constant Field Values

INPUT

public static final int INPUT
Constant - MsgDialog type

See Also:
Constant Field Values

CANCEL

public static final int CANCEL
Constant - MsgDialog answer

See Also:
Constant Field Values

OK

public static final int OK
Constant - MsgDialog answer

See Also:
Constant Field Values

m_parent

private java.awt.Frame m_parent
Owner frame of this dialog


m_parentDlg

private java.awt.Dialog m_parentDlg
Owner dialog of this dialog


m_msgTA

private javax.swing.JTextArea m_msgTA
Text area component for input or message


jScrollPane1

private javax.swing.JScrollPane jScrollPane1
Screen component


m_okBtn

private javax.swing.JButton m_okBtn
Button to acknowledge


m_cancelBtn

private javax.swing.JButton m_cancelBtn
Button to cancel


contentPane

private javax.swing.JPanel contentPane
Screen component


m_input

private java.lang.String m_input
Data user input if type is INPUT


m_answer

private int m_answer
Answer from user - Ok or Cancel


m_modeType

private int m_modeType
Mode of MsgDialog - INPUT, QUESTION, or MESSAGE

Constructor Detail

MsgDialog

public MsgDialog(java.awt.Frame w)
Constructor where parent is a Frame

Parameters:
w - Parent frame

MsgDialog

public MsgDialog(java.awt.Dialog w)
Constructor where parent is a Dialog

Parameters:
w - Parent dialog
Method Detail

initializeComponent

private void initializeComponent()
Initialize all the components for the GUI


postInitialize

private void postInitialize()
Post initialization default setup


addComponent

private void addComponent(java.awt.Container container,
                          java.awt.Component c,
                          int x,
                          int y,
                          int width,
                          int height)
Add Component Without a Layout Manager (Absolute Positioning)

Parameters:
container - Container to which to add component
c - Component to add to container
x - X coordinate position for component in container
y - Y coordinate position for component in container
width - width of component
height - height of component

m_okBtn_actionPerformed

private void m_okBtn_actionPerformed(java.awt.event.ActionEvent e)
OK Button action handler

Parameters:
e - Action event object

m_cancelBtn_actionPerformed

private void m_cancelBtn_actionPerformed(java.awt.event.ActionEvent e)
Cancel Button action handler

Parameters:
e - Action event object

getAnswer

public int getAnswer()
Retrieve the answer; use after dialog is released by Ok or Cancel action

Returns:
answer = this.OK or this.CANCEL

getInput

public java.lang.String getInput()
Retrieve user input; use after dialog is released by Ok or Cancel action

Returns:
Data user entered

setType

public void setType(int modeType)
Set the mode type for this MsgDialog

Parameters:
modeType - QUESTION, MESSAGE, or INPUT

setData

public void setData(java.lang.String dataStr)
Set message or question to be displayed and acknowledged

Parameters:
dataStr - Message or question