com.dlsc.flexgantt.swing
Interface IMessage

All Known Subinterfaces:

ITimelineObjectPathMessage, ITreePathMessage

All Known Implementing Classes:

Message, TimelineObjectPathMessage, TreePathMessage

public interface IMessage

A message can be added to a Gantt chart to display information, warnings or errors.

Since:

1.0

Author:

Dirk Lemmermann

See Also:

AbstractGanttChart.addMessage(IMessage), IMessageListener

Method Summary

java.lang.Object	getMessageDetails() Returns an object that contains some more details about the message.
java.lang.String	getMessageText() Returns the text that will be displayed to the user.
java.util.Date	getMessageTime() Returns the time stamp when the message occured.
MessageTypeId	getMessageTypeId() Returns the type of the message (information, warning, error).

Method Detail

getMessageTypeId

MessageTypeId getMessageTypeId()

Returns the type of the message (information, warning, error).

Returns:

the message type

Since:

1.0

getMessageText

java.lang.String getMessageText()

Returns the text that will be displayed to the user.

Returns:

the text of the message

Since:

1.0

getMessageDetails

java.lang.Object getMessageDetails()

Returns an object that contains some more details about the message. This could for example be a Throwable. The return type is this generic in order to support different kinds of detailed information in the future that can not be foreseen, yet.

Returns:

detailed information about the message

Since:

1.0

getMessageTime

java.util.Date getMessageTime()

Returns the time stamp when the message occured.

Returns:

the message's time stamp

Since:

1.0