com.physpics.tools

Class Message

java.lang.Object

com.physpics.tools.Message

public class Message
extends java.lang.Object

Static methods for reporting errors. By default Message opens a window displaying the scroll of messages. The client may call getMsgScroll() and add the result as a component of some other window. The Messages window will be closed automatically. If an application wants to show a message and exit, it should not call System.exit(). Instead it should simply return from the main method. The Messages window will remain visible until specifically closed by the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.ShowStream Text written to a ShowStream is passed to the show method when a newline is encountered or a flush occurs.

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.text.Highlighter.HighlightPainter	bluePainter
static boolean	DEBUG If on, programmer errors are printed.
static javax.swing.text.Highlighter.HighlightPainter	greenPainter
static javax.swing.text.Highlighter.HighlightPainter	pinkPainter

Method Summary

Modifier and Type	Method and Description
static void	beep() Ring the bell at the terminal.
static void	beep(java.lang.String msg) Ring the bell and display an error message.
static javax.swing.JSplitPane	createSplitPane(javax.swing.JComponent top) Create a JSplitPane with the messages in the bottom.
static void	deferExit(java.lang.String title, java.lang.Object[] message, int status) Raise a dialog box With a button to close the application.
static void	exception(java.lang.String msg, java.lang.Throwable ex) Ring the bell and display an exception message prefixed with "EXCEPTION".
static void	exitWhenClosed(int finalStatus) Exit the application when the Message window is closed.
static void	fileException(java.lang.String msg, IOException ex) Identical to the exception method
static int	getLineHeight()
static javax.swing.JScrollPane	getMsgScroll()
static javax.swing.JFrame	getMsgWindow() Report the message window.
static int	getStdoutState()
static java.lang.String	getText()
static void	ignoreException(java.lang.Exception ex) An exception has occurred and is being ignored.
static void	ignoreFileException(java.lang.String msg, java.lang.String fileName) Tell the user there was a file error, but execution is continuing.
static void	impossible(java.lang.String msg) Print a message on System.out.
static void	programmerError(java.lang.String msg) Ring the bell and display an error message prefixed with "Programmer error".
static void	prompt(java.lang.String msg) Show a message for a short time or until another message replaces it.
static void	setBounds(int x, int y, int w, int h)
static void	setBounds(java.awt.Rectangle b)
static void	setFont(java.awt.Font f) Set the font for displaying messages.
static void	setStdoutState(int newState) Set the System.out and System.err destinations.
static void	show(java.lang.String msg)
static void	show(java.lang.String msg, javax.swing.text.Highlighter.HighlightPainter color) Display a message to output, a window, or a message line.
static void	show(java.lang.String msg, int option)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

If on, programmer errors are printed. Default is off.

See Also:

Constant Field Values

pinkPainter

public static final javax.swing.text.Highlighter.HighlightPainter pinkPainter

greenPainter

public static final javax.swing.text.Highlighter.HighlightPainter greenPainter

bluePainter

public static final javax.swing.text.Highlighter.HighlightPainter bluePainter

Method Detail

getLineHeight

public static int getLineHeight()

setBounds

public static void setBounds(java.awt.Rectangle b)

setBounds

public static void setBounds(int x,
                             int y,
                             int w,
                             int h)

getMsgScroll

public static javax.swing.JScrollPane getMsgScroll()

Returns:

the JScrollPane that wraps the msg area. This object is prepared to be added to any container. When added, the Message window is closed. If later removed, the Message window will be reopened when a message is next sent. If you absolutely must add a mouse listener to the message area, the proper invocation is Message.getMsgScroll().getViewport().getView().addMouseListener(...)

getMsgWindow

public static javax.swing.JFrame getMsgWindow()

Report the message window. The message window appears for messages when msgScroll has not been added to a Container. Client may set icons on the message window. This method has the side-effect of creating the message window if it did not exist. Closing the message window disposes its resources, but does not terminate the application. Presumably Message is invoked from an application and that application will terminate execution. If the message window is closed and another message arrives, a new window is created.

Returns:

The JFrame for the message window.

setFont

public static void setFont(java.awt.Font f)

Set the font for displaying messages. All messages, past and future, are displayed in this font.

Parameters:

f - The new Font

getText

public static java.lang.String getText()

Returns:

the entire contents of the message area.

exitWhenClosed

public static void exitWhenClosed(int finalStatus)

Exit the application when the Message window is closed. The status passed to System.exit is specified when called. In order to set the status, a main thread should call this method as its last act.

Parameters:

finalStatus - Status value to nbe passed to System.exit

createSplitPane

public static javax.swing.JSplitPane createSplitPane(javax.swing.JComponent top)

Create a JSplitPane with the messages in the bottom.

Parameters:

top - What component to display above the message area

Returns:

a JSplitPane wrapping top and the message line.

getStdoutState

public static int getStdoutState()

Returns:

the stdoutState

setStdoutState

public static void setStdoutState(int newState)

Set the System.out and System.err destinations. 0 = stdout is separate 1 = Message is sending messages to stdout 2 = stdout is being redirected to Messages

Parameters:

newState - the stdoutState to set

show

public static void show(java.lang.String msg)

show

public static void show(java.lang.String msg,
                        int option)

show

public static void show(java.lang.String msg,
                        javax.swing.text.Highlighter.HighlightPainter color)

Display a message to output, a window, or a message line. Is synchronized so it can be called from multiple threads.

Parameters:

msg - The text of the message.

color - Color of message as a Highlighter.HighlightPainter. Should usually be greenPainter or pinkPainter.

prompt

public static void prompt(java.lang.String msg)

Show a message for a short time or until another message replaces it. The message does NOT remain in the log.

Parameters:

msg - The message to display.

beep

public static void beep()

Ring the bell at the terminal.

beep

public static void beep(java.lang.String msg)

Ring the bell and display an error message. It will be displayed with an error color background.

Parameters:

msg - The message to display in the log.

programmerError

public static void programmerError(java.lang.String msg)

Ring the bell and display an error message prefixed with "Programmer error". This tells the user that it not hisr fault. The message is displayed with an error color background.

Parameters:

msg - The message to display in the log.

exception

public static void exception(java.lang.String msg,
                             java.lang.Throwable ex)

Ring the bell and display an exception message prefixed with "EXCEPTION". This suggests to the user that it not hisr fault. The message is displayed with an error color background.

Parameters:

msg - The message to display in the log.

ex - The exception.

fileException

public static void fileException(java.lang.String msg,
                                 IOException ex)

Identical to the exception method

Parameters:

msg - message to identify source of error

ex - should be an IOException

ignoreFileException

public static void ignoreFileException(java.lang.String msg,
                                       java.lang.String fileName)

Tell the user there was a file error, but execution is continuing.

Parameters:

msg - printed in parentheses after the file name.

fileName - name of the file in error

ignoreException

public static void ignoreException(java.lang.Exception ex)

An exception has occurred and is being ignored. By turning on DEBUG, the programmer will see these messages.

Parameters:

ex - the exception being ignored.

impossible

public static void impossible(java.lang.String msg)

Print a message on System.out. This method should be called at all program points that supposedly cannot be reached. It can be useful to set a breakpoint here.

Parameters:

msg - text describing the point of failure. Should at least identify package, class, and method where the failure occurred.

deferExit

public static void deferExit(java.lang.String title,
                             java.lang.Object[] message,
                             int status)

Raise a dialog box With a button to close the application. This gives the user an opportunity to review the Message window before quitting.

Parameters:

title - title for the dialog box

message - an array of (usually) Strings to be displayed in the body of the dialog box.

status - The status code to be provided to Sysem.exit.