com.sencha.gxt.fx.client.animation
Class Fx

java.lang.Object
  extended by com.sencha.gxt.fx.client.animation.Fx
All Implemented Interfaces:
AfterAnimateEvent.HasAfterAnimateHandlers, BeforeAnimateEvent.HasBeforeAnimateHandlers, CancelAnimationEvent.HasCancelAnimationHandlers

public class Fx
extends java.lang.Object
implements AfterAnimateEvent.HasAfterAnimateHandlers, BeforeAnimateEvent.HasBeforeAnimateHandlers, CancelAnimationEvent.HasCancelAnimationHandlers

Runs an effect and fires events. The run multiple effects see MultiEffect.


Constructor Summary
Fx()
           
Fx(int duration)
           
 
Method Summary
 HandlerRegistration addAfterAnimateHandler(AfterAnimateEvent.AfterAnimateHandler handler)
          Adds a AfterAnimateEvent.AfterAnimateHandler handler for AfterAnimateEvent events.
 HandlerRegistration addBeforeAnimateHandler(BeforeAnimateEvent.BeforeAnimateHandler handler)
          Adds a BeforeAnimateEvent.BeforeAnimateHandler handler for BeforeAnimateEvent events.
 HandlerRegistration addCancelAnimationHandler(CancelAnimationEvent.CancelAnimationHandler handler)
          Adds a CancelAnimationEvent.CancelAnimationHandler handler for CancelAnimationEvent events.
 void cancel()
          Cancels the effect.
 Effect getEffect()
          Returns the effect.
 boolean run(Effect effect)
          Runs the effect for the given duration.
 boolean run(int duration, Effect effect)
          Runs the effect for the given duration.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fx

public Fx()

Fx

public Fx(int duration)
Method Detail

addAfterAnimateHandler

public HandlerRegistration addAfterAnimateHandler(AfterAnimateEvent.AfterAnimateHandler handler)
Description copied from interface: AfterAnimateEvent.HasAfterAnimateHandlers
Adds a AfterAnimateEvent.AfterAnimateHandler handler for AfterAnimateEvent events.

Specified by:
addAfterAnimateHandler in interface AfterAnimateEvent.HasAfterAnimateHandlers
Parameters:
handler - the handler
Returns:
the registration for the event

addBeforeAnimateHandler

public HandlerRegistration addBeforeAnimateHandler(BeforeAnimateEvent.BeforeAnimateHandler handler)
Description copied from interface: BeforeAnimateEvent.HasBeforeAnimateHandlers
Adds a BeforeAnimateEvent.BeforeAnimateHandler handler for BeforeAnimateEvent events.

Specified by:
addBeforeAnimateHandler in interface BeforeAnimateEvent.HasBeforeAnimateHandlers
Parameters:
handler - the handler
Returns:
the registration for the event

addCancelAnimationHandler

public HandlerRegistration addCancelAnimationHandler(CancelAnimationEvent.CancelAnimationHandler handler)
Description copied from interface: CancelAnimationEvent.HasCancelAnimationHandlers
Adds a CancelAnimationEvent.CancelAnimationHandler handler for CancelAnimationEvent events.

Specified by:
addCancelAnimationHandler in interface CancelAnimationEvent.HasCancelAnimationHandlers
Parameters:
handler - the handler
Returns:
the registration for the event

cancel

public void cancel()
Cancels the effect.


getEffect

public Effect getEffect()
Returns the effect.

Returns:
the effect

run

public boolean run(Effect effect)
Runs the effect for the given duration.

Parameters:
effect - the effect run
Returns:
true if the effect is run

run

public boolean run(int duration,
                   Effect effect)
Runs the effect for the given duration.

Parameters:
duration - the effect duration in milliseconds
effect - the effect run
Returns:
true if the effect is run


Copyright © 2012. All Rights Reserved.