Packagecom.adobe.indesign
Classpublic class PreflightProcess
InheritancePreflightProcess Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  aggregatedResults : Object
[read-only] The aggregated results found by the process.
PreflightProcess
  appliedProfile : PreflightProfile
[read-only] The preflight profile the process is using.
PreflightProcess
  description : String
[read-only] The description of the PreflightProcess.
PreflightProcess
  eventListeners : EventListeners
[read-only] A collection of event listeners.
PreflightProcess
  events : Events
[read-only] A collection of events.
PreflightProcess
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the PreflightProcess within its containing object.
PreflightProcess
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
PreflightProcess
  parent : Application
[read-only] The parent of the PreflightProcess (a Application).
PreflightProcess
  processInventory : String
[read-only] A string containing a description of all elements visited by the process.
PreflightProcess
  processResults : String
[read-only] The results found by the process as a large string.
PreflightProcess
  properties : Object
A property that allows setting of several properties at the same time.
PreflightProcess
  targetObject : Document
[read-only] The target document the process is inspecting.
PreflightProcess
Public Methods
 MethodDefined By
  
addEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PreflightProcess
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
PreflightProcess
 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
  
remove():void
Deletes the PreflightProcess.
PreflightProcess
  
removeEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PreflightProcess
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
saveReport(toParam:File = null, autoOpenParam:Boolean = false):void
Saves a report of the completed preflight process.
PreflightProcess
  
toSpecifier():String
Retrieves the object specifier.
PreflightProcess
  
waitForProcess(waitTimeParam:Number):Boolean
Waits for the process to finish, up to an optional maximum amount of time.
PreflightProcess
 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
aggregatedResultsproperty
aggregatedResults:Object  [read-only]

The aggregated results found by the process. Can return: Ordered array containing documentName:String, profileName:String, results:Array of Ordered array containing parentNodeID:Long Integer, errorName:String, pageNumber:String, errorInfo:String, errorDetail:Array of Ordered array containing label:String, description:String.


Implementation
    public function get aggregatedResults():Object
appliedProfileproperty 
appliedProfile:PreflightProfile  [read-only]

The preflight profile the process is using.


Implementation
    public function get appliedProfile():PreflightProfile
descriptionproperty 
description:String  [read-only]

The description of the PreflightProcess.


Implementation
    public function get description():String
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the PreflightProcess within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Application  [read-only]

The parent of the PreflightProcess (a Application).


Implementation
    public function get parent():Application
processInventoryproperty 
processInventory:String  [read-only]

A string containing a description of all elements visited by the process.


Implementation
    public function get processInventory():String
processResultsproperty 
processResults:String  [read-only]

The results found by the process as a large string.


Implementation
    public function get processResults():String
propertiesproperty 
properties:Object

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
targetObjectproperty 
targetObject:Document  [read-only]

The target document the process is inspecting.


Implementation
    public function get targetObject():Document
Method Detail
addEventListenerPreflightProcess()method
public function addEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
getElements()method 
public function getElements():Object

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

Returns
Object
remove()method 
public function remove():void

Deletes the PreflightProcess.

removeEventListenerPreflightProcess()method 
public function removeEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
saveReport()method 
public function saveReport(toParam:File = null, autoOpenParam:Boolean = false):void

Saves a report of the completed preflight process.

Parameters

toParam:File (default = null) — (File) The preflight report to save to.
 
autoOpenParam:Boolean (default = false) — (Boolean) If true, automatically open the report after creation. (Optional)

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
waitForProcess()method 
public function waitForProcess(waitTimeParam:Number):Boolean

Waits for the process to finish, up to an optional maximum amount of time. No other processes get cycles during this time.

Parameters

waitTimeParam:Number (default = NaN) — (Number) The maximum time to wait, in seconds; if omitted, waits until completion no matter how long it takes. (Optional)

Returns
Boolean