xal.tools.database

Class ConnectionDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

xal.tools.database.ConnectionDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ConnectionDialog
extends javax.swing.JDialog

ConnectionDialog displays a dialog allowing the user to supply the database URL, their user ID and their password. A connection dictionary is returned to the user based on their input.

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

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 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

Modifier	Constructor and Description
protected	ConnectionDialog(java.awt.Dialog owner) Constructor with the default submit button label and an empty connection dictionary.
protected	ConnectionDialog(java.awt.Dialog owner, ConnectionDictionary dictionary) Constructor with a default submit button label of "Connect".
protected	ConnectionDialog(java.awt.Dialog owner, ConnectionDictionary dictionary, java.lang.String submitLabel) Primary Constructor
protected	ConnectionDialog(java.awt.Frame owner) Constructor with the default submit button label and an empty connection dictionary.
protected	ConnectionDialog(java.awt.Frame owner, ConnectionDictionary dictionary) Constructor with a default submit button label of "Connect".
protected	ConnectionDialog(java.awt.Frame owner, ConnectionDictionary dictionary, java.lang.String submitLabel) Primary Constructor

Method Summary

Modifier and Type	Method and Description
ConnectionDictionary	getConnectionDictionary() Get the connection user's dictionary.
static ConnectionDialog	getInstance(java.awt.Dialog owner, ConnectionDictionary dictionary) Get a new instance of the connection dialog.
static ConnectionDialog	getInstance(java.awt.Frame owner, ConnectionDictionary dictionary) Get a new instance of the connection dialog.
void	loadDictionary(ConnectionDictionary dictionary) Load the specified connection dictionary.
protected void	makeContent() Make the Dialog content
protected void	setup(ConnectionDictionary dictionary) Common initialization.
java.sql.Connection	showConnectionDialog(DatabaseAdaptor databaseAdaptor) Attempt to connect to the database using the supplied database adaptor and the connection dictionary specified by the user via the dialog box.
static java.sql.Connection	showConnectionDialog(java.awt.Frame owner, DatabaseAdaptor databaseAdaptor) Display the dialog and return the connection dictionary.
static java.sql.Connection	showConnectionDialog(java.awt.Frame owner, DatabaseAdaptor databaseAdaptor, ConnectionDictionary dictionary) Display the dialog and return the connection dictionary.
protected ConnectionDictionary	showDialog() Show the connection dialog
static ConnectionDictionary	showDialog(java.awt.Frame owner) Display the dialog and return the connection dictionary.
static ConnectionDictionary	showDialog(java.awt.Frame owner, ConnectionDictionary dictionary) Display the dialog and return the connection dictionary.
static ConnectionDictionary	showDialog(java.awt.Frame owner, ConnectionDictionary dictionary, java.lang.String submitLabel) Display the dialog and return the connection dictionary.

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, setVisible, 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, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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

Constructor Detail

ConnectionDialog

protected ConnectionDialog(java.awt.Frame owner,
                           ConnectionDictionary dictionary,
                           java.lang.String submitLabel)

Primary Constructor

Parameters:

owner - The frame which owns this dialog window.

dictionary - The initial connection dictionary.

submitLabel - The label to use for the submit button.

ConnectionDialog

protected ConnectionDialog(java.awt.Frame owner,
                           ConnectionDictionary dictionary)

Constructor with a default submit button label of "Connect".

Parameters:

owner - The frame which owns this dialog window.

dictionary - The initial connection dictionary.

ConnectionDialog

protected ConnectionDialog(java.awt.Frame owner)

Constructor with the default submit button label and an empty connection dictionary.

Parameters:

owner - The frame which owns this dialog window.

ConnectionDialog

protected ConnectionDialog(java.awt.Dialog owner,
                           ConnectionDictionary dictionary,
                           java.lang.String submitLabel)

Primary Constructor

Parameters:

owner - The dialog which owns this dialog window.

dictionary - The initial connection dictionary.

submitLabel - The label to use for the submit button.

ConnectionDialog

protected ConnectionDialog(java.awt.Dialog owner,
                           ConnectionDictionary dictionary)

Constructor with a default submit button label of "Connect".

Parameters:

owner - The dialog which owns this dialog window.

dictionary - The initial connection dictionary.

ConnectionDialog

protected ConnectionDialog(java.awt.Dialog owner)

Constructor with the default submit button label and an empty connection dictionary.

Parameters:

owner - The dialog which owns this dialog window.

Method Detail

setup

protected void setup(ConnectionDictionary dictionary)

Common initialization.

Parameters:

dictionary - The initial connection dictionary.

loadDictionary

public void loadDictionary(ConnectionDictionary dictionary)

Load the specified connection dictionary.

Parameters:

dictionary - the connection dictionary to load

getConnectionDictionary

public ConnectionDictionary getConnectionDictionary()

Get the connection user's dictionary.

Returns:

the user's connection dictionary

showDialog

protected ConnectionDictionary showDialog()

Show the connection dialog

Returns:

The connection dictionary based on user input

showConnectionDialog

public java.sql.Connection showConnectionDialog(DatabaseAdaptor databaseAdaptor)

Attempt to connect to the database using the supplied database adaptor and the connection dictionary specified by the user via the dialog box.

Parameters:

databaseAdaptor - the database adaptor to use for the connection

Returns:

the new connection or null if the user canceled the dialog

showDialog

public static ConnectionDictionary showDialog(java.awt.Frame owner)

Display the dialog and return the connection dictionary.

Parameters:

owner - The window that owns dialog box

Returns:

The connection dictionary based on user input

showDialog

public static ConnectionDictionary showDialog(java.awt.Frame owner,
                                              ConnectionDictionary dictionary)

Display the dialog and return the connection dictionary. Initialize the new connection dictionary with the supplied one except that we ignore the password.

Parameters:

owner - The window that owns dialog box

dictionary - The dictionary from which to initialize the new connection dictionary

Returns:

The connection dictionary based on user input

showDialog

public static ConnectionDictionary showDialog(java.awt.Frame owner,
                                              ConnectionDictionary dictionary,
                                              java.lang.String submitLabel)

Display the dialog and return the connection dictionary. Initialize the new connection dictionary with the supplied one except that we ignore the password.

Parameters:

owner - The window that owns dialog box

dictionary - The dictionary from which to initialize the new connection dictionary

submitLabel - The label to use for the submit button

Returns:

The connection dictionary based on user input

showConnectionDialog

public static java.sql.Connection showConnectionDialog(java.awt.Frame owner,
                                                       DatabaseAdaptor databaseAdaptor,
                                                       ConnectionDictionary dictionary)

Display the dialog and return the connection dictionary. Initialize the new connection dictionary with the supplied one except that we ignore the password.

Parameters:

owner - The window that owns dialog box

databaseAdaptor - The database adaptor to use to make the connection

dictionary - The connection dictionary from which to initialize the new connection dictionary

Returns:

The connection dictionary based on user input

showConnectionDialog

public static java.sql.Connection showConnectionDialog(java.awt.Frame owner,
                                                       DatabaseAdaptor databaseAdaptor)

Display the dialog and return the connection dictionary. Start with an empty connection dictionary.

Parameters:

owner - The window that owns dialog box

databaseAdaptor - The database adaptor to use to make the connection

Returns:

The connection dictionary based on user input

getInstance

public static ConnectionDialog getInstance(java.awt.Frame owner,
                                           ConnectionDictionary dictionary)

Get a new instance of the connection dialog.

Parameters:

owner - The window that owns the new connection dialog box

dictionary - The connection dictionary from which to initialize the new connection dictionary

Returns:

A new instance of the connection dialog

getInstance

public static ConnectionDialog getInstance(java.awt.Dialog owner,
                                           ConnectionDictionary dictionary)

Get a new instance of the connection dialog.

Parameters:

owner - The window that owns the new connection dialog box

dictionary - The connection dictionary from which to initialize the new connection dictionary

Returns:

A new instance of the connection dialog

makeContent

protected void makeContent()

Make the Dialog content