edu.neu.ccs.gui
Class JPTDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      edu.neu.ccs.gui.JPTDialog

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

Direct Known Subclasses:

InputDialog

public class JPTDialog

extends JDialog

Dialog box containing a TypedView and an ActionsPanel that contains actions that interact with the view.

Since:

1.0

Version:

2.2

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected ActionsPanel	actions The actions panel containing actions that interact with the view in this dialog.
protected TypedView	view The input view contained in this dialog.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

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

JPTDialog(TypedView viewObject)
Constructs an input dialog containing the given view but with no title or parent window.

JPTDialog(TypedView viewObject, String title)
Constructor for an input dialog containing the given view and the given title, but with no parent window.

JPTDialog(TypedView viewObject, String title, Dialog owner, boolean modal)
Constructor for an input dialog containing the given view, with the given title, parent dialog, and modality.

JPTDialog(TypedView viewObject, String title, Frame owner, boolean modal)
Constructor for an input dialog containing the given view, with the provided title, parent frame, and modality.

Method Summary

JButton	addAction(Action a) Adds the given action to the actions panel contained by this dialog.
JButton	addDefaultAction(Action action) Adds the given action to the actions panel contained by this dialog, as the default action for the dialog.
void	center() Centers this dialog on the user screen.
ActionsPanel	getActionsPanel() Returns the actions panel for this dialog.
TypedView	getTypedView() Returns the input component contained by this dialog.
private void	initialize(TypedView viewObject) Performs the common tasks required for constructors of this class.
void	setActionsPanel(ActionsPanel p) Sets the actions panel for this dialog to the provided actions panel.

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, dispose, 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, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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

view

protected TypedView view

The input view contained in this dialog.

actions

protected ActionsPanel actions

The actions panel containing actions that interact with the view in this dialog.

Constructor Detail

JPTDialog

public JPTDialog(TypedView viewObject)

Constructs an input dialog containing the given view but with no title or parent window.

Parameters:

viewObject - the input component to be used

Throws:

NullPointerException - if the given input component is null

See Also:

JPTDialog(TypedView, String), JPTDialog(TypedView, String, Dialog, boolean), JPTDialog(TypedView, String, Frame, boolean)

JPTDialog

public JPTDialog(TypedView viewObject,
                 String title)

Constructor for an input dialog containing the given view and the given title, but with no parent window.

Parameters:

viewObject - the input component to be used

title - the title text for this dialog

Throws:

NullPointerException - if the given input component is null

See Also:

JPTDialog(TypedView), JPTDialog(TypedView, String, Dialog, boolean), JPTDialog(TypedView, String, Frame, boolean)

JPTDialog

public JPTDialog(TypedView viewObject,
                 String title,
                 Dialog owner,
                 boolean modal)

Constructor for an input dialog containing the given view, with the given title, parent dialog, and modality.

Parameters:

viewObject - the input component to be used

title - the title text for this dialog

owner - the parent dialog for this dialog

modal - whether or not this dialog is modal

Throws:

NullPointerException - if the given input component is null

See Also:

JPTDialog(TypedView), JPTDialog(TypedView, String), JPTDialog(TypedView, String, Frame, boolean)

JPTDialog

public JPTDialog(TypedView viewObject,
                 String title,
                 Frame owner,
                 boolean modal)

Constructor for an input dialog containing the given view, with the provided title, parent frame, and modality.

Parameters:

viewObject - the input component to be used

title - the title text for this dialog

owner - the parent frame for this dialog

modal - whether or not this dialog is modal

Throws:

NullPointerException - if the given input component is null

See Also:

JPTDialog(TypedView), JPTDialog(TypedView, String), JPTDialog(TypedView, String, Dialog, boolean)

Method Detail

getTypedView

public TypedView getTypedView()

Returns the input component contained by this dialog.

addAction

public JButton addAction(Action a)

Adds the given action to the actions panel contained by this dialog. If the given action is null, no action is added to the actions panel, and the method returns null.

Parameters:

a - the action to be added

Returns:

the button created to initiate the action

See Also:

addDefaultAction(Action)

addDefaultAction

public JButton addDefaultAction(Action action)

Adds the given action to the actions panel contained by this dialog, as the default action for the dialog. If the given action is null, no action is added to the actions panel, and the method returns null. The given action replaces the current default action for the dialog, if one exists.

Parameters:

action - the action to be added

Returns:

the button created to initiate the action

See Also:

addAction(Action)

setActionsPanel

public void setActionsPanel(ActionsPanel p)

Sets the actions panel for this dialog to the provided actions panel. If the given actions panel is null, the current actions panel is not changed.

Parameters:

p - the new actions panel

See Also:

getActionsPanel()

getActionsPanel

public ActionsPanel getActionsPanel()

Returns the actions panel for this dialog.

See Also:

setActionsPanel(ActionsPanel)

center

public void center()

Centers this dialog on the user screen.

See Also:

Window.pack()

initialize

private void initialize(TypedView viewObject)

Performs the common tasks required for constructors of this class.

Parameters:

viewObject - the desired input view

Throws:

NullPointerException - if the given input component is null