Controls
FoundationAnimatorBase
Base class of all animators
- Object
- SitedObject
- AnimatorBase
Remarks
An Animator is a SitedObject that lives in the control hierarchy
and that initiates animations.
Properties
| ID_animatorId | The ID this animator is known by. |
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 | 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 | Starts this animator running |
| stop | Stops this animator running |
| toString (inherited from SitedObject) | Returns a string representation of this object. |
AnimatorBase getTotalDuration method
Returns the duration of this animator in milliseconds.
JavaScript
animatorBase.getTotalDuration()
Remarks
Returns -1 if the animator duration cannot be calculated.
AnimatorBase ID_animatorId property
The ID this animator is known by.
JavaScript
var idname = animatorBase.getValue(ID_animatorId)
animatorBase.setValue(ID_animatorId, idname)
Xml
<j:AnimatorBase animatorId="string" ... >
Remarks
Pass this ID to Control.startAnimator()
to start this animator running on a control.
AnimatorBase start method
Starts this animator running
JavaScript
animatorBase.start(targetObj)
Remarks
The target argument specifies which object to run the animator against.
Animators themselves are not tied to any specific object or control. The same animator can be started on multiple objects at once.
In general, applications use Control.startAnimation() to start an animation on a particular control.
AnimatorBase stop method
Stops this animator running
JavaScript
animatorBase.stop(targetObj)
Remarks
If this animator is running on the specified target object, the
animator is stopped and any ongoing animations are cancelled.