Package | com.adobe.indesign |
Class | public class BackgroundTask |
Inheritance | BackgroundTask ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
alerts : Object [read-only]
The alerts encountered while running this task object. | BackgroundTask | ||
documentName : String [read-only]
The document name on which this task operates. | BackgroundTask | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | BackgroundTask | ||
events : Events [read-only]
A collection of events. | BackgroundTask | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the BackgroundTask. | BackgroundTask | ||
index : Number [read-only]
The index of the BackgroundTask within its containing object. | BackgroundTask | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | BackgroundTask | ||
name : String [read-only]
The name of the BackgroundTask. | BackgroundTask | ||
parent : Application [read-only]
The parent of the BackgroundTask (a Application). | BackgroundTask | ||
percentDone : Number [read-only]
Progress information for this task. | BackgroundTask | ||
properties : Object
A property that allows setting of several properties at the same time. | BackgroundTask | ||
status : TaskState [read-only]
The current status of this task object. | BackgroundTask |
Method | Defined By | ||
---|---|---|---|
addEventListenerBackgroundTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | BackgroundTask | ||
cancelTask():void
Cancels the specified background task. | BackgroundTask | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | BackgroundTask | ||
![]() | 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 | |
queryProperty(nameParam:String = null):Object
Queries for a particular property in the task metadata. | BackgroundTask | ||
removeEventListenerBackgroundTask(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | BackgroundTask | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | BackgroundTask | ||
Waits for the task to finish. | BackgroundTask | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
alerts | property |
alerts:Object
[read-only] Since : | CS5 |
The alerts encountered while running this task object. Can return: Array of Array of 2 TaskAlertType enumerators or Strings.
public function get alerts():Object
documentName | property |
documentName:String
[read-only] Since : | CS5 |
The document name on which this task operates.
public function get documentName():String
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the BackgroundTask.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the BackgroundTask within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the BackgroundTask.
public function get name():String
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the BackgroundTask (a Application).
public function get parent():Application
percentDone | property |
percentDone:Number
[read-only] Since : | CS5 |
Progress information for this task.
public function get percentDone():Number
properties | property |
properties:Object
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
status | property |
status:TaskState
[read-only] Since : | CS5 |
The current status of this task object.
public function get status():TaskState
addEventListenerBackgroundTask | () | method |
public function addEventListenerBackgroundTask(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 |
cancelTask | () | method |
public function cancelTask():void
Since : | CS5 |
Cancels the specified background task.
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
queryProperty | () | method |
public function queryProperty(nameParam:String = null):Object
Since : | CS5 |
Queries for a particular property in the task metadata.
Parameters
nameParam:String (default = null ) — (String) The task property being queried
|
Object |
removeEventListenerBackgroundTask | () | method |
public function removeEventListenerBackgroundTask(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 |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
waitForTask | () | method |