org.jagatoo.input.events
Class MouseWheelEvent

java.lang.Object
  extended by org.jagatoo.input.events.InputEvent
      extended by org.jagatoo.input.events.MouseEvent
          extended by org.jagatoo.input.events.MouseWheelEvent

public class MouseWheelEvent
extends MouseEvent

Stores the details associated with a mouse event.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.jagatoo.input.events.MouseEvent
MouseEvent.SubType
 
Nested classes/interfaces inherited from class org.jagatoo.input.events.InputEvent
InputEvent.Type
 
Field Summary
protected  boolean isPageMove
          This is true, if the mouse-wheel move was a page-move.
protected  int wheelDelta
          The button (if one was pressed).
 
Constructor Summary
protected MouseWheelEvent()
          Creates a MouseEvent with default values.
protected MouseWheelEvent(Mouse mouse, MouseWheel wheel, int wheelDelta, boolean isPageMove, long when, long lastWhen)
          Sets the fields of this MouseEvent to match the given MouseEvent.
 
Method Summary
 int getWheelDelta()
          The Mouse-Wheel delta movement.
 boolean isPageMove()
          This is true, if the mouse-wheel move was a page-move.
protected  void set(Mouse mouse, MouseWheel wheel, int wheelDelta, boolean isPageMove, long when, long lastWhen)
          Sets the fields of this MouseEvent to match the given MouseEvent.
 java.lang.String toString()
          
 
Methods inherited from class org.jagatoo.input.events.MouseEvent
getMouse, getSubType, set, set
 
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
 

Field Detail

wheelDelta

protected int wheelDelta
The button (if one was pressed).


isPageMove

protected boolean isPageMove
This is true, if the mouse-wheel move was a page-move.

Constructor Detail

MouseWheelEvent

protected MouseWheelEvent(Mouse mouse,
                          MouseWheel wheel,
                          int wheelDelta,
                          boolean isPageMove,
                          long when,
                          long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.


MouseWheelEvent

protected MouseWheelEvent()
Creates a MouseEvent with default values.

Method Detail

getWheelDelta

public final int getWheelDelta()
The Mouse-Wheel delta movement.


isPageMove

public final boolean isPageMove()
This is true, if the mouse-wheel move was a page-move.


toString

public java.lang.String toString()

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

set

protected void set(Mouse mouse,
                   MouseWheel wheel,
                   int wheelDelta,
                   boolean isPageMove,
                   long when,
                   long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.