org.anc.ui

Class Dialogs

java.lang.Object

org.anc.ui.Dialogs

public class Dialogs
extends Object

The Dialogs class provides several shortcuts to the JOptionPane dialogs.

All of the methods in the Dialogs class are declared as static so the class never needs to be instantiated. However, the class also provides a getInstance method should an instance of the class ever be required.

Version:

1.0

Author:

Keith Suderman

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL The same value as JOptionPane.CANCEL_OPTION
static int	NO The same value as JOptionPane.NO_OPTION
static int	OK The same value as JOptionPane.OK_OPTION
static int	YES The same value as JOptionPane.YES_OPTION

Method Summary

Modifier and Type	Method and Description
static boolean	confirmBox(Component parent, Object message) Calls the three parameter version of this method with the title "Confirm".
static boolean	confirmBox(Component parent, Object message, String title) Displays a JOptionPane confirm dialog with the OK and CANCEL options.
static void	errorBox(Component parent, Exception ex)
static void	errorBox(Component parent, Object message) Calls the three parameter version of this method with the title "Error".
static void	errorBox(Component parent, Object message, String title) Displays a JOptionPane dialog of the type JOptionPane.ERROR_MESSAGE.
static Dialogs	getInstance() Returns an instance of the Dialogs class.
static String	inputBox(Component parent, Object message) Calls the three parameter version of this method with the title "Question"
static String	inputBox(Component parent, Object message, String title) Displays a JOptionPane input dialog and returns the string entered.
static String	inputBox(Component parent, Object message, String title, String defaultValue) Displays a JOptionPane input dialog and returns the string entered.
static JPanel	makePanel(String[] lines) Creates a panel containing a label for each string in lines.
static void	messageBox(Component parent, Object message) Calls the three parameter version of the method with the title "Message"
static void	messageBox(Component parent, Object message, String title) Displays a JOptionPane dialog with the type JOptionPane.INFORMATION_MESSAGE.
static int	promptBox(Component parent, Object message) Calls the three parameter version of this method with the title "Confirm".
static int	promptBox(Component parent, Object message, String title) Displays a JOptionPane confirm dialog with the YES and NO options.
static void	warningBox(Component parent, Object message) Calls the three parameter version of the method with the title "Warning".
static void	warningBox(Component parent, Object message, String title) Displays a JOptionPane dialog of the type JOptionPane.ERROR_MESSAGE.
static boolean	yesNo(Component parent, Object message) Displays a JOptionPane confirm dialog with YES and NO buttons.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OK

public static int OK

The same value as JOptionPane.OK_OPTION

CANCEL

public static int CANCEL

The same value as JOptionPane.CANCEL_OPTION

YES

public static int YES

The same value as JOptionPane.YES_OPTION

NO

public static int NO

The same value as JOptionPane.NO_OPTION

Method Detail

getInstance

public static Dialogs getInstance()

Returns an instance of the Dialogs class.

Since the Dialogs class is implemented as a singleton the same instance will always be returned.

Returns:

an instance of the Dialogs class

messageBox

public static void messageBox(Component parent,
                              Object message)

Calls the three parameter version of the method with the title "Message"

messageBox

public static void messageBox(Component parent,
                              Object message,
                              String title)

Displays a JOptionPane dialog with the type JOptionPane.INFORMATION_MESSAGE.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display the dialog.

errorBox

public static void errorBox(Component parent,
                            Object message)

Calls the three parameter version of this method with the title "Error".

errorBox

public static void errorBox(Component parent,
                            Object message,
                            String title)

Displays a JOptionPane dialog of the type JOptionPane.ERROR_MESSAGE.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

errorBox

public static void errorBox(Component parent,
                            Exception ex)

warningBox

public static void warningBox(Component parent,
                              Object message)

Calls the three parameter version of the method with the title "Warning".

warningBox

public static void warningBox(Component parent,
                              Object message,
                              String title)

Displays a JOptionPane dialog of the type JOptionPane.ERROR_MESSAGE.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

confirmBox

public static boolean confirmBox(Component parent,
                                 Object message)

Calls the three parameter version of this method with the title "Confirm".

confirmBox

public static boolean confirmBox(Component parent,
                                 Object message,
                                 String title)

Displays a JOptionPane confirm dialog with the OK and CANCEL options.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

yesNo

public static boolean yesNo(Component parent,
                            Object message)

Displays a JOptionPane confirm dialog with YES and NO buttons.

promptBox

public static int promptBox(Component parent,
                            Object message)

Calls the three parameter version of this method with the title "Confirm".

promptBox

public static int promptBox(Component parent,
                            Object message,
                            String title)

Displays a JOptionPane confirm dialog with the YES and NO options.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

Returns:

YES or NO depending on what the user selected.

inputBox

public static String inputBox(Component parent,
                              Object message)

Calls the three parameter version of this method with the title "Question"

inputBox

public static String inputBox(Component parent,
                              Object message,
                              String title)

Displays a JOptionPane input dialog and returns the string entered.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

Returns:

The string entered by the user.

inputBox

public static String inputBox(Component parent,
                              Object message,
                              String title,
                              String defaultValue)

Displays a JOptionPane input dialog and returns the string entered.

Parameters:

parent - The parent component of the dialog.

message - The message to display in the dialog.

title - The title to display in the dialog.

defaultValue - The initial value displayed in the dialog.

Returns:

The string entered by the user.

makePanel

public static JPanel makePanel(String[] lines)

Creates a panel containing a label for each string in lines.

The labels are arranged in a single column and the text is centered in each label.

Parameters:

lines - The text to use for each label.

Returns:

A JPanel object containing one JLabel object for each string in the array lines.