com.ca.commons.cbutil
Class CBDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.ca.commons.cbutil.CBDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

BookMarks, CBListSelector, CBOpenConWin, DeleteFilterGUI, GeneralizedTimeEditor, KeystoreGUI, KeystoreGUI.PasswordDialog, KeystoreOptions, LargeStringEditor, LdifExport, NewEntryWin, ReturnAttributesDialog, SearchGUI

public class CBDialog

extends javax.swing.JDialog

This utility class forms the basis of a generic 'pop up' dialog, that can either be extended, or used as is. It is basically a JDialog with built in 'OK', 'Cancel' and 'Help' buttons (the help pre-wired into CBHelpSystem), and a 'main display panel' that is a CBPanel (i.e. has a built in grid bag layout manager and utility methods).

If the class is being extended, 'ok' and 'cancel' behaviour can be modified by extending the 'doOK()' and 'doCancel()' methods, and extra components may be added in the extended constructor.

If the class is used as is, a new action listener may be added to the 'OK' button after removing the old action listener, and new components may be added directly to the internal CBPanel 'display' object.

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

protected javax.swing.JPanel	buttonPanel This pane contains the 'ok', 'cancel' and 'help' buttons.
javax.swing.JButton	Cancel
CBPanel	display This is the main display component.
javax.swing.JButton	Help
javax.swing.JButton	OK
protected java.awt.Frame	owner This is the parent Frame of the dialog

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

CBDialog(java.awt.Frame owner, java.lang.String title, java.lang.String helpLink)

Method Summary

java.awt.Component	add(java.awt.Component comp) Chaining method to internal CBPanel display object.
void	addln(java.awt.Component comp) Chaining method to internal CBPanel display object.
void	doCancel() When the user hits 'cancel', the window is shut down.
void	doOK() Default behaviour is the same as cancel.
void	escKeyCheck(java.awt.event.KeyEvent e) Checks if keyboard entry is an 'escape' key.
CBPanel	getDisplayPanel()
void	makeHeavy() Chaining method to internal CBPanel display object.
void	makeLight() Chaining method to internal CBPanel display object.
void	makeWide() Chaining method to internal CBPanel display object.
void	quit() Closes the window and disposes the gui.
void	setHelpLink(java.lang.String helpLink)
boolean	wasCancelled() Returns whether the dialog was cancelled.

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

OK

public javax.swing.JButton OK

Cancel

public javax.swing.JButton Cancel

Help

public javax.swing.JButton Help

display

public CBPanel display

This is the main display component. The display panel and the buttonPane are the two top level components shown.

owner

protected java.awt.Frame owner

This is the parent Frame of the dialog

buttonPanel

protected javax.swing.JPanel buttonPanel

This pane contains the 'ok', 'cancel' and 'help' buttons.

Constructor Detail

CBDialog

public CBDialog(java.awt.Frame owner,
                java.lang.String title,
                java.lang.String helpLink)

Method Detail

setHelpLink

public void setHelpLink(java.lang.String helpLink)

getDisplayPanel

public CBPanel getDisplayPanel()

add

public java.awt.Component add(java.awt.Component comp)

Chaining method to internal CBPanel display object. (@see com.ca.directory.util.CBPanel)

Overrides:

add in class java.awt.Container

addln

public void addln(java.awt.Component comp)

Chaining method to internal CBPanel display object. (@see com.ca.directory.util.CBPanel)

makeHeavy

public void makeHeavy()

Chaining method to internal CBPanel display object. (@see com.ca.directory.util.CBPanel)

makeLight

public void makeLight()

Chaining method to internal CBPanel display object. (@see com.ca.directory.util.CBPanel)

makeWide

public void makeWide()

Chaining method to internal CBPanel display object. (@see com.ca.directory.util.CBPanel)

escKeyCheck

public void escKeyCheck(java.awt.event.KeyEvent e)

Checks if keyboard entry is an 'escape' key. If so, dialog closes. Checks if keyboard entry is an 'enter' key. If so, fakes a click on the 'ok' button.

Parameters:

e - the key code to be checked ie '27' is the 'escape' key as '10' is the 'enter' key

doCancel

public void doCancel()

When the user hits 'cancel', the window is shut down.

wasCancelled

public boolean wasCancelled()

Returns whether the dialog was cancelled. (Useful after a 'show()' to discover if the user left in a huff.)

doOK

public void doOK()

Default behaviour is the same as cancel. Over-ride to give appropriate 'OK' behaviour.

quit

public void quit()

Closes the window and disposes the gui. Called by doOK() and doCancel().