byucc.jhdl.apps.util
Class PropertiesDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      byucc.jhdl.apps.util.PropertiesDialog

All Implemented Interfaces:

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

public class PropertiesDialog

extends javax.swing.JDialog

implements java.awt.event.ActionListener

This class may be used by any component to help manage properties associated with the byucc.jhdl.apps.util.Properties class. It creates a dialog that allows the user to interactively set the values of specified properties.

Author:

Anthony L. Slade

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, 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.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

PropertiesDialog(java.awt.Frame owner, java.lang.String dialogName, java.lang.String dialogInformation)
Creates a new PropertiesDialog initially without any PropertiesDialogComponents.

PropertiesDialog(java.awt.Frame owner, java.lang.String dialogName, java.lang.String dialogInformation, CLInterpreter interpreter)
Creates a new PropertiesDialog initially without any PropertiesDialogComponents.

PropertiesDialog(java.awt.Frame owner, java.lang.String dialogName, java.lang.String dialogInformation, PropertiesDialogComponent[] properties)
Creates a new PropertiesDialog.

PropertiesDialog(java.awt.Frame owner, java.lang.String dialogName, java.lang.String dialogInformation, PropertiesDialogComponent[] properties, CLInterpreter interpreter)
Creates a new PropertiesDialog.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Implements the ActionListener interface.
void	addProperty(PropertiesDialogComponent property)
void	pack() performs a final build and pack of the dialog to prepare it for the show() method.
void	setInterpreter(CLInterpreter interpreter) sets up the Properties system and this dialog to use the given interpreter

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

Constructor Detail

PropertiesDialog

public PropertiesDialog(java.awt.Frame owner,
                        java.lang.String dialogName,
                        java.lang.String dialogInformation)

Creates a new PropertiesDialog initially without any PropertiesDialogComponents. The pack() and show() methods should be called after all of the PropertiesDialogComponents have been added to display the dialog.

Parameters:

owner - the dialog will be owned by the given Frame

dialogName - this will be the title of the dialog

dialogInformation - this will be the text of a label that displays information on the general purpose of this dialog

PropertiesDialog

public PropertiesDialog(java.awt.Frame owner,
                        java.lang.String dialogName,
                        java.lang.String dialogInformation,
                        CLInterpreter interpreter)

Creates a new PropertiesDialog initially without any PropertiesDialogComponents. The pack() and show() methods should be called after all of the PropertiesDialogComponents have been added to display the dialog.

Parameters:

owner - the dialog will be owned by the given Frame

dialogName - this will be the title of the dialog

dialogInformation - this will be the text of a label that displays information on the general purpose of this dialog

interpreter - property settings will go through this interpreter instead of directly through the Properties class. This makes it so that a settings history will be maintained

PropertiesDialog

public PropertiesDialog(java.awt.Frame owner,
                        java.lang.String dialogName,
                        java.lang.String dialogInformation,
                        PropertiesDialogComponent[] properties)

Creates a new PropertiesDialog. The pack() and show() methods should be called after all of the PropertiesDialogComponents have been added to display the dialog.

Parameters:

owner - the dialog will be owned by the given Frame

dialogName - this will be the title of the dialog

dialogInformation - this will be the text of a label that displays information on the general purpose of this dialog

properties - initial set of properties to add to the dialog

PropertiesDialog

public PropertiesDialog(java.awt.Frame owner,
                        java.lang.String dialogName,
                        java.lang.String dialogInformation,
                        PropertiesDialogComponent[] properties,
                        CLInterpreter interpreter)

Creates a new PropertiesDialog. The pack() and show() methods should be called after all of the PropertiesDialogComponents have been added to display the dialog.

Parameters:

owner - the dialog will be owned by the given Frame

dialogName - this will be the title of the dialog

dialogInformation - this will be the text of a label that displays information on the general purpose of this dialog

properties - initial set of properties to add to the dialog

interpreter - property settings will go through this interpreter instead of directly through the Properties class. This makes it so that a settings history will be maintained

Method Detail

actionPerformed

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

Implements the ActionListener interface. This listens to the OK, Cancel and help buttons.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - the event that came from a button on the dialog.

addProperty

public void addProperty(PropertiesDialogComponent property)

Parameters:

property - a new property to add to this dialog

pack

public void pack()

performs a final build and pack of the dialog to prepare it for the show() method.

setInterpreter

public void setInterpreter(CLInterpreter interpreter)

sets up the Properties system and this dialog to use the given interpreter

Parameters:

interpreter - the new interpreter to register