org.hybird.animation.trident.triggers

Class ActionTrigger

java.lang.Object

org.hybird.animation.trident.triggers.Trigger

org.hybird.animation.trident.triggers.ActionTrigger

All Implemented Interfaces:

ActionListener, EventListener

public class ActionTrigger
extends Trigger
implements ActionListener

ActionTrigger handles action events and starts the timeline when actions occur. For example, to have anim start when a button is clicked, one might write the following:

 ActionTrigger trigger = ActionTrigger.addTrigger (button, anim);
 

Author:

Chet, R�my Rakic - Modifications for Trident and javadocs

Constructor Summary

Constructors

Constructor and Description
ActionTrigger(org.pushingpixels.trident.Timeline timeline) Creates an ActionTrigger that will start the timeline upon receiving any ActionEvents.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent ae) Called by an object generating ActionEvents to which this trigger was added as an ActionListener.
static ActionTrigger	addTrigger(Object object, org.pushingpixels.trident.Timeline timeline) Creates an ActionTrigger and adds it as a listener to object.

Methods inherited from class org.hybird.animation.trident.triggers.Trigger

disarm, fire, fire, isTimelineRunning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionTrigger

public ActionTrigger(org.pushingpixels.trident.Timeline timeline)

Creates an ActionTrigger that will start the timeline upon receiving any ActionEvents. It should be added to any suitable object with an addActionListener method.

Parameters:

timeline - the Timeline that will start when the event occurs

Method Detail

addTrigger

public static ActionTrigger addTrigger(Object object,
                                       org.pushingpixels.trident.Timeline timeline)

Creates an ActionTrigger and adds it as a listener to object.

Parameters:

object - an object that will be used as an event source for this trigger. This object must have the method addActionListener.

timeline - the Timeline that will start when the event occurs

Returns:

ActionTrigger the resulting trigger

Throws:

IllegalArgumentException - if object has no addActionListener()

actionPerformed

public void actionPerformed(ActionEvent ae)

Called by an object generating ActionEvents to which this trigger was added as an ActionListener. This starts the Timeline.

Specified by:

actionPerformed in interface ActionListener