bill.util.gui
Class AddKeyValueFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--bill.util.gui.AddKeyValueFrame
All Implemented Interfaces:
Accessible, ActionListener, EventListener, HighlightInterface, ImageObserver, MenuContainer, RootPaneContainer, Serializable, ToolTipInterface, WindowConstants
Direct Known Subclasses:
AddConfigurationEntryFrame, AddConfigurationFileFrame, AddCSVFileFrame, CreateConfigurationFileFrame, CreateCSVFileFrame

public class AddKeyValueFrame
extends JFrame
implements ActionListener, ToolTipInterface, HighlightInterface

Class responsible for creating and updating a generic KeyValue object. It displays two text fields to the user, one for entering the "key", and one for entering the "value". Both entries are treated as String objects.

The information entered on this page is:
Key Value The "key" value the user specifies. required
Value Value The "value" value the user specifies. required

The push buttons are Add to OK the new definition, and Cancel to void the new definition.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
 
Inner classes inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
 
Inner classes inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Inner classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
Component.AccessibleAWTComponent
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
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, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AddKeyValueFrame(GUIUtilInterface parent, KeyValue object, String title, String keyTitle, String valueTitle)
          Alternate creator for the AddKeyValueFrame class.
AddKeyValueFrame(GUIUtilInterface parent, KeyValue object, String title, String keyTitle, String valueTitle, String keyTooltip, String valueTooltip)
          Main creator for the AddKeyValueFrame class.
 
Method Summary
 void actionPerformed(ActionEvent actionEvent)
          Processes actions made in the AddKeyValueFrame dialog (ie pressing push buttons).
 void displayHighlighting(boolean display)
          Turns required field highlighting on or off for this frame.
 void displayToolTips(boolean display)
          Turns tool tips on or off for this frame.
 KeyValue getObject()
          Getter for the object being manipulated by this frame.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, 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, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

AddKeyValueFrame

public AddKeyValueFrame(GUIUtilInterface parent,
                        KeyValue object,
                        String title,
                        String keyTitle,
                        String valueTitle,
                        String keyTooltip,
                        String valueTooltip)
Main creator for the AddKeyValueFrame class. Used to initialize class variables to the specified values and draw the window.
Parameters:
parent - The GUI interface that created us. Needed for a number of the method calls we will make.
object - The KeyValue object that we are manipulating.
title - The test to put in the dialog's title bar.
keyTitle - The title to put to the left of the entry field where the user will type the key' value.
valueTitle - The title to put to the left of the entry field where the user will type the value's value.
keyTooltip - The tooltip to display for the key's entry field.
valueTooltip - The tooltip to display for the value's entry field.

AddKeyValueFrame

public AddKeyValueFrame(GUIUtilInterface parent,
                        KeyValue object,
                        String title,
                        String keyTitle,
                        String valueTitle)
Alternate creator for the AddKeyValueFrame class. Used to initialize class variables to the specified values and draw the window.
Parameters:
parent - The GUI interface that created us. Needed for a number of the method calls we will make.
object - The KeyValue object that we are manipulating.
title - The test to put in the dialog's title bar.
keyTitle - The title to put to the left of the entry field where the user will type the key' value.
valueTitle - The title to put to the left of the entry field where the user will type the value's value.
Method Detail

displayHighlighting

public void displayHighlighting(boolean display)
Turns required field highlighting on or off for this frame.
Specified by:
displayHighlighting in interface HighlightInterface
Parameters:
display - Indicates if highlighting should be performed, true indicates to perform it, false indicates to not perform it.

getObject

public KeyValue getObject()
Getter for the object being manipulated by this frame.
Returns:
The object we are manipulating.

displayToolTips

public void displayToolTips(boolean display)
Turns tool tips on or off for this frame.
Specified by:
displayToolTips in interface ToolTipInterface
Parameters:
display - Indicates if tool tips should be displayed, true indicates to display them, false indicates to not display them.

actionPerformed

public void actionPerformed(ActionEvent actionEvent)
Processes actions made in the AddKeyValueFrame dialog (ie pressing push buttons).
Specified by:
actionPerformed in interface ActionListener
Parameters:
actionEvent - The action event to be processed.