animatorgroup (LzAnimatorGroup)

animatorgroup (LzAnimatorGroup)
Prev	Animation	Next

Name

animatorgroup (LzAnimatorGroup) — Coordinates the behavior of several animators.

Synopsis

LZX: animatorgroup
JavaScript: LzAnimatorGroup
Type: Class
Access: public
Topic: LFC.Animation
Declared in: WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs

Description

An LzAnimatorGroup wraps several LzAnimators, and runs them in sequence or simultaneously . As an example, the code below animates a view first along the x-axis and then the y.

 <canvas>
   <view bgcolor="red" width="100" height="100">
     <animatorgroup process="sequential">
       <animator attribute="x" to="100" duration="1000"/>
       <animator attribute="y" to="100" duration="1000"/>
     </animatorgroup>
   </view>
 </canvas>

Any attribute that is legal in animator is legal in animatorgroup. These attributes are then cascaded to the animators contained within.

Events (such as onstart, onstop, etc.) and the name and id attributes, however, are not cascaded. Also, start defined at the group level is effectively cascaded to the animators, meaning that the start attribute is ignored in the animators themselves.

Superclass Chain

node (LzNode) » animatorgroup (LzAnimatorGroup)

Known Subclasses

Known Direct Subclasses: animator (LzAnimator)

Details

Properties (14)

animatorProps

public var animatorProps = { ... };

attribute

public var attribute : String;

The name of the attribute whose value is animated. This attribute is required on an animator, unless the animator is inside an animatorgroup that specifies an attribute.

duration

public var duration : Number;

The duration of the animation, in milliseconds (1000 = 1 second).

from

public var from : Number;

The start value for the animation. Defaults to the targeted attribute's current value.

indirect

public var indirect : Boolean = false;

motion

public var motion : String = easeboth;

paused

public var paused : boolean;

If true, the running animator will pause. If false it will resume

process

public var process : string = sequential;

"simultaneous" or none: means process animators simultaneously
"sequential": means process animators sequentially;

Animators other than animatorgroups ignore this attribute

relative

public var relative : Boolean = false;

Whether the to value is relative to the initial value of the attribute (true), or is absolute (false).

repeat

public var repeat : String;

The number of times to repeat the animation. This should be a positive integer, or 'Infinity'. Changes to the repeat value take effect, after the animation is finished and then restarted.

start

public var start : Boolean = true;

Whether to start the animation instantly (the default), or wait for a script command.

started

public var started : Boolean;

Value of the animator's start attribute.

target

public var target : string;

The object to animate

to

public var to : Number;

The final value for the targeted attribute.

Setters (3)

Setters for virtual properties, to be used with setAttribute. A setter may or may not have a corresponding getter method; consult the Methods list in this section.

paused
start
target

Methods (4)

doStart(): <method name="doStart" />

public function doStart();

called to set starting flags and values, send onstart event, and register animator for processing on the main idle loop.
pause(): <method name="pause" args="dop" />

public function pause(dop : Boolean);

Temporarily pauses or restarts the animator
setTarget(): <method name="setTarget" args="new_target" />

public function setTarget(new_target);

setter for the target attribute
stop(): <method name="stop" />

public function stop();

Stop is called when the animation is complete, or when the animator is destroyed. It can also be called to halt a running animation.

Events (8)

onduration: <attribute name="onduration" />

public event onduration;
onfinish: <attribute name="onfinish" />

public deprecated event onfinish;

Use of 'onfinish' event is deprecated. Use 'onstop' event instead.
onpaused: <attribute name="onpaused" />

public event onpaused;
onrepeat: <attribute name="onrepeat" />

public event onrepeat;

Event sent at the beginning of each new repeat.
onstart: <attribute name="onstart" />

public event onstart;

Executed when the animator starts. This code is executed multiple times if the animator repeats.
onstarted: <attribute name="onstarted" />

public event onstarted;
onstop: <attribute name="onstop" />

public event onstop;

Executed when the animator finishes.
ontarget: <attribute name="ontarget" />

public event ontarget;

LZX Synopsis

</class>

JavaScript Synopsis

public LzAnimatorGroup extends LzNode {

public var animatorProps = { ... };

public var attribute : String;

public var duration : Number;

public var from : Number;

public var indirect : Boolean = false;

public var motion : String = easeboth;

public var paused : boolean;

public var process : string = sequential;

public var relative : Boolean = false;

public var repeat : String;

public var start : Boolean = true;

public var started : Boolean;

public var target : string;

public var to : Number;

prototype public function doStart ();

prototype public event onduration ;

prototype public deprecated event onfinish ;

prototype public event onpaused ;

prototype public event onrepeat ;

prototype public event onstart ;

prototype public event onstarted ;

prototype public event onstop ;

prototype public event ontarget ;

prototype public function pause (dop : Boolean);

prototype public function setTarget (new_target);

prototype public function stop ();

}

Copyright © 2002-2007 Laszlo Systems, Inc. All Rights Reserved. Unauthorized use, duplication or distribution is strictly prohibited. This is the proprietary information of Laszlo Systems, Inc. Use is subject to license terms.