Package | com.adobe.incopy |
Class | public class LayoutPrintPreference |
Inheritance | LayoutPrintPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
collating : Boolean
If true, collate printed copies. | LayoutPrintPreference | ||
copies : Number
The number of copies to print. | LayoutPrintPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | LayoutPrintPreference | ||
events : Events [override] [read-only]
A collection of events. | LayoutPrintPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | LayoutPrintPreference | ||
pageInformationMarks : Boolean
If true, prints the filename, page number, current date and time, and color separation name. | LayoutPrintPreference | ||
paperHeight : Object
The paper height. | LayoutPrintPreference | ||
paperSize : Object
The paper size, specified as either a string or an enumeration. | LayoutPrintPreference | ||
paperSizeList : Object [read-only]
A list of the available paper sizes. | LayoutPrintPreference | ||
paperWidth : Object
The paper width. | LayoutPrintPreference | ||
parent : Object [override] [read-only]
The parent of the LayoutPrintPreference (a Application). | LayoutPrintPreference | ||
printer : Object
The current printer. | LayoutPrintPreference | ||
printerList : Object [read-only]
Available printers. | LayoutPrintPreference | ||
printPageOrientation : PrintPageOrientation
The orientation of the printed page. | LayoutPrintPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | LayoutPrintPreference | ||
reverseOrder : Boolean
If true, prints pages in reverse order. | LayoutPrintPreference | ||
scaleHeight : Number
The amount (as a percentage) that the page height is scaled during printing. | LayoutPrintPreference | ||
scaleMode : ScaleModes
The policy for scaling the page. | LayoutPrintPreference | ||
scaleProportional : Boolean
If true, constrains the proportions of the scaling; uses the most recent value for either scale width or scale height to define both values. | LayoutPrintPreference | ||
scaleWidth : Number
The amount (as a percentage) that the page width is scaled during printing. | LayoutPrintPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerLayoutPrintPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | LayoutPrintPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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. | LayoutPrintPreference | ||
![]() | 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 | |
removeEventListenerLayoutPrintPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | LayoutPrintPreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | LayoutPrintPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
collating | property |
collating:Boolean
Since : | CS5 |
If true, collate printed copies.
public function get collating():Boolean
public function set collating(value:Boolean):void
copies | property |
copies:Number
Since : | CS5 |
The number of copies to print. Note: Not valid when printer is PostScript File.
public function get copies():Number
public function set copies(value:Number):void
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
pageInformationMarks | property |
pageInformationMarks:Boolean
Since : | CS5 |
If true, prints the filename, page number, current date and time, and color separation name.
public function get pageInformationMarks():Boolean
public function set pageInformationMarks(value:Boolean):void
paperHeight | property |
paperHeight:Object
Since : | CS5 |
The paper height. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.
public function get paperHeight():Object
public function set paperHeight(value:Object):void
paperSize | property |
paperSize:Object
Since : | CS5 |
The paper size, specified as either a string or an enumeration. For information on paper size names, see paper size list. Can return: PaperSizes enumerator or String.
public function get paperSize():Object
public function set paperSize(value:Object):void
paperSizeList | property |
paperSizeList:Object
[read-only] Since : | CS5 |
A list of the available paper sizes.
public function get paperSizeList():Object
paperWidth | property |
paperWidth:Object
Since : | CS5 |
The paper width. Note: Valid only when paper size is custom or scale mode is scale width height. Can return: PaperSize enumerator or Unit.
public function get paperWidth():Object
public function set paperWidth(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the LayoutPrintPreference (a Application).
public function get parent():Object
printer | property |
printer:Object
Since : | CS5 |
The current printer. Can return: Printer enumerator or String.
public function get printer():Object
public function set printer(value:Object):void
printerList | property |
printerList:Object
[read-only] Since : | CS5 |
Available printers.
public function get printerList():Object
printPageOrientation | property |
printPageOrientation:PrintPageOrientation
Since : | CS5 |
The orientation of the printed page.
public function get printPageOrientation():PrintPageOrientation
public function set printPageOrientation(value:PrintPageOrientation):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
reverseOrder | property |
reverseOrder:Boolean
Since : | CS5 |
If true, prints pages in reverse order.
public function get reverseOrder():Boolean
public function set reverseOrder(value:Boolean):void
scaleHeight | property |
scaleHeight:Number
Since : | CS5 |
The amount (as a percentage) that the page height is scaled during printing. (Range: 0 to 1000) Note: Valid only when scale mode is scale width height.
public function get scaleHeight():Number
public function set scaleHeight(value:Number):void
scaleMode | property |
scaleMode:ScaleModes
Since : | CS5 |
The policy for scaling the page. Note: Valid only when printing from Layout view.
public function get scaleMode():ScaleModes
public function set scaleMode(value:ScaleModes):void
scaleProportional | property |
scaleProportional:Boolean
Since : | CS5 |
If true, constrains the proportions of the scaling; uses the most recent value for either scale width or scale height to define both values. Note: Valid only when scale mode is scale width height.
public function get scaleProportional():Boolean
public function set scaleProportional(value:Boolean):void
scaleWidth | property |
scaleWidth:Number
Since : | CS5 |
The amount (as a percentage) that the page width is scaled during printing. (Range: 0 to 1000) Note: Valid only when scale mode is scale width height.
public function get scaleWidth():Number
public function set scaleWidth(value:Number):void
addEventListenerLayoutPrintPreference | () | method |
public function addEventListenerLayoutPrintPreference(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 |
removeEventListenerLayoutPrintPreference | () | method |
public function removeEventListenerLayoutPrintPreference(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 |