dlife.gui.connectiondialog
Class ConnectionDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      dlife.gui.connectiondialog.ConnectionDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class ConnectionDialog
extends JDialog

Display a dialog for obtaining the information necessary to create a connection to a robot, service or another computer.

Version:

November 1, 2010

Author:

Grant Braught, Dickinson College

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int	BLUETOOTH Constant indicating that the tab for establishing a bluetooth connection should be enabled.
static int	SERIALPORT Constant indicating that the tab for establishing a serial port connection should be enabled.
static int	SOCKET Constant indicating that the tab for establishing a socket connection should be enabled.

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

ConnectionDialog(String title, String datafile, int tabMask, String btNamePattern, String serialNamePattern)
Construct a new SerialConnectionDialog.

Method Summary

boolean	canceled() Returns true if the user canceled the dialog box.
String	getBluetoothAddress() Return the bluetooth address that was selected in the "Bluetooth" tab.
String	getSerialPortFile() Return the file that was selected in the "Serial Port" tab.
int	getSocketPort() Return the server port that was entered in the "Socket" tab.
String	getSocketServer() Return the server address (IP or domain name) that was entered in the "Socket" tab.
static void	main(String[] args) A main method to display the ConnectionDialog and allow the user to interact with it for testing purposes.

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, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

BLUETOOTH

public static final int BLUETOOTH

Constant indicating that the tab for establishing a bluetooth connection should be enabled. Constants should be bitwise or'ed to enable all desired tabs.

See Also:

Constant Field Values

SERIALPORT

public static final int SERIALPORT

Constant indicating that the tab for establishing a serial port connection should be enabled. Constants should be bitwise or'ed to enable all desired tabs.

See Also:

Constant Field Values

SOCKET

public static final int SOCKET

Constant indicating that the tab for establishing a socket connection should be enabled. Constants should be bitwise or'ed to enable all desired tabs.

See Also:

Constant Field Values

Constructor Detail

ConnectionDialog

public ConnectionDialog(String title,
                        String datafile,
                        int tabMask,
                        String btNamePattern,
                        String serialNamePattern)

Construct a new SerialConnectionDialog. The dialog will contain a tabbed pane with one tab for each type of connection that is enabled. Connection types are enabled by bitwise or'ing the appropriate class constants (e.g. BLUETOOTH, SERIALPORT).

Parameters:

title - the title to appear in the dialog.

datafile - the path and base name of the file where the dialog defaults should be saved. In practice several files are created by different components by appending different file extensions to the base name provided here.

tabMask - the bitwise or of the class constants that enable the connection types.

btNamePattern - a regular expression that is used to match the bluetooth friendly name. Only names that match this regular expression will be included in the available bluetooth devices. If the BLUETOOTH tab is not displayed this value is ignored.

serialNamePattern - a regular expression that is used to match the serial port device filename. Only names that match this regular expression will be able to be selected in the file chooser. If the SERIALPORT tab is not displayed this value is ignored.

Method Detail

canceled

public boolean canceled()

Returns true if the user canceled the dialog box.

Returns:

true if the user canceled the dialog.

getSerialPortFile

public String getSerialPortFile()

Return the file that was selected in the "Serial Port" tab. If the "Serial Port" tab was not active when the "Connect" button was clicked or the dialog was canceled this method will return null.

Returns:

the file selected in the "Serial Port" tab or null.

getSocketServer

public String getSocketServer()

Return the server address (IP or domain name) that was entered in the "Socket" tab. If the "Socket" tab was not active when the "Connect" button was clicked or the dialog was canceled this method will return null.

Returns:

the server address or null;

getSocketPort

public int getSocketPort()

Return the server port that was entered in the "Socket" tab. If the "Socket" tab was not active when the "Connect" button was clicked or the dialog was canceled this method will return -1.

Returns:

the server port or -1.

getBluetoothAddress

public String getBluetoothAddress()

Return the bluetooth address that was selected in the "Bluetooth" tab. If the "Bluetooth" tab was not active when the "Connect" button was clicked or the dialog was canceled this method will return null.

Returns:

the bluetooth address or null.

main

public static void main(String[] args)

A main method to display the ConnectionDialog and allow the user to interact with it for testing purposes. The result of the interaction is displayed on standard output.

Parameters:

args - none