Class PopupDialogQuery

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 PopupDialogQuery
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

 class PopupDialogQuery
extends java.awt.Dialog
implements java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.WindowListener

The PopupDialogQuery class is a generic popup query dialog window. It displays a dialog window containing a editable TextField. There are also 2 buttons ("Ok" and "Cancel") to pass the information on. If you have one button the label is "Continue".

This work was produced by Peter Lemkin of the National Cancer Institute, an agency of the United States Government. As a work of the United States Government there is no associated copyright. It is offered as open source software under the Mozilla Public License (version 1.1) subject to the limitations noted in the accompanying LEGAL file. This notice must be included with the code. The Flicker Mozilla and Legal files are available on http://open2dprot.sourceforge.net/.

Version:
$Date$ $Revision$
Author:
P. Lemkin (NCI), G. Thornwall (SAIC), NCI-Frederick, Frederick, MD
See Also:
Flicker Home

Nested Class Summary
 
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  int addButtonsCnt
          # of buttons to add.
(package private)  boolean alertDone
          button pressed flag
private  int colSize
          # of columns to display
 java.lang.String data
          for returning data back to caller
(package private) static int DEF_COL_SIZE
          default # of columns
private  java.awt.Frame frame
          popup frame instance
private  int height
          size of frame
private  java.awt.Label label
          for data label
(package private)  java.awt.event.ActionListener listener
          Tried this instead of "this"
(package private)  int nOptions
          optionValues[0:nOptions]
private  java.awt.Choice optionChoice
          opt.
private  java.awt.Panel optionPanel
          for options
(package private)  java.lang.String[] optionValues
          list of option values if present
(package private)  boolean sleepFlag
          wait for button to be pushed
private  java.lang.String spaces
          DEF_COL_SIZE spaces
(package private)  java.awt.TextField textField
          place text to be edited here
private  int width
          size of frame
 
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
 
Constructor Summary
PopupDialogQuery(java.awt.Frame f, int addButtonsCnt)
          PopupDialogQuery() - Constructor
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          actionPerformed() - Handle button clicks
(package private)  void alertTimeout(java.lang.String msg)
          alertTimeout() - update the popup dialog msg - wait for "Continue"
(package private)  java.lang.String dialogQuery(java.lang.String msg, java.lang.String defaultValue)
          dialogQuery() - query String variable requested
(package private)  java.lang.String dialogQuery(java.lang.String msg, java.lang.String defaultValue, java.lang.String[] optionValues, int nOptions)
          dialogQuery() - query String variable int requested
 void itemStateChanged(java.awt.event.ItemEvent e)
          itemStateChanged() - event handler for Choices
(package private)  void startPopupDialog(java.lang.String windowTitle, int colSize)
          startPopupDialog() - create a hidden dialog panel within a frame.
(package private)  void updatePopupDialog(java.lang.String defaultDataMsg, java.lang.String defaultData, java.lang.String[] optionValues, int nOptions)
          updatePopupDialog() - display/unhide popup dialog frame and set new values.
 void windowActivated(java.awt.event.WindowEvent e)
           
 void windowClosed(java.awt.event.WindowEvent e)
           
 void windowClosing(java.awt.event.WindowEvent e)
          windowClosing() - close down the window on PC only.
 void windowDeactivated(java.awt.event.WindowEvent e)
           
 void windowDeiconified(java.awt.event.WindowEvent e)
           
 void windowIconified(java.awt.event.WindowEvent e)
           
 void windowOpened(java.awt.event.WindowEvent e)
           
 
Methods inherited from class java.awt.Dialog
addNotify, getAccessibleContext, getTitle, hide, isModal, isResizable, isUndecorated, paramString, 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, processWindowEvent, 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, addImpl, 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, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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

DEF_COL_SIZE

static final int DEF_COL_SIZE
default # of columns

See Also:
Constant Field Values

data

public java.lang.String data
for returning data back to caller


colSize

private int colSize
# of columns to display


width

private int width
size of frame


height

private int height
size of frame


frame

private java.awt.Frame frame
popup frame instance


textField

java.awt.TextField textField
place text to be edited here


label

private java.awt.Label label
for data label


optionPanel

private java.awt.Panel optionPanel
for options


optionChoice

private java.awt.Choice optionChoice
opt. option choice list


addButtonsCnt

private int addButtonsCnt
# of buttons to add. if 0, then none, if 1, then add CONTINUE, if 2 then add OK and CANCEL.


alertDone

boolean alertDone
button pressed flag


sleepFlag

boolean sleepFlag
wait for button to be pushed


listener

java.awt.event.ActionListener listener
Tried this instead of "this"


spaces

private java.lang.String spaces
DEF_COL_SIZE spaces


optionValues

java.lang.String[] optionValues
list of option values if present


nOptions

int nOptions
optionValues[0:nOptions]

Constructor Detail

PopupDialogQuery

PopupDialogQuery(java.awt.Frame f,
                 int addButtonsCnt)
PopupDialogQuery() - Constructor

Parameters:
f - is frame of parent
addButtonsCnt - is # of buttons to use where: 1 is (OK), 2 is (Continue, Cancel), 3 is OptionsChoice & (Continue, Cancel)
See Also:
startPopupDialog(java.lang.String, int)
Method Detail

startPopupDialog

void startPopupDialog(java.lang.String windowTitle,
                      int colSize)
startPopupDialog() - create a hidden dialog panel within a frame.

Parameters:
windowTitle - is the title of the dialog window
colSize - is the size of the textField

updatePopupDialog

void updatePopupDialog(java.lang.String defaultDataMsg,
                       java.lang.String defaultData,
                       java.lang.String[] optionValues,
                       int nOptions)
updatePopupDialog() - display/unhide popup dialog frame and set new values. Remove recreate actionListeners & components.

Parameters:
defaultDataMsg - is the label for textField
defaultDatais - the data for textField
optionValues - is the list of option values
nOptions - is the number of options

alertTimeout

void alertTimeout(java.lang.String msg)
alertTimeout() - update the popup dialog msg - wait for "Continue"

Parameters:
msg - is message to display
See Also:
updatePopupDialog(java.lang.String, java.lang.String, java.lang.String[], int)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed() - Handle button clicks

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - is action event when button pressed

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)
itemStateChanged() - event handler for Choices

Specified by:
itemStateChanged in interface java.awt.event.ItemListener
Parameters:
e - is item event when choices selected
See Also:
Component.repaint()

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)
windowClosing() - close down the window on PC only. hide frame which can be shown later.

Specified by:
windowClosing in interface java.awt.event.WindowListener
Parameters:
e - is window closing event

dialogQuery

java.lang.String dialogQuery(java.lang.String msg,
                             java.lang.String defaultValue)
dialogQuery() - query String variable requested

Parameters:
msg - is message to display in dialog box
defaultValue - to use if press OK and there is no data
See Also:
updatePopupDialog(java.lang.String, java.lang.String, java.lang.String[], int)

dialogQuery

java.lang.String dialogQuery(java.lang.String msg,
                             java.lang.String defaultValue,
                             java.lang.String[] optionValues,
                             int nOptions)
dialogQuery() - query String variable int requested

Parameters:
msg - is message to display in dialog box
defaultValue - to use
optionValues - to use
nOptions - number of option values
See Also:
updatePopupDialog(java.lang.String, java.lang.String, java.lang.String[], int)

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)
Specified by:
windowOpened in interface java.awt.event.WindowListener

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)
Specified by:
windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)
Specified by:
windowClosed in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)
Specified by:
windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)
Specified by:
windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)
Specified by:
windowIconified in interface java.awt.event.WindowListener