com.dlsc.flexgantt.swing
Class TreePathMessage

java.lang.Object
  extended by com.dlsc.flexgantt.swing.Message
      extended by com.dlsc.flexgantt.swing.TreePathMessage
All Implemented Interfaces:
IMessage, ITreePathMessage

public class TreePathMessage
extends Message
implements ITreePathMessage

A tree path message is used when the cause of the message is a node in the tree table on the left-hand side of the Gantt chart. The addition of the path information allows the user interface to take the user to the message source.

Since:
1.0
Author:
Dirk Lemmermann
See Also:
Message, TimelineObjectPathMessage

Constructor Summary
TreePathMessage(MessageTypeId id, java.lang.String text, java.util.Date time, javax.swing.tree.TreePath path)
          Constructs a new message.
TreePathMessage(MessageTypeId id, java.lang.String text, java.lang.Object details, java.util.Date time, javax.swing.tree.TreePath path)
          Constructs a new message.
TreePathMessage(MessageTypeId id, java.lang.String text, java.lang.Object details, javax.swing.tree.TreePath path)
          Constructs a new message.
TreePathMessage(MessageTypeId id, java.lang.String text, javax.swing.tree.TreePath path)
          Constructs a new message.
TreePathMessage(java.lang.String text, java.lang.Object details, javax.swing.tree.TreePath path)
          Constructs a new error message.
TreePathMessage(java.lang.String text, javax.swing.tree.TreePath path)
          Constructs a new information message.
 
Method Summary
 javax.swing.tree.TreePath getTreePath()
          Returns the tree path associated with the message.
 
Methods inherited from class com.dlsc.flexgantt.swing.Message
getMessageDetails, getMessageText, getMessageTime, getMessageTypeId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.dlsc.flexgantt.swing.IMessage
getMessageDetails, getMessageText, getMessageTime, getMessageTypeId
 

Constructor Detail

TreePathMessage

public TreePathMessage(MessageTypeId id,
                       java.lang.String text,
                       java.lang.Object details,
                       java.util.Date time,
                       javax.swing.tree.TreePath path)
Constructs a new message.

Parameters:
id - a message type identifier used to distinguish between plain information messages or warning and error messages
text - the message that will be shown to the user
details - an object storing additional information about the cause of the message
time - a message time stamp
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage

TreePathMessage

public TreePathMessage(MessageTypeId id,
                       java.lang.String text,
                       java.util.Date time,
                       javax.swing.tree.TreePath path)
Constructs a new message.

Parameters:
id - a message type identifier used to distinguish between plain information messages or warning and error messages
text - the message that will be shown to the user
time - a message time stamp
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage

TreePathMessage

public TreePathMessage(MessageTypeId id,
                       java.lang.String text,
                       java.lang.Object details,
                       javax.swing.tree.TreePath path)
Constructs a new message.

Parameters:
id - a message type identifier used to distinguish between plain information messages or warning and error messages
text - the message that will be shown to the user
details - an object storing additional information about the cause of the message
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage

TreePathMessage

public TreePathMessage(MessageTypeId id,
                       java.lang.String text,
                       javax.swing.tree.TreePath path)
Constructs a new message.

Parameters:
id - a message type identifier used to distinguish between plain information messages or warning and error messages
text - the message that will be shown to the user
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage

TreePathMessage

public TreePathMessage(java.lang.String text,
                       java.lang.Object details,
                       javax.swing.tree.TreePath path)
Constructs a new error message.

Parameters:
text - the message that will be shown to the user
details - an object storing additional information about the cause of the message
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage

TreePathMessage

public TreePathMessage(java.lang.String text,
                       javax.swing.tree.TreePath path)
Constructs a new information message.

Parameters:
text - the message that will be shown to the user
path - a tree path pointing to the source of the message
Since:
1.0
See Also:
Message, TimelineObjectPathMessage
Method Detail

getTreePath

public javax.swing.tree.TreePath getTreePath()
Description copied from interface: ITreePathMessage
Returns the tree path associated with the message. The path allows the use interface to direct the user to the source of the message or to the object described/referenced in the message.

Specified by:
getTreePath in interface ITreePathMessage
Returns:
the message tree path