Package | com.adobe.indesign |
Class | public class PreflightProcess |
Inheritance | PreflightProcess ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PreflightProcess | ||
![]() | 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. | PreflightProcess | ||
![]() | 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 | |
remove():void
Deletes the PreflightProcess. | PreflightProcess | ||
removeEventListenerPreflightProcess(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PreflightProcess | ||
![]() | 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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
aggregatedResults | property |
aggregatedResults:Object
[read-only] Since : | CS5 |
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.
public function get aggregatedResults():Object
appliedProfile | property |
appliedProfile:PreflightProfile
[read-only] Since : | CS5 |
The preflight profile the process is using.
public function get appliedProfile():PreflightProfile
description | property |
description:String
[read-only] Since : | CS5 |
The description of the PreflightProcess.
public function get description():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
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the PreflightProcess 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
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the PreflightProcess (a Application).
public function get parent():Application
processInventory | property |
processInventory:String
[read-only] Since : | CS5 |
A string containing a description of all elements visited by the process.
public function get processInventory():String
processResults | property |
processResults:String
[read-only] Since : | CS5 |
The results found by the process as a large string.
public function get processResults():String
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
targetObject | property |
targetObject:Document
[read-only] Since : | CS5 |
The target document the process is inspecting.
public function get targetObject():Document
addEventListenerPreflightProcess | () | method |
public function addEventListenerPreflightProcess(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 |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the PreflightProcess.
removeEventListenerPreflightProcess | () | method |
public function removeEventListenerPreflightProcess(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 |
saveReport | () | method |
public function saveReport(toParam:File = null, autoOpenParam:Boolean = false):void
Since : | CS5 |
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
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
waitForProcess | () | method |
public function waitForProcess(waitTimeParam:Number):Boolean
Since : | CS5 |
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)
|
Boolean |