net.sf.freecol.client.gui

Class ChatDisplay

java.lang.Object

net.sf.freecol.client.gui.ChatDisplay

public class ChatDisplay
extends java.lang.Object

ChatDisplay manages use of GUIMessage.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	MESSAGE_AGE The amount of time before a message gets deleted (in milliseconds).
private static int	MESSAGE_COUNT The number of messages getting remembered.
private java.util.ArrayList<GUIMessage>	messages

Constructor Summary

Constructors

Constructor and Description
ChatDisplay()

Method Summary

Modifier and Type	Method and Description
void	addMessage(GUIMessage message) Adds a message to the list of messages that need to be displayed on the GUI.
void	display(java.awt.Graphics2D g, ImageLibrary lib, java.awt.Dimension size) Displays the list of messages.
private GUIMessage	getMessage(int index) Gets the message at position 'index'.
private int	getMessageCount() Gets the amount of message that are currently being displayed on this GUI.
boolean	removeOldMessages() Removes all the message that are older than MESSAGE_AGE.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_COUNT

private static final int MESSAGE_COUNT

The number of messages getting remembered.

See Also:

Constant Field Values

MESSAGE_AGE

private static final int MESSAGE_AGE

The amount of time before a message gets deleted (in milliseconds).

See Also:

Constant Field Values

messages

private final java.util.ArrayList<GUIMessage> messages

Constructor Detail

ChatDisplay

ChatDisplay()

Method Detail

addMessage

public void addMessage(GUIMessage message)

Adds a message to the list of messages that need to be displayed on the GUI.

Parameters:

message - The message to add.

getMessage

private GUIMessage getMessage(int index)

Gets the message at position 'index'. The message at position 0 is the oldest message and is most likely to be removed during the next call of removeOldMessages(). The higher the index of a message, the more recently it was added.

Parameters:

index - The index of the message to return.

Returns:

The message at position 'index'.

getMessageCount

private int getMessageCount()

Gets the amount of message that are currently being displayed on this GUI.

Returns:

The amount of message that are currently being displayed on this GUI.

display

public void display(java.awt.Graphics2D g,
                    ImageLibrary lib,
                    java.awt.Dimension size)

Displays the list of messages.

Parameters:

g - The Graphics2D the messages should be displayed on.

lib - The imageLibrary to use.

size - The size of the space for displaying in.

removeOldMessages

public boolean removeOldMessages()

Removes all the message that are older than MESSAGE_AGE. This can be useful to see if it is necessary to refresh the screen.

Returns:

True if at least one message has been removed,