Packagecom.adobe.indesign
Classpublic class TaskState
InheritanceTaskState Inheritance CSEnumBase Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  cancelled : TaskState
[static] [read-only] Alias for CANCELLED.
TaskState
  CANCELLED : TaskState
[static] [read-only] Task was cancelled (either before it ran or during execution
TaskState
  cancelling : TaskState
[static] [read-only] Alias for CANCELLING.
TaskState
  CANCELLING : TaskState
[static] [read-only] Task was signalled to cancel but did not stop yet
TaskState
  completed : TaskState
[static] [read-only] Alias for COMPLETED.
TaskState
  COMPLETED : TaskState
[static] [read-only] Task completed execution (successfully or with errors)
TaskState
  enumCache : CSEnumSharedCache
[static] [read-only]
TaskState
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  queued : TaskState
[static] [read-only] Alias for QUEUED.
TaskState
  QUEUED : TaskState
[static] [read-only] Task was queued and is waiting to be scheduled for execution
TaskState
  running : TaskState
[static] [read-only] Alias for RUNNING.
TaskState
  RUNNING : TaskState
[static] [read-only] Task is running
TaskState
 Inheritedvalue : Object
[read-only] Returns the numerical value
CSEnumBase
  waiting : TaskState
[static] [read-only] Alias for WAITING.
TaskState
  WAITING : TaskState
[static] [read-only] Task is waiting
TaskState
Public Methods
 MethodDefined By
  
TaskState(ho:HostObject = null, enum:Number)
Constructor
TaskState
 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
 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
 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
Property Detail
cancelledproperty
cancelled:TaskState  [read-only]

Alias for CANCELLED. Task was cancelled (either before it ran or during execution


Implementation
    public static function get cancelled():TaskState
CANCELLEDproperty 
CANCELLED:TaskState  [read-only]

Task was cancelled (either before it ran or during execution


Implementation
    public static function get CANCELLED():TaskState
cancellingproperty 
cancelling:TaskState  [read-only]

Alias for CANCELLING. Task was signalled to cancel but did not stop yet


Implementation
    public static function get cancelling():TaskState
CANCELLINGproperty 
CANCELLING:TaskState  [read-only]

Task was signalled to cancel but did not stop yet


Implementation
    public static function get CANCELLING():TaskState
completedproperty 
completed:TaskState  [read-only]

Alias for COMPLETED. Task completed execution (successfully or with errors)


Implementation
    public static function get completed():TaskState
COMPLETEDproperty 
COMPLETED:TaskState  [read-only]

Task completed execution (successfully or with errors)


Implementation
    public static function get COMPLETED():TaskState
enumCacheproperty 
enumCache:CSEnumSharedCache  [read-only]


Implementation
    public static function get enumCache():CSEnumSharedCache
queuedproperty 
queued:TaskState  [read-only]

Alias for QUEUED. Task was queued and is waiting to be scheduled for execution


Implementation
    public static function get queued():TaskState
QUEUEDproperty 
QUEUED:TaskState  [read-only]

Task was queued and is waiting to be scheduled for execution


Implementation
    public static function get QUEUED():TaskState
runningproperty 
running:TaskState  [read-only]

Alias for RUNNING. Task is running


Implementation
    public static function get running():TaskState
RUNNINGproperty 
RUNNING:TaskState  [read-only]

Task is running


Implementation
    public static function get RUNNING():TaskState
waitingproperty 
waiting:TaskState  [read-only]

Alias for WAITING. Task is waiting


Implementation
    public static function get waiting():TaskState
WAITINGproperty 
WAITING:TaskState  [read-only]

Task is waiting


Implementation
    public static function get WAITING():TaskState
Constructor Detail
TaskState()Constructor
public function TaskState(ho:HostObject = null, enum:Number)

Constructor

Parameters
ho:HostObject (default = null) — Enumerations value
 
enum:Number (default = NaN)