at.mug.iqm.commons.util

Class DialogUtil

java.lang.Object

at.mug.iqm.commons.util.DialogUtil

All Implemented Interfaces:

IDialogUtil

public class DialogUtil
extends Object
implements IDialogUtil

This class constructs dialogs for user feedbacks and interactions. It uses JOptionPane as container.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	logger

Fields inherited from interface at.mug.iqm.api.gui.IDialogUtil

CANCEL_OPTION, CLOSED_OPTION, DEFAULT_OPTION, ERROR_MESSAGE, INFORMATION_MESSAGE, NO_OPTION, OK_CANCEL_OPTION, OK_OPTION, PLAIN_MESSAGE, QUESTION_MESSAGE, WARNING_MESSAGE, YES_NO_CANCEL_OPTION, YES_NO_OPTION, YES_OPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DialogUtil()

Method Summary

Modifier and Type	Method and Description
static IDialogUtil	getInstance() Returns the current instance of the DialogUtil object.
void	showDefaultErrorMessage(String errMessage) This method creates an instance of a JOptionPane used to inform the user about an error.
void	showDefaultInfoMessage(String infoMessage) This method creates an instance of a JOptionPane used to inform the user about something.
int	showDefaultQuestionMessage(String question) This method creates an instance of a JOptionPane when a user is questioned about something that requires interaction.
int	showDefaultWarnMessage(String warnMessage) This method creates an instance of a JOptionPane when a user is warned about something that requires interaction.
void	showErrorMessage(String errMessage, Exception exception) This method creates an instance of a JOptionPane used to inform the user about an exception.
void	showErrorMessage(String errMessage, Exception exception, boolean withStackTrace) This method creates an instance of a JOptionPane used to inform the user about an exception.
int	showQuestionMessage(Window parent, String question) This method creates an instance of a JOptionPane when a user is questioned about something that requires interaction.
int	showWarnMessage(Component window, String warnMessage, String title) This method creates an instance of a JOptionPane when a user is warned about something that requires interaction.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

DialogUtil

private DialogUtil()

Method Detail

getInstance

public static IDialogUtil getInstance()

Returns the current instance of the DialogUtil object. It creates a new instance, if none is present.

Returns:

the singleton instance

showDefaultInfoMessage

public void showDefaultInfoMessage(String infoMessage)

This method creates an instance of a JOptionPane used to inform the user about something.

Specified by:

showDefaultInfoMessage in interface IDialogUtil

Parameters:

infoMessage - - the message to be displayed

showDefaultWarnMessage

public int showDefaultWarnMessage(String warnMessage)

This method creates an instance of a JOptionPane when a user is warned about something that requires interaction.

Specified by:

showDefaultWarnMessage in interface IDialogUtil

Parameters:

warnMessage - - the message to be displayed

Returns:

an integer, indicating the selection of the user: YES, NO, CANCEL, CLOSED

showWarnMessage

public int showWarnMessage(Component window,
                           String warnMessage,
                           String title)

This method creates an instance of a JOptionPane when a user is warned about something that requires interaction.

Specified by:

showWarnMessage in interface IDialogUtil

Parameters:

window - a parent window, or null

warnMessage - the message to be displayed

title - the title of the message

Returns:

an integer, indicating the selection of the user: YES, NO, CANCEL, CLOSED

showDefaultErrorMessage

public void showDefaultErrorMessage(String errMessage)

This method creates an instance of a JOptionPane used to inform the user about an error.

Specified by:

showDefaultErrorMessage in interface IDialogUtil

Parameters:

errMessage - - the message to be displayed

showErrorMessage

public void showErrorMessage(String errMessage,
                             Exception exception,
                             boolean withStackTrace)

This method creates an instance of a JOptionPane used to inform the user about an exception.

Specified by:

showErrorMessage in interface IDialogUtil

Parameters:

errMessage - - the (additional) message to be displayed

exception - - the exception to be formatted

withStackTrace - - whether or not the stack trace should be shown in the dialog

showErrorMessage

public void showErrorMessage(String errMessage,
                             Exception exception)

This method creates an instance of a JOptionPane used to inform the user about an exception.

This is basically a wrapper method for showErrorMessage(String, Exception, boolean), turning off the printing of the stack trace to the ErrorMessagePanel.

Specified by:

showErrorMessage in interface IDialogUtil

Parameters:

errMessage - - the (additional) message to be displayed

exception - - the exception to be formatted

See Also:

showErrorMessage(String, Exception, boolean)

showDefaultQuestionMessage

public int showDefaultQuestionMessage(String question)

This method creates an instance of a JOptionPane when a user is questioned about something that requires interaction.

Specified by:

showDefaultQuestionMessage in interface IDialogUtil

Parameters:

question - - the question to be displayed

Returns:

an integer, indicating the selection of the user: YES, NO, CANCEL, CLOSED

showQuestionMessage

public int showQuestionMessage(Window parent,
                               String question)

This method creates an instance of a JOptionPane when a user is questioned about something that requires interaction.

Specified by:

showQuestionMessage in interface IDialogUtil

Parameters:

parent - - the parent window

question - - the question to be displayed

Returns:

an integer, indicating the selection of the user: YES, NO, CANCEL, CLOSED