Packagecom.adobe.incopy
Classpublic class GalleyPrintPreference
InheritanceGalleyPrintPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Preference



Public Properties
 PropertyDefined By
  appliedFont : String
The name of the font.
GalleyPrintPreference
  collating : Boolean
If true, collate printed copies.
GalleyPrintPreference
  copies : Number
The number of copies to print.
GalleyPrintPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
GalleyPrintPreference
  events : Events
[override] [read-only] A collection of events.
GalleyPrintPreference
  fontStyle : String
The name of the font style.
GalleyPrintPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
GalleyPrintPreference
  leading : Number
The default amount of space as a percentage to include between two lines of text.
GalleyPrintPreference
  lineRange : Object
The range of lines to print.
GalleyPrintPreference
  paperHeight : Object
The paper height.
GalleyPrintPreference
  paperSize : Object
The paper size, specified as either a string or an enumeration.
GalleyPrintPreference
  paperSizeList : Object
[read-only] A list of the available paper sizes.
GalleyPrintPreference
  paperWidth : Object
The paper width.
GalleyPrintPreference
  parent : Object
[override] [read-only] The parent of the GalleyPrintPreference (a Application).
GalleyPrintPreference
  pointSize : Object
The default text size (in points).
GalleyPrintPreference
  printAccurateLineEndings : Boolean
If true, prints line endings as they appear in the story.
GalleyPrintPreference
  printAllStories : Boolean
If true, prints all stories.
GalleyPrintPreference
  printer : Object
The current printer.
GalleyPrintPreference
  printerList : Object
[read-only] Available printers.
GalleyPrintPreference
  printInlineNotes : VisibilityModes
The inline notes to print.
GalleyPrintPreference
  printLineNumbers : Boolean
If true, prints the line numbers column.
GalleyPrintPreference
  printNotesBackground : Boolean
If true, prints inline notes in the colors assigned to the individuals who authored the notes.
GalleyPrintPreference
  printPageInfo : Boolean
If true, prints the filename, page number, current date and time, and color separation name.
GalleyPrintPreference
  printPageOrientation : PrintPageOrientation
The orientation of the printed page.
GalleyPrintPreference
  printParagraphStyles : Boolean
If true, prints the paragraph style column.
GalleyPrintPreference
  printStoryInfo : Boolean
If true, prints the story name(s).
GalleyPrintPreference
  printTrackedChanges : VisibilityModes
The tracked changes to print.
GalleyPrintPreference
  printTrackedChangesBackground : Boolean
If true, prints tracked changes in the colors assigned to each person who made changes.
GalleyPrintPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
GalleyPrintPreference
  reverseOrder : Boolean
If true, prints pages in reverse order.
GalleyPrintPreference
  textColumnWidth : Number
The columns width in inches.
GalleyPrintPreference
  useGalleySettings : Boolean
If true, uses the current galley settings.
GalleyPrintPreference
  useMultipleColumns : Boolean
If true, uses multiple columns to fill the page.
GalleyPrintPreference
Public Methods
 MethodDefined By
  
addEventListenerGalleyPrintPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
GalleyPrintPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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.
GalleyPrintPreference
 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
  
removeEventListenerGalleyPrintPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
GalleyPrintPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
GalleyPrintPreference
 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
appliedFontproperty
appliedFont:String

Since : CS5

The name of the font.


Implementation
    public function get appliedFont():String
    public function set appliedFont(value:String):void
collatingproperty 
collating:Boolean

Since : CS5

If true, collate printed copies.


Implementation
    public function get collating():Boolean
    public function set collating(value:Boolean):void
copiesproperty 
copies:Number

Since : CS5

The number of copies to print. Note: Not valid when printer is PostScript File.


Implementation
    public function get copies():Number
    public function set copies(value:Number):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

Since : CS5

A collection of event listeners.


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

Since : CS5

A collection of events.


Implementation
    public function get events():Events
fontStyleproperty 
fontStyle:String

Since : CS5

The name of the font style.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Since : CS5

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leadingproperty 
leading:Number

Since : CS5

The default amount of space as a percentage to include between two lines of text. (Range: 100 to 300)


Implementation
    public function get leading():Number
    public function set leading(value:Number):void
lineRangeproperty 
lineRange:Object

Since : CS5

The range of lines to print. Can return: LineRange enumerator or String.


Implementation
    public function get lineRange():Object
    public function set lineRange(value:Object):void
paperHeightproperty 
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.


Implementation
    public function get paperHeight():Object
    public function set paperHeight(value:Object):void
paperSizeproperty 
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.


Implementation
    public function get paperSize():Object
    public function set paperSize(value:Object):void
paperSizeListproperty 
paperSizeList:Object  [read-only]

Since : CS5

A list of the available paper sizes.


Implementation
    public function get paperSizeList():Object
paperWidthproperty 
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.


Implementation
    public function get paperWidth():Object
    public function set paperWidth(value:Object):void
parentproperty 
parent:Object  [read-only] [override]

Since : CS5

The parent of the GalleyPrintPreference (a Application).


Implementation
    public function get parent():Object
pointSizeproperty 
pointSize:Object

Since : CS5

The default text size (in points). (Range: 4 to 72).


Implementation
    public function get pointSize():Object
    public function set pointSize(value:Object):void
printAccurateLineEndingsproperty 
printAccurateLineEndings:Boolean

Since : CS5

If true, prints line endings as they appear in the story. Note: Valid only when use galley settings is false.


Implementation
    public function get printAccurateLineEndings():Boolean
    public function set printAccurateLineEndings(value:Boolean):void
printAllStoriesproperty 
printAllStories:Boolean

Since : CS5

If true, prints all stories. If false, prints only the current story.


Implementation
    public function get printAllStories():Boolean
    public function set printAllStories(value:Boolean):void
printerproperty 
printer:Object

Since : CS5

The current printer. Can return: Printer enumerator or String.


Implementation
    public function get printer():Object
    public function set printer(value:Object):void
printerListproperty 
printerList:Object  [read-only]

Since : CS5

Available printers.


Implementation
    public function get printerList():Object
printInlineNotesproperty 
printInlineNotes:VisibilityModes

Since : CS5

The inline notes to print. Note: Valid only when use galley settings is false.


Implementation
    public function get printInlineNotes():VisibilityModes
    public function set printInlineNotes(value:VisibilityModes):void
printLineNumbersproperty 
printLineNumbers:Boolean

Since : CS5

If true, prints the line numbers column. Note: Valid only when print accurate line endings is true.


Implementation
    public function get printLineNumbers():Boolean
    public function set printLineNumbers(value:Boolean):void
printNotesBackgroundproperty 
printNotesBackground:Boolean

Since : CS5

If true, prints inline notes in the colors assigned to the individuals who authored the notes. Note: Valid only when print inline notes is true.


Implementation
    public function get printNotesBackground():Boolean
    public function set printNotesBackground(value:Boolean):void
printPageInfoproperty 
printPageInfo:Boolean

Since : CS5

If true, prints the filename, page number, current date and time, and color separation name.


Implementation
    public function get printPageInfo():Boolean
    public function set printPageInfo(value:Boolean):void
printPageOrientationproperty 
printPageOrientation:PrintPageOrientation

Since : CS5

The orientation of the printed page.


Implementation
    public function get printPageOrientation():PrintPageOrientation
    public function set printPageOrientation(value:PrintPageOrientation):void
printParagraphStylesproperty 
printParagraphStyles:Boolean

Since : CS5

If true, prints the paragraph style column. Note: Valid only when use galley settings is false.


Implementation
    public function get printParagraphStyles():Boolean
    public function set printParagraphStyles(value:Boolean):void
printStoryInfoproperty 
printStoryInfo:Boolean

Since : CS5

If true, prints the story name(s). Note: Valid only when use galley settings is false.


Implementation
    public function get printStoryInfo():Boolean
    public function set printStoryInfo(value:Boolean):void
printTrackedChangesproperty 
printTrackedChanges:VisibilityModes

Since : CS5

The tracked changes to print. Note: Valid only when use galley settings is false.


Implementation
    public function get printTrackedChanges():VisibilityModes
    public function set printTrackedChanges(value:VisibilityModes):void
printTrackedChangesBackgroundproperty 
printTrackedChangesBackground:Boolean

Since : CS5

If true, prints tracked changes in the colors assigned to each person who made changes. Note: Valid only when print tracked changes is true.


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

Since : CS5

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
reverseOrderproperty 
reverseOrder:Boolean

Since : CS5

If true, prints pages in reverse order.


Implementation
    public function get reverseOrder():Boolean
    public function set reverseOrder(value:Boolean):void
textColumnWidthproperty 
textColumnWidth:Number

Since : CS5

The columns width in inches. Note: Valid only when use multiple columns is true.


Implementation
    public function get textColumnWidth():Number
    public function set textColumnWidth(value:Number):void
useGalleySettingsproperty 
useGalleySettings:Boolean

Since : CS5

If true, uses the current galley settings. If false, allows overrides of current galley settings.


Implementation
    public function get useGalleySettings():Boolean
    public function set useGalleySettings(value:Boolean):void
useMultipleColumnsproperty 
useMultipleColumns:Boolean

Since : CS5

If true, uses multiple columns to fill the page. Note: Valid only when print accurate line endings is true.


Implementation
    public function get useMultipleColumns():Boolean
    public function set useMultipleColumns(value:Boolean):void
Method Detail
addEventListenerGalleyPrintPreference()method
public function addEventListenerGalleyPrintPreference(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)

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

Since : CS5

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

Returns
Object
removeEventListenerGalleyPrintPreference()method 
public function removeEventListenerGalleyPrintPreference(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)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Since : CS5

Retrieves the object specifier.

Returns
String