Packagecom.adobe.indesign
Classpublic class BackgroundTasks
InheritanceBackgroundTasks 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.
BackgroundTasks
Public Methods
 MethodDefined By
  
Returns any BackgroundTask in the collection.
BackgroundTasks
  
count():Number
Displays the number of elements in the BackgroundTask.
BackgroundTasks
  
everyItem():Object
Returns every BackgroundTask in the collection.
BackgroundTasks
 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 BackgroundTask in the collection.
BackgroundTasks
 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):BackgroundTask
Returns the BackgroundTask with the specified index or name.
BackgroundTasks
  
itemByID(idParam:Number):BackgroundTask
Returns the BackgroundTask with the specified ID.
BackgroundTasks
  
itemByName(nameParam:String = null):BackgroundTask
Returns the BackgroundTask with the specified name.
BackgroundTasks
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the BackgroundTasks within the specified range.
BackgroundTasks
  
Returns the last BackgroundTask in the collection.
BackgroundTasks
  
Returns the middle BackgroundTask in the collection.
BackgroundTasks
  
Returns the BackgroundTask whose index follows the specified BackgroundTask in the collection.
BackgroundTasks
  
Returns the BackgroundTask with the index previous to the specified index.
BackgroundTasks
 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
BackgroundTasks
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
BackgroundTasks
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
anyItem()method
public function anyItem():BackgroundTask

Returns any BackgroundTask in the collection.

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

Displays the number of elements in the BackgroundTask.

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

Returns every BackgroundTask in the collection.

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

Returns the first BackgroundTask in the collection.

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

Returns the BackgroundTask with the specified index or name.

Parameters

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

Returns
BackgroundTask
itemByID()method 
public function itemByID(idParam:Number):BackgroundTask

Returns the BackgroundTask with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
BackgroundTask
itemByName()method 
public function itemByName(nameParam:String = null):BackgroundTask

Returns the BackgroundTask with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

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

Returns the BackgroundTasks within the specified range.

Parameters

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

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

Returns the last BackgroundTask in the collection.

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

Returns the middle BackgroundTask in the collection.

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

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

Parameters

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

Returns
BackgroundTask
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:BackgroundTask = null):BackgroundTask

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

Parameters

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

Returns
BackgroundTask