arlut.csd.JDialog

Class StringDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

arlut.csd.JDialog.StandardDialog

arlut.csd.JDialog.StringDialog

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class StringDialog
extends StandardDialog
implements java.awt.event.ActionListener, java.awt.event.WindowListener

A simple customizable dialog with support for a variety of data field components.

For simple dialogs, use the included constructors. For more complicated dialogs, including check boxes, choice lists, and text fields, use a DialogRsrc object to pass in a pre-defined dialog definition.

The ShowDialog method shows the current dialog, and returns a Hashtable of results, which map the label used in the dialog for individual data fields with the value entered into that field.

Version:

$Id$

Author:

Mike Mulvaney

See Also:

DialogRsrc, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class arlut.csd.JDialog.StandardDialog

StandardDialog.ModalityType

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, java.awt.Dialog.ModalExclusionType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

Modifier and Type	Field and Description
(package private) javax.swing.JPanel	buttonPanel
(package private) static java.lang.String	cancel
(package private) javax.swing.JButton	CancelButton
(package private) java.awt.GridBagConstraints	compgbc
(package private) java.awt.GridBagLayout	compgbl
(package private) java.util.Hashtable	componentHash
(package private) java.util.Vector	components
(package private) javax.swing.JPanel	dataPanel
(package private) static boolean	debug
(package private) boolean	done
(package private) java.awt.GridBagConstraints	gbc
(package private) java.awt.GridBagLayout	gbl
(package private) java.awt.Image	image
(package private) javax.swing.JLabel	imageCanvas
(package private) javax.swing.JPanel	mainPanel
(package private) java.util.Vector	objects
(package private) static java.lang.String	ok
(package private) javax.swing.JButton	OKButton
(package private) javax.swing.JPanel	panel
(package private) DialogRsrc	resource
(package private) JMultiLineLabel	textLabel
(package private) static TranslationService	ts TranslationService object for handling string localization in the Ganymede server.
(package private) java.util.Hashtable	valueHash

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Constructors

Constructor and Description
StringDialog(DialogRsrc Resource, StandardDialog.ModalityType modality) Constructor for more complicated StringDialog.
StringDialog(java.awt.Frame frame, java.lang.String Title, java.lang.String Text, boolean ShowCancel, StandardDialog.ModalityType modality) Simple constructor for a small dialog box
StringDialog(java.awt.Frame frame, java.lang.String Title, java.lang.String Text, StandardDialog.ModalityType modality) Simple constructor for a small dialog box with a Cancel button
StringDialog(java.awt.Frame frame, java.lang.String Title, java.lang.String Text, java.lang.String OK, java.lang.String Cancel, java.awt.Image image, StandardDialog.ModalityType modality) Simple constructor for a small dialog box
StringDialog(java.awt.Frame frame, java.lang.String Title, java.lang.String Text, java.lang.String OK, java.lang.String Cancel, StandardDialog.ModalityType modality) Simple constructor for a small dialog box

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Handle the ok and cancel buttons.
private void	addRow(javax.swing.JPanel parent, javax.swing.JComponent comp, java.lang.String label, int row) Convenience method to add a GUI component to this dialog.
private void	create()
private javax.swing.JPanel	createElementPanel()
static java.lang.String	getDefaultCancel() Returns the localized Cancel string for the language used by the client's Java environment.
static java.lang.String	getDefaultOk() Returns the localized Ok string for the language used by the client's Java environment.
java.awt.Dimension	getPreferredSize()
private void	loadValueHash() This method is responsible for scanning all of the input fields in this dialog and loading their values into valueHash for showDialog() to return.
protected void	registerCallbacks() We want to make it so that when the user hits enter on the last string or password field in the dialog, the ok button is clicked.
void	setFont(java.awt.Font font)
void	setWrapLength(int wrapLength) Set the word wrap length of the main text area in this StringDialog.
java.util.Hashtable	showDialog() Display the dialog box, locks this thread while the dialog is being displayed, and returns a hashtable of data field values when the user closes the dialog box.
void	windowActivated(java.awt.event.WindowEvent event)
void	windowClosed(java.awt.event.WindowEvent event)
void	windowClosing(java.awt.event.WindowEvent event)
void	windowDeactivated(java.awt.event.WindowEvent event)
void	windowDeiconified(java.awt.event.WindowEvent event)
void	windowIconified(java.awt.event.WindowEvent event)
void	windowOpened(java.awt.event.WindowEvent event)

Methods inherited from class arlut.csd.JDialog.StandardDialog

isMacSheet, isRunningOnMac, setModality, setVisible

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

ts

static final TranslationService ts

TranslationService object for handling string localization in the Ganymede server.

ok

static final java.lang.String ok

cancel

static final java.lang.String cancel

resource

DialogRsrc resource

componentHash

java.util.Hashtable componentHash

valueHash

java.util.Hashtable valueHash

done

boolean done

imageCanvas

javax.swing.JLabel imageCanvas

OKButton

javax.swing.JButton OKButton

CancelButton

javax.swing.JButton CancelButton

panel

javax.swing.JPanel panel

mainPanel

javax.swing.JPanel mainPanel

dataPanel

javax.swing.JPanel dataPanel

buttonPanel

javax.swing.JPanel buttonPanel

textLabel

JMultiLineLabel textLabel

gbl

java.awt.GridBagLayout gbl

compgbl

java.awt.GridBagLayout compgbl

gbc

java.awt.GridBagConstraints gbc

compgbc

java.awt.GridBagConstraints compgbc

image

java.awt.Image image

objects

java.util.Vector objects

components

java.util.Vector components

Constructor Detail

StringDialog

public StringDialog(java.awt.Frame frame,
            java.lang.String Title,
            java.lang.String Text,
            boolean ShowCancel,
            StandardDialog.ModalityType modality)

Simple constructor for a small dialog box

Parameters:

frame - Parent frame of the Dialog Box

Title - Title of the Dialog Box

Text - Text shown in the Dialog Box

ShowCancel - if true, show a "Cancel" button

StringDialog

public StringDialog(java.awt.Frame frame,
            java.lang.String Title,
            java.lang.String Text,
            StandardDialog.ModalityType modality)

Simple constructor for a small dialog box with a Cancel button

Parameters:

frame - Parent frame of the Dialog Box

Title - Title of the Dialog Box

Text - Text shown in the Dialog Box

StringDialog

public StringDialog(java.awt.Frame frame,
            java.lang.String Title,
            java.lang.String Text,
            java.lang.String OK,
            java.lang.String Cancel,
            StandardDialog.ModalityType modality)

Simple constructor for a small dialog box

Parameters:

frame - Parent frame of the Dialog Box

Title - Title of the Dialog Box

Text - Text shown in the Dialog Box

OK - String for "OK" button

Cancel - String for "Cancel" button

StringDialog

public StringDialog(java.awt.Frame frame,
            java.lang.String Title,
            java.lang.String Text,
            java.lang.String OK,
            java.lang.String Cancel,
            java.awt.Image image,
            StandardDialog.ModalityType modality)

Simple constructor for a small dialog box

Parameters:

frame - Parent frame of the Dialog Box

Title - Title of the Dialog Box

Text - Text shown in the Dialog Box

OK - String for "OK" button

Cancel - String for "Cancel" button

image - Image to display next to text

StringDialog

public StringDialog(DialogRsrc Resource,
            StandardDialog.ModalityType modality)

Constructor for more complicated StringDialog.

Parameters:

Resource - Sets resource for Dialog box.

Method Detail

getDefaultOk

public static java.lang.String getDefaultOk()

Returns the localized Ok string for the language used by the client's Java environment.

getDefaultCancel

public static java.lang.String getDefaultCancel()

Returns the localized Cancel string for the language used by the client's Java environment.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class java.awt.Container

create

private void create()

createElementPanel

private javax.swing.JPanel createElementPanel()

registerCallbacks

protected void registerCallbacks()

We want to make it so that when the user hits enter on the last string or password field in the dialog, the ok button is clicked.

setWrapLength

public void setWrapLength(int wrapLength)

Set the word wrap length of the main text area in this StringDialog.

setFont

public void setFont(java.awt.Font font)

Overrides:

setFont in class java.awt.Container

showDialog

public java.util.Hashtable showDialog()

Display the dialog box, locks this thread while the dialog is being displayed, and returns a hashtable of data field values when the user closes the dialog box.

Use this instead of Dialog.show(). If Hashtable returned is null, then the cancel button was clicked. Otherwise, it will contain a hash of labels(String) to results (Object).

Returns:

HashTable of labels to values

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Handle the ok and cancel buttons.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

loadValueHash

private void loadValueHash()

This method is responsible for scanning all of the input fields in this dialog and loading their values into valueHash for showDialog() to return.

addRow

private final void addRow(javax.swing.JPanel parent,
          javax.swing.JComponent comp,
          java.lang.String label,
          int row)

Convenience method to add a GUI component to this dialog.

windowActivated

public void windowActivated(java.awt.event.WindowEvent event)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent event)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent event)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent event)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent event)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent event)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent event)

Specified by:

windowOpened in interface java.awt.event.WindowListener