Packagecom.adobe.indesign
Classpublic class AnimationSetting
InheritanceAnimationSetting Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
AnimationSetting
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
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
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
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
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
designOptionproperty
designOption:DesignOptions

The animation design option.


Implementation
    public function get designOption():DesignOptions
    public function set designOption(value:DesignOptions):void
durationproperty 
duration:Number

The duration in second for this animation.


Implementation
    public function get duration():Number
    public function set duration(value:Number):void
easeTypeproperty 
easeType:AnimationEaseOptions

The ease type.


Implementation
    public function get easeType():AnimationEaseOptions
    public function set easeType(value:AnimationEaseOptions):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
hasCustomSettingsproperty 
hasCustomSettings:Boolean  [read-only]

Determines if this animated object has custom settings.


Implementation
    public function get hasCustomSettings():Boolean
hiddenAfterproperty 
hiddenAfter:Boolean

Determines if this object is hidden after its animation is played in an exported SWF file.


Implementation
    public function get hiddenAfter():Boolean
    public function set hiddenAfter(value:Boolean):void
initiallyHiddenproperty 
initiallyHidden:Boolean

Determines if this object is initially hidden when displayed in an exported SWF file.


Implementation
    public function get initiallyHidden():Boolean
    public function set initiallyHidden(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
motionPathproperty 
motionPath:Object

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.


Implementation
    public function get motionPath():Object
    public function set motionPath(value:Object):void
motionPathPointsproperty 
motionPathPoints:Object

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.


Implementation
    public function get motionPathPoints():Object
    public function set motionPathPoints(value:Object):void
opacityArrayproperty 
opacityArray:Object

The list of opacity key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.


Implementation
    public function get opacityArray():Object
    public function set opacityArray(value:Object):void
parentproperty 
parent:Object  [read-only] [override]

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).


Implementation
    public function get parent():Object
playsproperty 
plays:Number

The number of times this animation plays.


Implementation
    public function get plays():Number
    public function set plays(value:Number):void
playsLoopproperty 
playsLoop:Boolean

Set to true if animation play loops.


Implementation
    public function get playsLoop():Boolean
    public function set playsLoop(value:Boolean):void
presetproperty 
preset:Object

The base animation preset applied. Can return: MotionPreset, String or NothingEnum enumerator.


Implementation
    public function get preset():Object
    public function set preset(value:Object):void
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rotationArrayproperty 
rotationArray:Object

The list of rotation key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.


Implementation
    public function get rotationArray():Object
    public function set rotationArray(value:Object):void
scaleXArrayproperty 
scaleXArray:Object

The list of scale x key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.


Implementation
    public function get scaleXArray():Object
    public function set scaleXArray(value:Object):void
scaleYArrayproperty 
scaleYArray:Object

The list of scale y key frames for this animation. Can return: Ordered array containing keyFrame:Long Integer, value:Real.


Implementation
    public function get scaleYArray():Object
    public function set scaleYArray(value:Object):void
transformOffsetsproperty 
transformOffsets:Object

The tranform offset percentage from the target object bounding box's left-top corner.


Implementation
    public function get transformOffsets():Object
    public function set transformOffsets(value:Object):void
Method Detail
addEventListenerAnimationSetting()method
public function addEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
getElements()method 
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
removeEventListenerAnimationSetting()method 
public function removeEventListenerAnimationSetting(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
save()method 
public function save(nameParam:String = null):MotionPreset

Save this motion preset as custom preset.

Parameters

nameParam:String (default = null) — (String) The name for the new motion preset.

Returns
MotionPreset
saveACopy()method 
public function saveACopy(toParam:File = null):void

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

Retrieves the object specifier.

Returns
String