Package | com.adobe.indesign |
Class | public class PreflightOption |
Inheritance | PreflightOption ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | PreflightOption | ||
events : Events [override] [read-only]
A collection of events. | PreflightOption | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | PreflightOption | ||
![]() | 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 | |
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | PreflightOption | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the PreflightOption (a Application or Document).
public function get parent():Object
preflightEmbedWorkingProfile | property |
preflightEmbedWorkingProfile:Boolean
Since : | CS5 |
If true, embed working profile when creating new document.
public function get preflightEmbedWorkingProfile():Boolean
public function set preflightEmbedWorkingProfile(value:Boolean):void
preflightIncludeNonprintingObjects | property |
preflightIncludeNonprintingObjects:Boolean
Since : | CS5 |
If true, include objects that do not print when preflighting.
public function get preflightIncludeNonprintingObjects():Boolean
public function set preflightIncludeNonprintingObjects(value:Boolean):void
preflightIncludeObjectsOnPasteboard | property |
preflightIncludeObjectsOnPasteboard:Boolean
Since : | CS5 |
If true, include objects on pasteboard when preflighting.
public function get preflightIncludeObjectsOnPasteboard():Boolean
public function set preflightIncludeObjectsOnPasteboard(value:Boolean):void
preflightOff | property |
preflightOff:Boolean
Since : | CS5 |
If true, preflight is turned off for all documents or for this document.
public function get preflightOff():Boolean
public function set preflightOff(value:Boolean):void
preflightProfilePolicy | property |
preflightProfilePolicy:PreflightProfileOptions
Since : | CS5 |
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.
public function get preflightProfilePolicy():PreflightProfileOptions
public function set preflightProfilePolicy(value:PreflightProfileOptions):void
preflightScope | property |
preflightScope:Object
Since : | CS5 |
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.
public function get preflightScope():Object
public function set preflightScope(value:Object):void
preflightWhichLayers | property |
preflightWhichLayers:PreflightLayerOptions
Since : | CS5 |
Which layers to preflight.
public function get preflightWhichLayers():PreflightLayerOptions
public function set preflightWhichLayers(value:PreflightLayerOptions):void
preflightWorkingProfile | property |
preflightWorkingProfile:Object
Since : | CS5 |
The working preflight profile. Can return: PreflightProfile or String.
public function get preflightWorkingProfile():Object
public function set preflightWorkingProfile(value:Object):void
properties | property |
properties:Object
[override] 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
addEventListenerPreflightOption | () | method |
public function addEventListenerPreflightOption(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 |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerPreflightOption | () | method |
public function removeEventListenerPreflightOption(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 |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |