Package | com.adobe.indesign |
Class | public class AnimationSetting |
Inheritance | AnimationSetting ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
designOption : DesignOptions
The animation design option. | AnimationSetting | ||
duration : Number
The duration in second for this animation. | AnimationSetting | ||
easeType : AnimationEaseOptions
The ease type. | AnimationSetting | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | AnimationSetting | ||
events : Events [override] [read-only]
A collection of events. | AnimationSetting | ||
hasCustomSettings : Boolean [read-only]
Determines if this animated object has custom settings. | AnimationSetting | ||
hiddenAfter : Boolean
Determines if this object is hidden after its animation is played in an exported SWF file. | AnimationSetting | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
initiallyHidden : Boolean
Determines if this object is initially hidden when displayed in an exported SWF file. | AnimationSetting | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | AnimationSetting | ||
motionPath : Object
The list of motion path points and key frames for this animation. | AnimationSetting | ||
motionPathPoints : Object
The list of motion path points for this animation. | AnimationSetting | ||
opacityArray : Object
The list of opacity key frames for this animation. | AnimationSetting | ||
parent : Object [override] [read-only]
The parent of the AnimationSetting (a PageItem, FormField, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group or TextFrame). | AnimationSetting | ||
plays : Number
The number of times this animation plays. | AnimationSetting | ||
playsLoop : Boolean
Set to true if animation play loops. | AnimationSetting | ||
preset : Object
The base animation preset applied. | AnimationSetting | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | AnimationSetting | ||
rotationArray : Object
The list of rotation key frames for this animation. | AnimationSetting | ||
scaleXArray : Object
The list of scale x key frames for this animation. | AnimationSetting | ||
scaleYArray : Object
The list of scale y key frames for this animation. | AnimationSetting | ||
transformOffsets : Object
The tranform offset percentage from the target object bounding box's left-top corner. | AnimationSetting |
Method | Defined By | ||
---|---|---|---|
addEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | AnimationSetting | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | AnimationSetting | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
removeEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | AnimationSetting | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
save(nameParam:String = null):MotionPreset
Save this motion preset as custom preset. | AnimationSetting | ||
saveACopy(toParam:File = null):void
Save a copy of this motion preset to a InDesign motion preset file. | AnimationSetting | ||
toSpecifier():String [override]
Retrieves the object specifier. | AnimationSetting | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
designOption | property |
designOption:DesignOptions
Since : | CS5 |
The animation design option.
public function get designOption():DesignOptions
public function set designOption(value:DesignOptions):void
duration | property |
duration:Number
Since : | CS5 |
The duration in second for this animation.
public function get duration():Number
public function set duration(value:Number):void
easeType | property |
easeType:AnimationEaseOptions
Since : | CS5 |
The ease type.
public function get easeType():AnimationEaseOptions
public function set easeType(value:AnimationEaseOptions):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
hasCustomSettings | property |
hasCustomSettings:Boolean
[read-only] Since : | CS5 |
Determines if this animated object has custom settings.
public function get hasCustomSettings():Boolean
hiddenAfter | property |
hiddenAfter:Boolean
Since : | CS5 |
Determines if this object is hidden after its animation is played in an exported SWF file.
public function get hiddenAfter():Boolean
public function set hiddenAfter(value:Boolean):void
initiallyHidden | property |
initiallyHidden:Boolean
Since : | CS5 |
Determines if this object is initially hidden when displayed in an exported SWF file.
public function get initiallyHidden():Boolean
public function set initiallyHidden(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
motionPath | property |
motionPath:Object
Since : | CS5 |
The list of motion path points and key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, pathPoint:Ordered array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals.
public function get motionPath():Object
public function set motionPath(value:Object):void
motionPathPoints | property |
motionPathPoints:Object
Since : | CS5 |
The list of motion path points for this animation. Can return: Ordered array containing pathPointArray:Array of Ordered array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals, pathOpen:Boolean.
public function get motionPathPoints():Object
public function set motionPathPoints(value:Object):void
opacityArray | property |
opacityArray:Object
Since : | CS5 |
The list of opacity key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
public function get opacityArray():Object
public function set opacityArray(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the AnimationSetting (a PageItem, FormField, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group or TextFrame).
public function get parent():Object
plays | property |
plays:Number
Since : | CS5 |
The number of times this animation plays.
public function get plays():Number
public function set plays(value:Number):void
playsLoop | property |
playsLoop:Boolean
Since : | CS5 |
Set to true if animation play loops.
public function get playsLoop():Boolean
public function set playsLoop(value:Boolean):void
preset | property |
preset:Object
Since : | CS5 |
The base animation preset applied. Can return: MotionPreset, String or NothingEnum enumerator.
public function get preset():Object
public function set preset(value:Object):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rotationArray | property |
rotationArray:Object
Since : | CS5 |
The list of rotation key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
public function get rotationArray():Object
public function set rotationArray(value:Object):void
scaleXArray | property |
scaleXArray:Object
Since : | CS5 |
The list of scale x key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
public function get scaleXArray():Object
public function set scaleXArray(value:Object):void
scaleYArray | property |
scaleYArray:Object
Since : | CS5 |
The list of scale y key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.
public function get scaleYArray():Object
public function set scaleYArray(value:Object):void
transformOffsets | property |
transformOffsets:Object
Since : | CS5 |
The tranform offset percentage from the target object bounding box's left-top corner.
public function get transformOffsets():Object
public function set transformOffsets(value:Object):void
addEventListenerAnimationSetting | () | method |
public function addEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerAnimationSetting | () | method |
public function removeEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
save | () | method |
public function save(nameParam:String = null):MotionPreset
Since : | CS5 |
Save this motion preset as custom preset.
Parameters
nameParam:String (default = null ) — (String) The name for the new motion preset.
|
MotionPreset |
saveACopy | () | method |
public function saveACopy(toParam:File = null):void
Since : | CS5 |
Save a copy of this motion preset to a InDesign motion preset file.
Parameters
toParam:File (default = null ) — (File) The Flash motion preset file to export to.
|
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |