Animator

Animates the property of a SitedObject

Remarks

Animator supports animating a single property of an object.

The property that is animated is specified using the ID_propertyId property. The Animator animates this property from the value specified in its ID_from property to the value specified in its ID_to property.

If no ID_from is specified, then the animator starts the animation from the current value of the property being animated.

The motion of the animation is controlled by the ID_motion property, which is either ID_easeIn, ID_easeOut, ID_easeBoth or ID_linear.

Properties

ID_animatorId (inherited from AnimatorBase)The ID this animator is known by.
ID_durationThe duration of this animation in milliseconds.
ID_fromThe value to start the animation at.
ID_motionEither ID_easeBoth, ID_easeIn, ID_easeOut, or ID_linear.
ID_propertyIdThe ID of the property to animate.
ID_relativetrue to make ID_to relative to ID_from.
ID_toThe value to animate to.

Methods

addEventHandler (inherited from SitedObject)Adds a delegate to be called when the specified eventId occurs on this object.
equals (inherited from SitedObject)Tests if two objects are equal.
fireEventHandler (inherited from SitedObject)Invokes any user event handlers registered for a particular event using SitedObject.addEventHandler().
getBindingStatus (inherited from SitedObject)Provides debugging information on bindings for this object.
getPathValue (inherited from SitedObject)Traverses a binding path and returns the value at the end of it.
getPropertyInfo (inherited from SitedObject)Gets information on a property.
getSite (inherited from SitedObject)Gets this object's site.
getTotalDuration (inherited from AnimatorBase)Returns the duration of this animator in milliseconds.
getValue (inherited from SitedObject)Gets the value of a property on this object.
onSetValue (inherited from SitedObject)Called by SitedObject.setValue() when a property value is set on this object.
onSited (inherited from SitedObject)Called when this object is sited.
onUnsited (inherited from SitedObject)Called when this object is about to lose its site.
onValueSited (inherited from SitedObject)Called when an object is sited within this object.
onValueUnsited (inherited from SitedObject)Called when an object is about to be unsited in this.
removeEventHandler (inherited from SitedObject)Remove an existing delegate from the list of delegates for the specified event.
setInitialValues (inherited from SitedObject)Sets multiple property values on an object (during initialization only)
setPathValue (inherited from SitedObject)Traverses a binding path and sets the value at the end of it.
setValue (inherited from SitedObject)Sets the value of a property on this object.
start (inherited from AnimatorBase)Starts this animator running
stop (inherited from AnimatorBase)Stops this animator running
toString (inherited from SitedObject)Returns a string representation of this object.

Animator ID_duration property

The duration of this animation in milliseconds.

JavaScript

var intVal = animator.getValue(ID_duration)
animator.setValue(ID_duration, intVal)

Xml

<j:Animator duration="int"  ... >

Remarks

Defaults to 250 milliseconds.

Animator ID_from property

The value to start the animation at.

JavaScript

var numValue = animator.getValue(ID_from)
animator.setValue(ID_from, numValue)

Xml

<j:Animator from="float"  ... >

Remarks

If ID_from is unspecified, Animator uses the current value of the property in the control as the starting value.

Animator ID_motion property

Either ID_easeBoth, ID_easeIn, ID_easeOut, or ID_linear.

JavaScript

var idname = animator.getValue(ID_motion)
animator.setValue(ID_motion, idname)

Xml

<j:Animator motion="easeIn"  ... >
or
<j:Animator motion="easeOut"  ... >
or
<j:Animator motion="easeBoth"  ... >
or
<j:Animator motion="linear"  ... >

Remarks

Specifies the motion curve of this animator.

If ID_motion is ID_easeBoth, a slow-in-slow-out animation is performed.

If ID_motion is ID_easeIn, the animation starts slowly and accelerates, ending suddenly.

If ID_motion is ID_easeOut, the animation starts quickly and deaccelerates, ending smoothly.

If ID_motion is ID_linear, the animation happens at a constant rate.

Animator ID_propertyId property

The ID of the property to animate.

JavaScript

var strVal = animator.getValue(ID_propertyId)
animator.setValue(ID_propertyId, strVal)

Xml

<j:Animator propertyId="string"  ... >

Remarks

This is used as the first argument passed to Control.setValue(), to specify the property to animate.

To animate a stylesheet attribute, specify the stylesheet attribute name with a '$' prefix ('$' as in '$tyle').

To animate an HTML DOM attribute on the peer, specify the peer attribute name with a '@' prefix ('@' as in '@tyle').

Animator ID_relative property

true to make ID_to relative to ID_from.

JavaScript

var boolVal = animator.getValue(ID_relative)
animator.setValue(ID_relative, boolVal)

Xml

<j:Animator relative="true"  ... >
or
<j:Animator relative="false"  ... >

Remarks

If this is true, the end value of the animation is (ID_from + ID_to). If this is false (the default), the end value is ID_to.

Animator ID_to property

The value to animate to.

JavaScript

var numValue = animator.getValue(ID_to)
animator.setValue(ID_to, numValue)

Xml

<j:Animator to="float"  ... >