ChainedEffect (effects 1.0.0)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

griffon.effects
[Groovy] Class ChainedEffect

java.lang.Object
  griffon.effects.AbstractEffect
      griffon.effects.ChainedEffect

abstract class ChainedEffect
extends AbstractEffect

Base class for composite, sequential Effects.

The following parameters are shared across all effects unless otherwise specified

duration: long, how long should the animation take. default: 500l
delay: long, wait time before the animation starts. default: 0l
ease: TimelineEase. default: Linear
wait: boolean. Force the caller thread to wait until the effects finishes. default: false

If a callback is supplied it will be called at the end of the animation, with the component and supplied parameters as arguments.

Field Summary

Fields inherited from class AbstractEffect
params

Constructor Summary
`ChainedEffect(Map params = [:], Component component, Closure callback = null)` Creates a new chained effect.

Method Summary
`void`	`run()` Runs the timeline.
`protected void`	`setupTimeline(org.pushingpixels.trident.Timeline timeline)` Configures the Timeline for this effect

Methods inherited from class AbstractEffect
doBeforePlay, getParams, paramsInternal, run, setupTimeline, toString

Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Constructor Detail

ChainedEffect(Map params = [:], Component component, Closure callback = null)

Creates a new chained effect.

Parameters:: params - - set of options; component - - the component to animate; callback - - an optional callback to be executed at the end of the animation

Method Detail

void run()

Runs the timeline.

Executes the supplied callback (if any) at the end of the animation.

protected void setupTimeline(org.pushingpixels.trident.Timeline timeline)

Configures the Timeline for this effect

Parameters:: timeline - - a timeline on which properties to interpolate can be set

Groovy Documentation