Packagecom.adobe.indesign
Classpublic class PreflightOption
InheritancePreflightOption Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
PreflightOption
  events : Events
[override] [read-only] A collection of events.
PreflightOption
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
PreflightOption
  parent : Object
[override] [read-only] The parent of the PreflightOption (a Application or Document).
PreflightOption
  preflightEmbedWorkingProfile : Boolean
If true, embed working profile when creating new document.
PreflightOption
  preflightIncludeNonprintingObjects : Boolean
If true, include objects that do not print when preflighting.
PreflightOption
  preflightIncludeObjectsOnPasteboard : Boolean
If true, include objects on pasteboard when preflighting.
PreflightOption
  preflightOff : Boolean
If true, preflight is turned off for all documents or for this document.
PreflightOption
  preflightProfilePolicy : PreflightProfileOptions
The policy for preflighting applied when opening a document or book, whether to use embedded profile or the another profile when the preflight is turned on.
PreflightOption
  preflightScope : Object
The pages or documents to preflight, specified either as an enumeration or a string.
PreflightOption
  preflightWhichLayers : PreflightLayerOptions
Which layers to preflight.
PreflightOption
  preflightWorkingProfile : Object
The working preflight profile.
PreflightOption
  properties : Object
[override] A property that allows setting of several properties at the same time.
PreflightOption
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerPreflightOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PreflightOption
 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
[override] Resolves the object specifier, creating an array of object references.
PreflightOption
 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
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerPreflightOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PreflightOption
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
PreflightOption
 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
eventListenersproperty
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


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

The parent of the PreflightOption (a Application or Document).


Implementation
    public function get parent():Object
preflightEmbedWorkingProfileproperty 
preflightEmbedWorkingProfile:Boolean

If true, embed working profile when creating new document.


Implementation
    public function get preflightEmbedWorkingProfile():Boolean
    public function set preflightEmbedWorkingProfile(value:Boolean):void
preflightIncludeNonprintingObjectsproperty 
preflightIncludeNonprintingObjects:Boolean

If true, include objects that do not print when preflighting.


Implementation
    public function get preflightIncludeNonprintingObjects():Boolean
    public function set preflightIncludeNonprintingObjects(value:Boolean):void
preflightIncludeObjectsOnPasteboardproperty 
preflightIncludeObjectsOnPasteboard:Boolean

If true, include objects on pasteboard when preflighting.


Implementation
    public function get preflightIncludeObjectsOnPasteboard():Boolean
    public function set preflightIncludeObjectsOnPasteboard(value:Boolean):void
preflightOffproperty 
preflightOff:Boolean

If true, preflight is turned off for all documents or for this document.


Implementation
    public function get preflightOff():Boolean
    public function set preflightOff(value:Boolean):void
preflightProfilePolicyproperty 
preflightProfilePolicy:PreflightProfileOptions

The policy for preflighting applied when opening a document or book, whether to use embedded profile or the another profile when the preflight is turned on.


Implementation
    public function get preflightProfilePolicy():PreflightProfileOptions
    public function set preflightProfilePolicy(value:PreflightProfileOptions):void
preflightScopeproperty 
preflightScope:Object

The pages or documents to preflight, specified either as an enumeration or a string. To specify a range, separate page numbers in the string with a hyphen (-). To specify separate pages, separate page numbers in the string with a comma (,). Can return: PreflightScopeOptions enumerator or String.


Implementation
    public function get preflightScope():Object
    public function set preflightScope(value:Object):void
preflightWhichLayersproperty 
preflightWhichLayers:PreflightLayerOptions

Which layers to preflight.


Implementation
    public function get preflightWhichLayers():PreflightLayerOptions
    public function set preflightWhichLayers(value:PreflightLayerOptions):void
preflightWorkingProfileproperty 
preflightWorkingProfile:Object

The working preflight profile. Can return: PreflightProfile or String.


Implementation
    public function get preflightWorkingProfile():Object
    public function set preflightWorkingProfile(value:Object):void
propertiesproperty 
properties:Object[override]

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
Method Detail
addEventListenerPreflightOption()method
public function addEventListenerPreflightOption(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 
override public function getElements():Object

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

Returns
Object
removeEventListenerPreflightOption()method 
public function removeEventListenerPreflightOption(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
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String