com.levigo.util.swing.messaging
Class MessageEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.levigo.util.swing.messaging.MessageEvent

All Implemented Interfaces:

Serializable

public class MessageEvent
extends AWTEvent

A semantic event which indicates that a message should be forwarded to user.

This high-level event is generated by a MessageManager, if the MessageManager recognizes that something happens which is in possible user interest The event is passed to every MessageListener object that registered to receive such events using the MessageManger's addMessageListener method.

The object that implements the MessageListener interface gets this MessageEvent when the event occurs. The listener is therefore spared the details of what, why, how is happening, and can instead process a "meaningful" (semantic) event, e.g. can present the message in the actual wishful environment.

Author:

Carolin Koehler

See Also:

Serialized Form

Field Summary

static int

ID

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

MessageEvent(Object source, Message aMessage)
Constructor for MessageEvent.

Method Summary

int	getID()
Message	getMessage() Returns the Message Object to be displayed.
MessageResult	getMessageResult() Returns the resultOfMessage.
String	toString()

Methods inherited from class java.awt.AWTEvent

consume, isConsumed, paramString, setSource

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final int ID

See Also:

Constant Field Values

Constructor Detail

MessageEvent

public MessageEvent(Object source,
                    Message aMessage)

Constructor for MessageEvent.

Parameters:

source -

aMessage -

Method Detail

getMessage

public Message getMessage()

Returns the Message Object to be displayed.

Returns:

Message

getMessageResult

public MessageResult getMessageResult()

Returns the resultOfMessage.

Returns:

MessageResult

getID

public int getID()

Overrides:

getID in class AWTEvent

See Also:

AWTEvent.getID()

toString

public String toString()

Overrides:

toString in class AWTEvent