kirk.gui.dialog
Class PopupDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  kirk.gui.dialog.PopupDialog

All Implemented Interfaces:

Accessible, ActionListener, EventListener, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

InputDialog, MessageDialog

public abstract class PopupDialog

extends Dialog

implements ActionListener

This class is an abstract class that other Dialogs can extend to save on standard behaviour, like closing the Window. Also provided is action listening for a Button with the "CLOSE" action command, so if you add a Button, set "CLOSE" as its action command and set this class as its ActionListener, then that Button will close the PopupDialog.

The idea is that subclasses define the look of the popup. This is why there are no settings done in this class about how the contents are layout out.

The constructor initialises some things for you:

• This class has no LayoutManager set
• It cannot be resized by the user
• It is modal
• It will appear in the middle of the screen
• It will be closed by a WindowCloser

It also implements ActionListener, and it already implements actionPerformed as well. However you can override it if you wish, and/or call it by using super() for the standard "CLOSE" button usage.

You can also close the dialog by calling close(). Useful for subclasses.

Since:

1.10

Version:

2.10

Author:

Berend Wouda

See Also:

Serialized Form

Nested Class Summary

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

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PopupDialog(Frame owner, String title)
Constructs a new PopupDialog.

Method Summary

void	actionPerformed(ActionEvent event) Closes this Dialog if the action command equals "CLOSE".
protected void	center() Centers the Dialog in the screen.
protected void	close() Closes this Dialog.
protected String[]	convertMessage(String message, int amount) Converts a message into a multiline format with amount characters on a line maximum, breaking lines on these delimiters: " \t\n\r\f".
void	doLayout() Lays out this Dialog.

Methods inherited from class java.awt.Dialog

addNotify, dispose, getAccessibleContext, getTitle, hide, isModal, isResizable, isUndecorated, paramString, 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, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, 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, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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

PopupDialog

public PopupDialog(Frame owner,
                   String title)

Constructs a new PopupDialog.

Parameters:

owner - The owner of this Dialog.

title - The title of this Dialog.

Method Detail

actionPerformed

public void actionPerformed(ActionEvent event)

Closes this Dialog if the action command equals "CLOSE".

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - The standard passed ActionEvent.

See Also:

ActionListener.actionPerformed(java.awt.event.ActionEvent)

close

protected void close()

Closes this Dialog.

doLayout

public void doLayout()

Lays out this Dialog. The actual laying out is done by a LayoutManager, but this method first sets the correct size of the window by using the preferred sizes of its components.

See Also:

Component.doLayout()

center

protected void center()

Centers the Dialog in the screen.

convertMessage

protected String[] convertMessage(String message,
                                  int amount)

Converts a message into a multiline format with amount characters on a line maximum, breaking lines on these delimiters: " \t\n\r\f". If there are undelimited tokens longer than amount characters they will occupy a single line.

This method is supplied for convenience, since many subclasses have use for it.

Parameters:

message - The message to convert.

amount - The maximum amount of characters on a line.

Returns:

The new message line by line in an array of Strings.