Packagecom.adobe.indesign
Classpublic class TimingGroups
InheritanceTimingGroups Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
TimingGroups
Public Methods
 MethodDefined By
  
add(dynamicTargetParam:Object = null, delaySecondsParam:Number = 0, withPropertiesParam:Object = null):TimingGroup
Adds a new timing group.
TimingGroups
  
Returns any TimingGroup in the collection.
TimingGroups
  
count():Number
Displays the number of elements in the TimingGroup.
TimingGroups
  
everyItem():Object
Returns every TimingGroup in the collection.
TimingGroups
 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
  
Returns the first TimingGroup in the collection.
TimingGroups
 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
 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
  
item(indexParam:Object = null):TimingGroup
Returns the TimingGroup with the specified index or name.
TimingGroups
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the TimingGroups within the specified range.
TimingGroups
  
Returns the last TimingGroup in the collection.
TimingGroups
  
Returns the middle TimingGroup in the collection.
TimingGroups
  
Returns the TimingGroup whose index follows the specified TimingGroup in the collection.
TimingGroups
  
Returns the TimingGroup with the index previous to the specified index.
TimingGroups
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
TimingGroups
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
TimingGroups
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(dynamicTargetParam:Object = null, delaySecondsParam:Number = 0, withPropertiesParam:Object = null):TimingGroup

Adds a new timing group.

Parameters

dynamicTargetParam:Object (default = null) — (Object) A page item target that is an animation, media, or mso. Can accept: PageItem, Graphic, Behavior or MediaItem.
 
delaySecondsParam:Number (default = 0) — (Number) The time delay in seconds for a target. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new TimingGroup (Optional)

Returns
TimingGroup
anyItem()method 
public function anyItem():TimingGroup

Returns any TimingGroup in the collection.

Returns
TimingGroup
count()method 
public function count():Number

Displays the number of elements in the TimingGroup.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every TimingGroup in the collection.

Returns
Object
firstItem()method 
public function firstItem():TimingGroup

Returns the first TimingGroup in the collection.

Returns
TimingGroup
item()method 
public function item(indexParam:Object = null):TimingGroup

Returns the TimingGroup with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
TimingGroup
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the TimingGroups within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The TimingGroup, index, or name at the beginning of the range. Can accept: TimingGroup, Long Integer or String.
 
toParam:Object (default = null) — (Object) The TimingGroup, index, or name at the end of the range. Can accept: TimingGroup, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():TimingGroup

Returns the last TimingGroup in the collection.

Returns
TimingGroup
middleItem()method 
public function middleItem():TimingGroup

Returns the middle TimingGroup in the collection.

Returns
TimingGroup
nextItem()method 
public function nextItem(objParam:TimingGroup = null):TimingGroup

Returns the TimingGroup whose index follows the specified TimingGroup in the collection.

Parameters

objParam:TimingGroup (default = null) — (TimingGroup) The TimingGroup whose index comes before the desired TimingGroup.

Returns
TimingGroup
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:TimingGroup = null):TimingGroup

Returns the TimingGroup with the index previous to the specified index.

Parameters

objParam:TimingGroup (default = null) — (TimingGroup) The index of the TimingGroup that follows the desired TimingGroup.

Returns
TimingGroup