Package | com.adobe.incopy |
Class | public class DocumentPreference |
Inheritance | DocumentPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allowPageShuffle : Boolean [read-only]
If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. | DocumentPreference | ||
columnDirection : HorizontalOrVertical
The direction of text in the column. | DocumentPreference | ||
columnGuideColor : Object
The color of the column guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values,, or as a UI color. | DocumentPreference | ||
columnGuideLocked : Boolean
If true, locks column guides. | DocumentPreference | ||
documentBleedBottomOffset : Object [read-only]
The amount to offset the bottom document bleed. | DocumentPreference | ||
documentBleedInsideOrLeftOffset : Object [read-only]
The amount to offset the inside or left document bleed. | DocumentPreference | ||
documentBleedOutsideOrRightOffset : Object [read-only]
The amount to offset the outside or right document bleed. | DocumentPreference | ||
documentBleedTopOffset : Object [read-only]
The amount to offset the top document bleed. | DocumentPreference | ||
documentBleedUniformSize : Boolean [read-only]
If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. | DocumentPreference | ||
documentSlugUniformSize : Boolean [read-only]
If true, uses the slug top offset value for slug measurements on all sides of the document. | DocumentPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | DocumentPreference | ||
events : Events [override] [read-only]
A collection of events. | DocumentPreference | ||
facingPages : Boolean
If true, the document has facing pages. | DocumentPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
intent : DocumentIntentOptions [read-only]
The intent for a document. | DocumentPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | DocumentPreference | ||
marginGuideColor : Object
The color of the margin guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. | DocumentPreference | ||
masterTextFrame : Boolean [read-only]
If true, the document A-master has auto textframes. | DocumentPreference | ||
overprintBlack : Boolean [read-only]
If true, overprints black when saving the document. | DocumentPreference | ||
pageBinding : PageBindingOptions
The placement of the page binding. | DocumentPreference | ||
pageHeight : Object
The height of the page. | DocumentPreference | ||
pageOrientation : PageOrientation
The page orientation. | DocumentPreference | ||
pageSize : String
The size of the page. | DocumentPreference | ||
pagesPerDocument : Number [read-only]
The number of pages in the document. | DocumentPreference | ||
pageWidth : Object
The width of the page. | DocumentPreference | ||
parent : Object [override] [read-only]
The parent of the DocumentPreference (a Application or Document). | DocumentPreference | ||
preserveLayoutWhenShuffling : Boolean [read-only]
If true, preserves the layout of spreads that contained more than two pages when allow page shuffle was turned on. | DocumentPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | DocumentPreference | ||
slugBottomOffset : Object [read-only]
The amount to offset the bottom slug. | DocumentPreference | ||
slugInsideOrLeftOffset : Object [read-only]
The amount to offset the inside or left slug. | DocumentPreference | ||
slugRightOrOutsideOffset : Object [read-only]
The amount to offset the outside or right slug. | DocumentPreference | ||
slugTopOffset : Object [read-only]
The amount to offset the top slug. | DocumentPreference | ||
startPageNumber : Number [read-only]
The starting page number for a document. | DocumentPreference | ||
textAreaDepth : Number
The depth of the text area. | DocumentPreference | ||
textAreaDepthUnit : TextAreaDepthUnit
The unit in which to measure the text area depth. | DocumentPreference | ||
textAreaWidth : Object
The width of the text area. | DocumentPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerDocumentPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | DocumentPreference | ||
![]() | 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. | DocumentPreference | ||
![]() | 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 | |
removeEventListenerDocumentPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | DocumentPreference | ||
![]() | 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. | DocumentPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allowPageShuffle | property |
allowPageShuffle:Boolean
[read-only] Since : | CS5 |
If true, guarantees that when pages are added to a spread it will contain a maximum of two pages. If false, allows pages to be added or moved into existing spreads. For override information, see preserve layout when shuffling.
public function get allowPageShuffle():Boolean
columnDirection | property |
columnDirection:HorizontalOrVertical
Since : | CS5 |
The direction of text in the column.
public function get columnDirection():HorizontalOrVertical
public function set columnDirection(value:HorizontalOrVertical):void
columnGuideColor | property |
columnGuideColor:Object
Since : | CS5 |
The color of the column guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values,, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
public function get columnGuideColor():Object
public function set columnGuideColor(value:Object):void
columnGuideLocked | property |
columnGuideLocked:Boolean
Since : | CS5 |
If true, locks column guides.
public function get columnGuideLocked():Boolean
public function set columnGuideLocked(value:Boolean):void
documentBleedBottomOffset | property |
documentBleedBottomOffset:Object
[read-only] Since : | CS5 |
The amount to offset the bottom document bleed. Note: To set the bleed bottom offset, document bleed uniform size must be false.
public function get documentBleedBottomOffset():Object
documentBleedInsideOrLeftOffset | property |
documentBleedInsideOrLeftOffset:Object
[read-only] Since : | CS5 |
The amount to offset the inside or left document bleed. Note: To set the bleed inside or left offset, document bleed uniform size must be false.
public function get documentBleedInsideOrLeftOffset():Object
documentBleedOutsideOrRightOffset | property |
documentBleedOutsideOrRightOffset:Object
[read-only] Since : | CS5 |
The amount to offset the outside or right document bleed. Note: To set the bleed outside or right offset, document bleed uniform size must be false.
public function get documentBleedOutsideOrRightOffset():Object
documentBleedTopOffset | property |
documentBleedTopOffset:Object
[read-only] Since : | CS5 |
The amount to offset the top document bleed.
public function get documentBleedTopOffset():Object
documentBleedUniformSize | property |
documentBleedUniformSize:Boolean
[read-only] Since : | CS5 |
If true, uses the document bleed top offset value for bleed offset measurements on all sides of the document. The default setting is true.
public function get documentBleedUniformSize():Boolean
documentSlugUniformSize | property |
documentSlugUniformSize:Boolean
[read-only] Since : | CS5 |
If true, uses the slug top offset value for slug measurements on all sides of the document. The default value is false.
public function get documentSlugUniformSize():Boolean
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
facingPages | property |
facingPages:Boolean
Since : | CS5 |
If true, the document has facing pages.
public function get facingPages():Boolean
public function set facingPages(value:Boolean):void
intent | property |
intent:DocumentIntentOptions
[read-only] Since : | CS5 |
The intent for a document.
public function get intent():DocumentIntentOptions
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
marginGuideColor | property |
marginGuideColor:Object
Since : | CS5 |
The color of the margin guides, specified either as an array of three doubles, each in the range 0 to 255, representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
public function get marginGuideColor():Object
public function set marginGuideColor(value:Object):void
masterTextFrame | property |
masterTextFrame:Boolean
[read-only] Since : | CS5 |
If true, the document A-master has auto textframes.
public function get masterTextFrame():Boolean
overprintBlack | property |
overprintBlack:Boolean
[read-only] Since : | CS5 |
If true, overprints black when saving the document.
public function get overprintBlack():Boolean
pageBinding | property |
pageBinding:PageBindingOptions
Since : | CS5 |
The placement of the page binding.
public function get pageBinding():PageBindingOptions
public function set pageBinding(value:PageBindingOptions):void
pageHeight | property |
pageHeight:Object
Since : | CS5 |
The height of the page.
public function get pageHeight():Object
public function set pageHeight(value:Object):void
pageOrientation | property |
pageOrientation:PageOrientation
Since : | CS5 |
The page orientation.
public function get pageOrientation():PageOrientation
public function set pageOrientation(value:PageOrientation):void
pageSize | property |
pageSize:String
Since : | CS5 |
The size of the page.
public function get pageSize():String
public function set pageSize(value:String):void
pagesPerDocument | property |
pagesPerDocument:Number
[read-only] Since : | CS5 |
The number of pages in the document. (Range: 1 to 9999)
public function get pagesPerDocument():Number
pageWidth | property |
pageWidth:Object
Since : | CS5 |
The width of the page.
public function get pageWidth():Object
public function set pageWidth(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the DocumentPreference (a Application or Document).
public function get parent():Object
preserveLayoutWhenShuffling | property |
preserveLayoutWhenShuffling:Boolean
[read-only] Since : | CS5 |
If true, preserves the layout of spreads that contained more than two pages when allow page shuffle was turned on. If false, changes multi-page spreads to two-page spreads if the spreads were created or changed since allow page shuffle was turned on.
public function get preserveLayoutWhenShuffling():Boolean
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
slugBottomOffset | property |
slugBottomOffset:Object
[read-only] Since : | CS5 |
The amount to offset the bottom slug. Note: To set the slug bottom offset, document slug uniform size must be false.
public function get slugBottomOffset():Object
slugInsideOrLeftOffset | property |
slugInsideOrLeftOffset:Object
[read-only] Since : | CS5 |
The amount to offset the inside or left slug. Note: To set the slug inside or left offset, document slug uniform size must be false.
public function get slugInsideOrLeftOffset():Object
slugRightOrOutsideOffset | property |
slugRightOrOutsideOffset:Object
[read-only] Since : | CS5 |
The amount to offset the outside or right slug. Note: To set the slug right or outside offset, document slug uniform size must be false.
public function get slugRightOrOutsideOffset():Object
slugTopOffset | property |
slugTopOffset:Object
[read-only] Since : | CS5 |
The amount to offset the top slug.
public function get slugTopOffset():Object
startPageNumber | property |
startPageNumber:Number
[read-only] Since : | CS5 |
The starting page number for a document. This is the same as the starting page number for the first section of a document. Default value is 1.
public function get startPageNumber():Number
textAreaDepth | property |
textAreaDepth:Number
Since : | CS5 |
The depth of the text area.
public function get textAreaDepth():Number
public function set textAreaDepth(value:Number):void
textAreaDepthUnit | property |
textAreaDepthUnit:TextAreaDepthUnit
Since : | CS5 |
The unit in which to measure the text area depth.
public function get textAreaDepthUnit():TextAreaDepthUnit
public function set textAreaDepthUnit(value:TextAreaDepthUnit):void
textAreaWidth | property |
textAreaWidth:Object
Since : | CS5 |
The width of the text area.
public function get textAreaWidth():Object
public function set textAreaWidth(value:Object):void
addEventListenerDocumentPreference | () | method |
public function addEventListenerDocumentPreference(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 |
removeEventListenerDocumentPreference | () | method |
public function removeEventListenerDocumentPreference(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 |