org.jagatoo.input.events
Class MouseEvent

java.lang.Object
  extended by org.jagatoo.input.events.InputEvent
      extended by org.jagatoo.input.events.MouseEvent
Direct Known Subclasses:
MouseButtonEvent, MouseMovedEvent, MouseStoppedEvent, MouseWheelEvent

public abstract class MouseEvent
extends InputEvent

Stores the details associated with a mouse event.


Nested Class Summary
static class MouseEvent.SubType
           
 
Nested classes/interfaces inherited from class org.jagatoo.input.events.InputEvent
InputEvent.Type
 
Constructor Summary
protected MouseEvent(MouseEvent.SubType subType)
          Creates a MouseEvent with default values.
  MouseEvent(Mouse mouse, MouseEvent.SubType subType, DeviceComponent component, long when, long lastWhen)
          Sets the fields of this MouseEvent to match the given MouseEvent.
 
Method Summary
 Mouse getMouse()
          The MouseDevice, that caused the event.
 MouseEvent.SubType getSubType()
           
protected  void set(MouseEvent e)
          Sets the fields of this MouseEvent to match the given MouseEvent.
protected  void set(Mouse mouse, MouseEvent.SubType subType, DeviceComponent component, long when, long lastWhen)
          Sets the fields of this MouseEvent to match the given MouseEvent.
abstract  java.lang.String toString()
          
 
Methods inherited from class org.jagatoo.input.events.InputEvent
getComponent, getLastWhen, getType, getWhen, set, set
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MouseEvent

public MouseEvent(Mouse mouse,
                  MouseEvent.SubType subType,
                  DeviceComponent component,
                  long when,
                  long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.


MouseEvent

protected MouseEvent(MouseEvent.SubType subType)
Creates a MouseEvent with default values.

Method Detail

getMouse

public final Mouse getMouse()
The MouseDevice, that caused the event.


getSubType

public final MouseEvent.SubType getSubType()

toString

public abstract java.lang.String toString()

Specified by:
toString in class InputEvent
Returns:
in formation about this InputEvent as a String.

set

protected void set(Mouse mouse,
                   MouseEvent.SubType subType,
                   DeviceComponent component,
                   long when,
                   long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.


set

protected void set(MouseEvent e)
Sets the fields of this MouseEvent to match the given MouseEvent.