net.java.sip.communicator.service.protocol.event
Class WhiteboardParticipantEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.protocol.event.WhiteboardParticipantEvent

All Implemented Interfaces:

Serializable

public class WhiteboardParticipantEvent
extends EventObject

WhiteboardParticipantEvents indicate that a participant in a whiteboard session has either left or entered the session.

Author:

Julien Waechter, Emil Ivov

See Also:

Serialized Form

Field Summary

static int	WHITEBOARD_PARTICIPANT_ADDED An event id value indicating that this event is about the fact that the source whiteboard participant has joined the source whiteboard.
static int	WHITEBOARD_PARTICIPANT_REMOVED An event id value indicating that this event is about the fact that the source whiteboard participant has left the source whiteboard.

Fields inherited from class java.util.EventObject

source

Constructor Summary

WhiteboardParticipantEvent(WhiteboardSession source, WhiteboardParticipant sourceWhiteboardParticipant, int eventID)
Creates a whiteboard participant event instance indicating that an event with id eventID has happened to sourceWhiteboardParticipant in sourceWhiteboard

Method Summary

int	getEventID() Returnst one of the WHITEBOARD_PARTICIPANT_XXX member ints indicating the type of this event.
WhiteboardSession	getSourceWhiteboard() Returns the whiteboard session that produced this event.
WhiteboardParticipant	getSourceWhiteboardParticipant() Returns the whiteboard participant that this event is about.
String	toString() Returns a String representation of this WhiteboardParticipantEvent.

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

WHITEBOARD_PARTICIPANT_ADDED

public static final int WHITEBOARD_PARTICIPANT_ADDED

An event id value indicating that this event is about the fact that the source whiteboard participant has joined the source whiteboard.

See Also:

Constant Field Values

WHITEBOARD_PARTICIPANT_REMOVED

public static final int WHITEBOARD_PARTICIPANT_REMOVED

An event id value indicating that this event is about the fact that the source whiteboard participant has left the source whiteboard.

See Also:

Constant Field Values

Constructor Detail

WhiteboardParticipantEvent

public WhiteboardParticipantEvent(WhiteboardSession source,
                                  WhiteboardParticipant sourceWhiteboardParticipant,
                                  int eventID)

Creates a whiteboard participant event instance indicating that an event with id eventID has happened to sourceWhiteboardParticipant in sourceWhiteboard

Parameters:

sourceWhiteboardParticipant - the whiteboard participant that this event is about.

source - the whiteboard that the source whiteboard participant is associated with.

eventID - one of the WHITEBOARD_PARTICIPANT_XXX member ints indicating the type of this event.

Method Detail

getEventID

public int getEventID()

Returnst one of the WHITEBOARD_PARTICIPANT_XXX member ints indicating the type of this event.

Returns:

one of the WHITEBOARD_PARTICIPANT_XXX member ints indicating the type of this event.

getSourceWhiteboard

public WhiteboardSession getSourceWhiteboard()

Returns the whiteboard session that produced this event.

Returns:

a reference to the WhiteboardSession that produced this event.

getSourceWhiteboardParticipant

public WhiteboardParticipant getSourceWhiteboardParticipant()

Returns the whiteboard participant that this event is about.

Returns:

a reference to the WhiteboardParticipant instance that triggered this event.

toString

public String toString()

Returns a String representation of this WhiteboardParticipantEvent.

Overrides:

toString in class EventObject

Returns:

a String representation of this WhiteboardParticipantEvent.