org.gjt.btools.gui.dialog
Class MessageBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.gjt.btools.gui.dialog.MessageBoxBase
                                      |
                                      +--org.gjt.btools.gui.dialog.MessageBox
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.lang.Runnable, java.io.Serializable, javax.swing.WindowConstants

public class MessageBox
extends MessageBoxBase

A message box for short messages. This message box uses a TextDisplayRegion to display its message.

The message should be short enough to fit in a small dialog without scrollbars. Multiple line messages are okay. Very long lines are also okay since they will be wrapped.

For very long messages that will require (vertical) scrollbars, consider using class LongMessageBox instead.

For ease of use, several static methods are provided: Methods bgNote(), fgNote() and confirm() all accept just a string message and parent window as arguments. An appropriate message box is automatically created and, if appropriate, the corresponding button pressed is returned.

See Also:
MessageBoxBase, LongMessageBox, Serialized Form

Field Summary
static int maxLineLength
          Maximum number of characters to be displayed on any single line.
 
Fields inherited from class org.gjt.btools.gui.dialog.MessageBoxBase
CANCEL, NO, OK, YES
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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 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
MessageBox(java.awt.Dialog parent, java.lang.String title, java.lang.String msg, int buttons)
          Creates a new message box with the given message and title, and containing the specified set of buttons.
MessageBox(java.awt.Frame parent, java.lang.String title, java.lang.String msg, int buttons)
          Creates a new message box with the given message and title, and containing the specified set of buttons.
 
Method Summary
static void bgNote(java.awt.Dialog parent, java.lang.String msg)
          Displays a message box with the given message and an OK button, allowing the parent window to continue receiving input as per normal.
static void bgNote(java.awt.Frame parent, java.lang.String msg)
          Displays a message box with the given message and an OK button, allowing the parent window to continue receiving input as per normal.
static boolean confirm(java.awt.Dialog parent, java.lang.String msg)
          Displays a message box with the given message and Yes/No buttons, blocking all input from the parent window until the message box is closed.
static boolean confirm(java.awt.Frame parent, java.lang.String msg)
          Displays a message box with the given message and Yes/No buttons, blocking all input from the parent window until the message box is closed.
static void fgNote(java.awt.Dialog parent, java.lang.String msg)
          Displays a message box with the given message and an OK button, blocking all input from the parent window until the message box is closed.
static void fgNote(java.awt.Frame parent, java.lang.String msg)
          Displays a message box with the given message and an OK button, blocking all input from the parent window until the message box is closed.
protected  java.awt.Component initInformationComponent(java.lang.String msg)
          Initialises the component containing the information to be presented (such as the message).
 
Methods inherited from class org.gjt.btools.gui.dialog.MessageBoxBase
actionPerformed, run, runBox, runBoxBg
 
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, 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

maxLineLength

public static final int maxLineLength
Maximum number of characters to be displayed on any single line.

See Also:
Constant Field Values
Constructor Detail

MessageBox

public MessageBox(java.awt.Frame parent,
                  java.lang.String title,
                  java.lang.String msg,
                  int buttons)
Creates a new message box with the given message and title, and containing the specified set of buttons. The buttons are specified by a bitwise OR-ing of the predefined constants YES, NO, OK, CANCEL.

Parameters:
parent - the parent window for the new dialog box.
title - the title of the message box
msg - the message to display in the message box.
buttons - the set of buttons to be displayed.

MessageBox

public MessageBox(java.awt.Dialog parent,
                  java.lang.String title,
                  java.lang.String msg,
                  int buttons)
Creates a new message box with the given message and title, and containing the specified set of buttons. The buttons are specified by a bitwise OR-ing of the predefined constants YES, NO, OK, CANCEL.

Parameters:
parent - the parent window for the new dialog box.
title - the title of the message box
msg - the message to display in the message box.
buttons - the set of buttons to be displayed.
Method Detail

bgNote

public static void bgNote(java.awt.Frame parent,
                          java.lang.String msg)
Displays a message box with the given message and an OK button, allowing the parent window to continue receiving input as per normal. This method displays the message box and returns immediately, without waiting for the user to press a button.

This method uses runBoxBg() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.

bgNote

public static void bgNote(java.awt.Dialog parent,
                          java.lang.String msg)
Displays a message box with the given message and an OK button, allowing the parent window to continue receiving input as per normal. This method displays the message box and returns immediately, without waiting for the user to press a button.

This method uses runBoxBg() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.

confirm

public static boolean confirm(java.awt.Frame parent,
                              java.lang.String msg)
Displays a message box with the given message and Yes/No buttons, blocking all input from the parent window until the message box is closed. This method does not return until a button is pressed and the message box is closed.

This method uses runBox() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.
Returns:
true if Yes was pressed; false if No was pressed.

confirm

public static boolean confirm(java.awt.Dialog parent,
                              java.lang.String msg)
Displays a message box with the given message and Yes/No buttons, blocking all input from the parent window until the message box is closed. This method does not return until a button is pressed and the message box is closed.

This method uses runBox() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.
Returns:
true if Yes was pressed; false if No was pressed.

fgNote

public static void fgNote(java.awt.Frame parent,
                          java.lang.String msg)
Displays a message box with the given message and an OK button, blocking all input from the parent window until the message box is closed. This method does not return until a button is pressed and the message box is closed.

This method uses runBox() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.

fgNote

public static void fgNote(java.awt.Dialog parent,
                          java.lang.String msg)
Displays a message box with the given message and an OK button, blocking all input from the parent window until the message box is closed. This method does not return until a button is pressed and the message box is closed.

This method uses runBox() to display its message box.

Parameters:
parent - the parent window for the new dialog box.
msg - the message to display in the message box.

initInformationComponent

protected java.awt.Component initInformationComponent(java.lang.String msg)
Description copied from class: MessageBoxBase
Initialises the component containing the information to be presented (such as the message). The buttons should not be included in this component.

Specified by:
initInformationComponent in class MessageBoxBase
Parameters:
msg - the message to be displayed.
Returns:
the newly initialised information component.


Copyright © 1998-2001, Ben Burton
This software is released under the GNU Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).