org.hybird.animation.trident.triggers

Class Trigger

java.lang.Object

org.hybird.animation.trident.triggers.Trigger

Direct Known Subclasses:

ActionTrigger, FocusTrigger, MouseTrigger

public abstract class Trigger
extends Object

This abstract class should be overridden by any class wanting to implement a new Trigger. The subclass will define the events to trigger off of and any listeners to handle those events. That subclass will call either fire() or fire(TriggerEvent) to start the timeline based on an event that occurred.

Subclasses should call one of the constructors in Trigger, according to whether they want Trigger to discern between different TriggerEvents and whether they want Trigger to auto-reverse the animation based on opposite TriggerEvents.

Subclasses should call one of the fire methods based on whether they want Trigger to perform any event logic or simply start the animation.

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Trigger(org.pushingpixels.trident.Timeline timeline) Creates a Trigger that will start the timeline when fire() is called.
protected	Trigger(org.pushingpixels.trident.Timeline timeline, TriggerEvent triggerEvent) Creates a Trigger that will start the timeline when fire(TriggerEvent) is called with an event that equals triggerEvent.
protected	Trigger(org.pushingpixels.trident.Timeline timeline, TriggerEvent triggerEvent, boolean autoReverse) Creates a Trigger that will start the timeline when fire(TriggerEvent) is called with an event that equals triggerEvent.

Method Summary

Modifier and Type	Method and Description
void	disarm() This method disables this Trigger and effectively noop's any actions that would otherwise occur
protected void	fire() Utility method called by subclasses to start the timeline.
protected void	fire(TriggerEvent currentEvent) Called by subclasses to start the timeline if currentEvent equals the event that the Trigger is based upon.
protected boolean	isTimelineRunning() Utility method checking if the timeline is running in forward or reverse direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Trigger

protected Trigger(org.pushingpixels.trident.Timeline timeline)

Creates a Trigger that will start the timeline when fire() is called. Subclasses call this method to set up a simple Trigger that will be started by calling fire(), and will have no dependency upon the specific TriggerEvent that must have occurred to start the animator.

Parameters:

timeline - the Timeline that will start when the Trigger is fired

Trigger

protected Trigger(org.pushingpixels.trident.Timeline timeline,
                  TriggerEvent triggerEvent)

Creates a Trigger that will start the timeline when fire(TriggerEvent) is called with an event that equals triggerEvent.

Parameters:

timeline - the Timeline that will start when the Trigger is fired

triggerEvent - the TriggerEvent that must occur for this Trigger to fire

Trigger

protected Trigger(org.pushingpixels.trident.Timeline timeline,
                  TriggerEvent triggerEvent,
                  boolean autoReverse)

Creates a Trigger that will start the timeline when fire(TriggerEvent) is called with an event that equals triggerEvent. Also, automatically stops and reverses the timeline when opposite event occurs, and stops reversing the timeline likewise when triggerEvent occurs.

Parameters:

timeline - the Timeline that will start when the Trigger is fired

triggerEvent - the TriggerEvent that must occur for this Trigger to fire

autoReverse - flag to determine whether the timeline should stop and reverse based on opposite triggerEvents.

See Also:

TriggerEvent.getOppositeEvent()

Method Detail

disarm

public void disarm()

This method disables this Trigger and effectively noop's any actions that would otherwise occur

fire

protected void fire(TriggerEvent currentEvent)

Called by subclasses to start the timeline if currentEvent equals the event that the Trigger is based upon. Also, if the Trigger is set to autoReverse, stops and reverses the timeline running in the opposite direction as appropriate.

Parameters:

currentEvent - the TriggerEvent that just occurred, which will be compared with the TriggerEvent used to construct this Trigger and determine whether the timeline should be started or reversed

fire

protected void fire()

Utility method called by subclasses to start the timeline. This variant assumes that there need be no check of the TriggerEvent that fired, which is useful for subclasses with simple events.

isTimelineRunning

protected boolean isTimelineRunning()

Utility method checking if the timeline is running in forward or reverse direction.