com.lf.commons.gui

Class StatusBarMessage

java.lang.Object

com.lf.commons.gui.StatusBarMessage

public class StatusBarMessage
extends java.lang.Object

Simple data holding class represnting messages to be printed via status bar.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
StatusBarMessage() Constructor method for i18n purposes only.
StatusBarMessage(java.lang.String message, javax.swing.ImageIcon icon, int millis) Constructor settings the initial values.

Method Summary

Methods

Modifier and Type	Method and Description
static StatusBarMessage	createErrorMessage(java.lang.String message, int millis) Convenience method to get a pre-configured error message.
static StatusBarMessage	createInfoMessage(java.lang.String message, int millis) Convenience method to get a pre-configured info message.
static StatusBarMessage	createRunningMessage(java.lang.String message, int millis) Convenience method to get a pre-configured running message.
static StatusBarMessage	createWarningMessage(java.lang.String message, int millis) Convenience method to get a pre-configured warning message.
boolean	equals(StatusBarMessage tocheck) Checks wether a given StatusBarMessage instance is equal to this.
javax.swing.Icon	getIcon() Getter for icon.
java.lang.String	getMessage() Getter for message.
int	getMillis() Getter for duration in milliseconds.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusBarMessage

public StatusBarMessage()
                 throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

StatusBarMessage

public StatusBarMessage(java.lang.String message,
                javax.swing.ImageIcon icon,
                int millis)

Constructor settings the initial values.

Parameters:

message - The textual message (required)

icon - The graphical icon (optional, may be null)

millis - The duration of the display (optional, ignored if < 0)

Throws:

java.lang.NullPointerException - If the message is null

java.lang.IllegalArgumentException - If at least one of the parameters is invalid

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The identifer for the represented object or empty string

Since:

1.6

equals

public boolean equals(StatusBarMessage tocheck)

Checks wether a given StatusBarMessage instance is equal to this.

Parameters:

tocheck - The instance to be compared

Returns:

The StatusBarMessage instance to check for equality

Since:

1.6

getMessage

public java.lang.String getMessage()

Getter for message.

Returns:

The message

Since:

1.6

getIcon

public javax.swing.Icon getIcon()

Getter for icon.

Returns:

The icon

Since:

1.6

getMillis

public int getMillis()

Getter for duration in milliseconds.

Returns:

The duration

Since:

1.6

createInfoMessage

public static StatusBarMessage createInfoMessage(java.lang.String message,
                                 int millis)

Convenience method to get a pre-configured info message.

Parameters:

message - The textual message (required)

millis - The duration of the display (optional, ignored if < 0)

Returns:

Pre-defined info message

createWarningMessage

public static StatusBarMessage createWarningMessage(java.lang.String message,
                                    int millis)

Convenience method to get a pre-configured warning message.

Parameters:

message - The textual message (required)

millis - The duration of the display (optional, ignored if < 0)

Returns:

Pre-defined warning message

createErrorMessage

public static StatusBarMessage createErrorMessage(java.lang.String message,
                                  int millis)

Convenience method to get a pre-configured error message.

Parameters:

message - The textual message (required)

millis - The duration of the display (optional, ignored if < 0)

Returns:

Pre-defined error message

createRunningMessage

public static StatusBarMessage createRunningMessage(java.lang.String message,
                                    int millis)

Convenience method to get a pre-configured running message.

Parameters:

message - The textual message (required)

millis - The duration of the display (optional, ignored if < 0)

Returns:

Pre-defined running message