Package org.eclipse.nebula.animation.effects

Class ParallelEffect

java.lang.Object

org.eclipse.nebula.animation.effects.ParallelEffect

All Implemented Interfaces:

IEffect

public class ParallelEffect
extends java.lang.Object
implements IEffect

A wrapper for running effects in parallel.

Author:

Nicolas Richeton

Constructor Summary

Constructors

Constructor	Description
ParallelEffect(java.util.List effects)	Wrap several effects and start them in parallel.
ParallelEffect(java.util.List effects, java.lang.Runnable onStop, java.lang.Runnable onCancel)	Wrap several effects and start them in parallel.
ParallelEffect(IEffect[] effects)	Wrap several effects and start them in parallel.
ParallelEffect(IEffect[] effects, java.lang.Runnable onStop, java.lang.Runnable onCancel)	Wrap several effects and start them in parallel.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Set the effect as done and run the cancel runnable.
void	doEffect(long time)	Apply effect to the target according to the given time.
long	getLength()	Get effect length
boolean	isDone()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallelEffect

public ParallelEffect(IEffect[] effects)

Wrap several effects and start them in parallel.

Parameters:

effects -

ParallelEffect

public ParallelEffect(IEffect[] effects,
                      java.lang.Runnable onStop,
                      java.lang.Runnable onCancel)

Wrap several effects and start them in parallel.

Parameters:

effects -

onStop -

onCancel -

ParallelEffect

public ParallelEffect(java.util.List effects)

Wrap several effects and start them in parallel.

Parameters:

effects -

ParallelEffect

public ParallelEffect(java.util.List effects,
                      java.lang.Runnable onStop,
                      java.lang.Runnable onCancel)

Wrap several effects and start them in parallel.

Parameters:

effects -

onStop -

onCancel -

Method Detail

cancel

public void cancel()

Description copied from interface: IEffect

Set the effect as done and run the cancel runnable.

Specified by:

cancel in interface IEffect

doEffect

public void doEffect(long time)

Description copied from interface: IEffect

Apply effect to the target according to the given time.

Specified by:

doEffect in interface IEffect

Parameters:

time - - Current time in ms. This value may be larger than the effect length.

getLength

public long getLength()

Description copied from interface: IEffect

Get effect length

Specified by:

getLength in interface IEffect

Returns:

length (ms)

isDone

public boolean isDone()

Specified by:

isDone in interface IEffect

Returns:

true if the effect as already reached its end.