AnimationSetting

Animation settings.

Methods:

addEventListener, getElements, removeEventListener, save, saveACopy, toSource, toSpecifier

Objects:

AnimationEaseOptions, Boolean, DesignOptions, EventListeners, Events, MotionPreset, NothingEnum, Number, Object, String,

Hierarchy:

Superclass: Preference

Class: AnimationSetting

Property Listing

Property

Type

Access

Description

designOption

DesignOptions

DesignOptions.FROM_CURRENT_APPEARANCE

DesignOptions.TO_CURRENT_APPEARANCE

DesignOptions.TO_CURRENT_LOCATION

read/write

The animation design option.

duration

Number (range 0.125 - 60)

read/write

The duration in second for this animation.

easeType

AnimationEaseOptions

AnimationEaseOptions.CUSTOM_EASE

AnimationEaseOptions.EASE_IN

AnimationEaseOptions.EASE_IN_OUT

AnimationEaseOptions.EASE_OUT

AnimationEaseOptions.NO_EASE

read/write

The ease type.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

hasCustomSettings

Boolean

readonly

Determines if this animated object has custom settings.

hiddenAfter

Boolean

read/write

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

initiallyHidden

Boolean

read/write

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

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

motionPath

Array of OrderedarraycontainingkeyFrame:LongInteger

Array of leftDirection:2 Reals

Array of pathPoint:Ordered array containing anchor:2 Reals

Array of rightDirection:2 Reals.

read/write

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.

motionPathPoints

Array of Ordered array containing pathPointArray:Ordered array containing anchor:2 Reals

Array of leftDirection:2 Reals

PathOpen:Boolean

Array of rightDirection:2 Reals

read/write

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.

opacityArray

Array of OrderedarraycontainingkeyFrame:LongInteger

Array of Value:Real

read/write

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

parent

Button

CheckBox

ComboBox

EPS

EPSText

FormField

Graphic

GraphicLine

Group

HtmlItem

Image

ImportedPage

ListBox

MediaItem

Movie

MultiStateObject

Oval

PDF

PICT

Polygon

RadioButton

Rectangle

SVG

SignatureField

Sound

SplineItem

TextBox

TextFrame

WMF

EndnoteTextFrame

PageItem

readonly

The parent of the AnimationSetting (a PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame or EndnoteTextFrame).

plays

Number (range 1 - 100)

read/write

The number of times this animation plays.

playsLoop

Boolean

read/write

Set to true if animation play loops.

preset

MotionPreset

String

NothingEnum.NOTHING

read/write

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

properties

Object

read/write

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

rotationArray

Array of OrderedarraycontainingkeyFrame:LongInteger

Array of Value:Real

read/write

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

scaleXArray

Array of OrderedarraycontainingkeyFrame:LongInteger

Array of Value:Real

read/write

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

scaleYArray

Array of OrderedarraycontainingkeyFrame:LongInteger

Array of Value:Real

read/write

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

transformOffsets

Array of Number

read/write

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

AnimationSetting getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

MotionPreset save (name:String)

Save this motion preset as custom preset.

Parameter

Type

Description

name

String

The name for the new motion preset.

undefined saveACopy (to:File)

Save a copy of this motion preset to a InDesign motion preset file.

Parameter

Type

Description

to

File

The Flash motion preset file to export to.

String toSource ()

Generates a string which, if executed, will return the AnimationSetting.

String toSpecifier ()

Retrieves the object specifier.

Object of

FormField.animationSettings

Button.animationSettings

MultiStateObject.animationSettings

CheckBox.animationSettings

ComboBox.animationSettings

ListBox.animationSettings

RadioButton.animationSettings

TextBox.animationSettings

SignatureField.animationSettings

Movie.animationSettings

Sound.animationSettings

PageItem.animationSettings

Oval.animationSettings

Rectangle.animationSettings

GraphicLine.animationSettings

Polygon.animationSettings

Group.animationSettings

Image.animationSettings

EPS.animationSettings

PDF.animationSettings

WMF.animationSettings

PICT.animationSettings

Graphic.animationSettings

SplineItem.animationSettings

EPSText.animationSettings

ImportedPage.animationSettings

SVG.animationSettings

MediaItem.animationSettings

HtmlItem.animationSettings

TextFrame.animationSettings

EndnoteTextFrame.animationSettings

Event.parent

EventListener.parent

MutationEvent.parent

Return

AnimationSetting.getElements()