org.jdesktop.animation.timing.triggers
Class MouseTrigger

java.lang.Object
  extended by org.jdesktop.animation.timing.triggers.Trigger
      extended by org.jdesktop.animation.timing.triggers.MouseTrigger
All Implemented Interfaces:
MouseListener, EventListener

public class MouseTrigger
extends Trigger
implements MouseListener

MouseTrigger handles mouse events and triggers an animation based on those events. For example, to have anim start when component receives an ENTER event, one might write the following:

     MouseTrigger trigger = 
         MouseTrigger.addTrigger(component, anim, MouseTriggerEvent.ENTER);
 


Constructor Summary
MouseTrigger(Animator animator, MouseTriggerEvent event)
          Creates a non-auto-reversing MouseTrigger, which should be added to a Component that will generate the mouse events of interest
MouseTrigger(Animator animator, MouseTriggerEvent event, boolean autoReverse)
          Creates a MouseTrigger, which should be added to a Component that will generate the mouse events of interest
 
Method Summary
static MouseTrigger addTrigger(JComponent component, Animator animator, MouseTriggerEvent event)
          Creates a non-auto-reversing MouseTrigger and adds it as a listener to component.
static MouseTrigger addTrigger(JComponent component, Animator animator, MouseTriggerEvent event, boolean autoReverse)
          Creates a MouseTrigger and adds it as a listener to component.
 void mouseClicked(MouseEvent e)
          Called by the object which added this trigger as a MouseListener.
 void mouseEntered(MouseEvent e)
          Called by the object which added this trigger as a MouseListener.
 void mouseExited(MouseEvent e)
          Called by the object which added this trigger as a MouseListener.
 void mousePressed(MouseEvent e)
          Called by the object which added this trigger as a MouseListener.
 void mouseReleased(MouseEvent e)
          Called by the object which added this trigger as a MouseListener.
 
Methods inherited from class org.jdesktop.animation.timing.triggers.Trigger
disarm, fire, fire
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MouseTrigger

public MouseTrigger(Animator animator,
                    MouseTriggerEvent event)
Creates a non-auto-reversing MouseTrigger, which should be added to a Component that will generate the mouse events of interest


MouseTrigger

public MouseTrigger(Animator animator,
                    MouseTriggerEvent event,
                    boolean autoReverse)
Creates a MouseTrigger, which should be added to a Component that will generate the mouse events of interest

Method Detail

addTrigger

public static MouseTrigger addTrigger(JComponent component,
                                      Animator animator,
                                      MouseTriggerEvent event)
Creates a non-auto-reversing MouseTrigger and adds it as a listener to component.

Parameters:
component - component that will generate MouseEvents for this trigger
animator - the Animator that will start when the event occurs
event - the MouseTriggerEvent that will cause the action to fire
Returns:
MouseTrigger the resulting trigger

addTrigger

public static MouseTrigger addTrigger(JComponent component,
                                      Animator animator,
                                      MouseTriggerEvent event,
                                      boolean autoReverse)
Creates a MouseTrigger and adds it as a listener to component.

Parameters:
component - component that will generate MouseEvents for this trigger
animator - the Animator that will start when the event occurs
event - the FocusTriggerEvent that will cause the action to fire
autoReverse - flag to determine whether the animator should stop and reverse based on opposite triggerEvents.
Returns:
FocusTrigger the resulting trigger

mouseEntered

public void mouseEntered(MouseEvent e)
Called by the object which added this trigger as a MouseListener. This method starts the animator if the trigger is waiting for an ENTER event.

Specified by:
mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)
Called by the object which added this trigger as a MouseListener. This method starts the animator if the trigger is waiting for an EXIT event.

Specified by:
mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)
Called by the object which added this trigger as a MouseListener. This method starts the animator if the trigger is waiting for a PRESS event.

Specified by:
mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)
Called by the object which added this trigger as a MouseListener. This method starts the animator if the trigger is waiting for a RELEASE event.

Specified by:
mouseReleased in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent e)
Called by the object which added this trigger as a MouseListener. This method starts the animator if the trigger is waiting for a CLICK event.

Specified by:
mouseClicked in interface MouseListener