org.hybird.animation.trident.triggers

Class FocusTrigger

java.lang.Object

org.hybird.animation.trident.triggers.Trigger

org.hybird.animation.trident.triggers.FocusTrigger

All Implemented Interfaces:

FocusListener, EventListener

public class FocusTrigger
extends Trigger
implements FocusListener

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

 FocusTrigger trigger = FocusTrigger.addTrigger (component, anim,
         FocusTriggerEvent.GAINED);
 

Author:

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

Constructor Summary

Constructors

Constructor and Description
FocusTrigger(org.pushingpixels.trident.Timeline timeline, FocusTriggerEvent event) Creates a non-auto-reversing FocusTrigger, which should be added to a Component that will generate the focus events of interest.
FocusTrigger(org.pushingpixels.trident.Timeline timeline, FocusTriggerEvent event, boolean autoReverse) Creates a FocusTrigger, which should be added to a Component that will generate the focus events of interest.

Method Summary

Modifier and Type	Method and Description
static FocusTrigger	addTrigger(JComponent component, org.pushingpixels.trident.Timeline timeline, FocusTriggerEvent event) Creates a non-auto-reversing FocusTrigger and adds it as a FocusListener to the component.
static FocusTrigger	addTrigger(JComponent component, org.pushingpixels.trident.Timeline timeline, FocusTriggerEvent event, boolean autoReverse) Creates a FocusTrigger and adds it as a FocusListener to the component.
void	focusGained(FocusEvent e) Called by the object which added this trigger as a FocusListener.
void	focusLost(FocusEvent e) Called by the object which added this trigger as a FocusListener.

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

FocusTrigger

public FocusTrigger(org.pushingpixels.trident.Timeline timeline,
                    FocusTriggerEvent event)

Creates a non-auto-reversing FocusTrigger, which should be added to a Component that will generate the focus events of interest.

Parameters:

timeline - the Timeline that will start when the event occurs

event - the FocusTriggerEvent that will cause the action to fire

FocusTrigger

public FocusTrigger(org.pushingpixels.trident.Timeline timeline,
                    FocusTriggerEvent event,
                    boolean autoReverse)

Creates a FocusTrigger, which should be added to a Component that will generate the focus events of interest.

Parameters:

timeline - the Timeline that will start when the event occurs

event - the FocusTriggerEvent that will cause the action to fire

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

Method Detail

addTrigger

public static FocusTrigger addTrigger(JComponent component,
                                      org.pushingpixels.trident.Timeline timeline,
                                      FocusTriggerEvent event)

Creates a non-auto-reversing FocusTrigger and adds it as a FocusListener to the component.

Parameters:

component - component that will generate FocusEvents for this trigger

timeline - the Timeline that will start when the event occurs

event - the FocusTriggerEvent that will cause the action to fire

Returns:

FocusTrigger the resulting trigger

addTrigger

public static FocusTrigger addTrigger(JComponent component,
                                      org.pushingpixels.trident.Timeline timeline,
                                      FocusTriggerEvent event,
                                      boolean autoReverse)

Creates a FocusTrigger and adds it as a FocusListener to the component.

Parameters:

component - component that will generate FocusEvents for this trigger

timeline - the Timeline that will start when the event occurs

event - the FocusTriggerEvent that will cause the action to fire

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

Returns:

FocusTrigger the resulting trigger

focusGained

public void focusGained(FocusEvent e)

Called by the object which added this trigger as a FocusListener. This method starts the timeline if the trigger is waiting for a GAINED event.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Called by the object which added this trigger as a FocusListener. This method starts the timeline if the trigger is waiting for a LOST event.

Specified by:

focusLost in interface FocusListener