kiwi.ui.dialog
Class KDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--kiwi.ui.dialog.KDialog
Direct Known Subclasses:
ComponentDialog, ProgressDialog, WizardDialog

public class KDialog
extends JDialog

KDialog is a trivial extension of JDialog that provides support for tiling the background of the dialog with an image and for firing dismissal events.

KDialog introduces the notion of a cancelled dialog versus an accepted dialog. Collectively, these are known as dialog dismissals. A dialog may be cancelled by pressing a Cancel button or by closing the dialog window altogether. A dialog may be accepted by pressing an OK button or entering a value in one of the dialog's input components. It is ultimately up to the subclasser to determine what constitutes a dialog dismissal. The convenience method fireDialogDismissed() is provided to generate dialog dismissal events. See ComponentDialog for an example of this functionality.


An example KDialog.

Version:
1.1 (10/98)
Author:
Mark Lindner, PING Software Group
See Also:
KPanel, KFrame, ComponentDialog, DialogDismissEvent, Serialized Form

Inner classes inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
 
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
 
Constructor Summary
KDialog(Frame parent, String title, boolean modal)
          Construct a new KDialog.
 
Method Summary
 void addDialogDismissListener(DialogDismissListener listener)
          Add a DialogDismissListener to this dialog's list of listeners.
 void dispose()
          Finalization.
protected  void fireDialogDismissed(int type)
          Fire a dialog dismissed event.
protected  void fireDialogDismissed(int type, Object userObj)
          Fire a dialog dismissed event.
protected  KPanel getMainContainer()
          Get a reference to the main container (in this case, the KPanel that is the child of the frame's content pane).
 void removeDialogDismissListener(DialogDismissListener listener)
          Remove a DialogDismissListener from this dialog's list of listeners.
 void setTexture(Image image)
          Set the background image.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processWindowEvent, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, isModal, isResizable, setModal, setResizable, setTitle, show
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, 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, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, 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, hide, 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, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, 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
 

Constructor Detail

KDialog

public KDialog(Frame parent,
               String title,
               boolean modal)
Construct a new KDialog.
Parameters:
parent - The parent frame for this dialog.
title - The title for this dialog.
modal - A flag specifying whether this dialog should be modal.
Method Detail

getMainContainer

protected KPanel getMainContainer()
Get a reference to the main container (in this case, the KPanel that is the child of the frame's content pane).

setTexture

public void setTexture(Image image)
Set the background image. Sets the dialog's background image to image.

addDialogDismissListener

public void addDialogDismissListener(DialogDismissListener listener)
Add a DialogDismissListener to this dialog's list of listeners.
Parameters:
listener - The listener to add.
See Also:
removeDialogDismissListener(kiwi.event.DialogDismissListener)

removeDialogDismissListener

public void removeDialogDismissListener(DialogDismissListener listener)
Remove a DialogDismissListener from this dialog's list of listeners.
Parameters:
listener - The listener to remove.
See Also:
addDialogDismissListener(kiwi.event.DialogDismissListener)

fireDialogDismissed

protected void fireDialogDismissed(int type)
Fire a dialog dismissed event. Notifies listeners that this dialog is being dismissed.
Parameters:
type - The event type.

fireDialogDismissed

protected void fireDialogDismissed(int type,
                                   Object userObj)
Fire a dialog dismissed event. Notifies listeners that this dialog is being dismissed.
Parameters:
type - The event type.
userObj - An arbitrary user object argument to pass in the event.

dispose

public void dispose()
Finalization.
Overrides:
dispose in class Window