org.jagatoo.input.events
Class MouseButtonClickedEvent

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

public class MouseButtonClickedEvent
extends MouseButtonEvent

Stores details assotiated with a mouse-clicked-event. This may be a single-click or a double-click or what ever. Refer to the getClickCount() method to know about it.


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
 
Constructor Summary
protected MouseButtonClickedEvent()
          Creates a MouseEvent with default values.
  MouseButtonClickedEvent(Mouse mouse, MouseButton button, int clickCount, long when, long lastWhen)
          Sets the fields of this MouseEvent to match the given MouseEvent.
 
Method Summary
 int getClickCount()
           
protected  void set(Mouse mouse, MouseButton button, int clickCount, 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.MouseButtonEvent
getButton, getButtonBooleanState, getButtonState, getX, getY, set
 
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
 

Constructor Detail

MouseButtonClickedEvent

public MouseButtonClickedEvent(Mouse mouse,
                               MouseButton button,
                               int clickCount,
                               long when,
                               long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.


MouseButtonClickedEvent

protected MouseButtonClickedEvent()
Creates a MouseEvent with default values.

Method Detail

getClickCount

public final int getClickCount()
Returns:
the number of clicks.

toString

public java.lang.String toString()

Overrides:
toString in class MouseButtonEvent
Returns:
in formation about this InputEvent as a String.

set

protected void set(Mouse mouse,
                   MouseButton button,
                   int clickCount,
                   long when,
                   long lastWhen)
Sets the fields of this MouseEvent to match the given MouseEvent.