Packagecom.adobe.indesign
Classpublic class Spread
InheritanceSpread Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allGraphics : Object
[read-only] Lists all graphics contained by the Spread.
Spread
  allowPageShuffle : Boolean
If true, guarantees that when pages are added to a spread it will contain a maximum of two pages.
Spread
  allPageItems : Object
[read-only] Lists all page items contained by the Spread.
Spread
  appliedMaster : MasterSpread
The master spread applied to the Spread.
Spread
  buttons : Buttons
[read-only] A collection of buttons.
Spread
  epstexts : EPSTexts
[read-only] EPSTexts
Spread
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Spread
  events : Events
[read-only] A collection of events.
Spread
  flattenerOverride : SpreadFlattenerLevel
The transparency flattener preferences override for the spread.
Spread
  flattenerPreferences : FlattenerPreference
[read-only] Flattener preference settings.
Spread
  formFields : FormFields
[read-only] A collection of form fields.
Spread
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
Spread
  groups : Groups
[read-only] A collection of groups.
Spread
  guides : Guides
[read-only] A collection of guides.
Spread
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Spread.
Spread
  idmlComponentName : String
The IDML component name of the Spread.
Spread
  index : Number
[read-only] The index of the Spread within its containing object.
Spread
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Spread
  label : String
A property that can be set to any string.
Spread
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
Spread
  name : String
The name of the Spread; this is an alias to the Spread's label property.
Spread
  ovals : Ovals
[read-only] A collection of ellipses.
Spread
  pageItems : PageItems
[read-only] The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
Spread
  pages : Pages
[read-only] A collection of pages.
Spread
  pageTransitionDirection : PageTransitionDirectionOptions
The direction of the page transition.
Spread
  pageTransitionDuration : PageTransitionDurationOptions
The duration of the page transition.
Spread
  pageTransitionType : PageTransitionTypeOptions
The type of page transition.
Spread
  parent : Document
[read-only] The parent of the Spread (a Document).
Spread
  polygons : Polygons
[read-only] A collection of polygons.
Spread
  preferences : Preferences
[read-only] A collection of preferences objects.
Spread
  properties : Object
A property that allows setting of several properties at the same time.
Spread
  rectangles : Rectangles
[read-only] A collection of rectangles.
Spread
  showMasterItems : Boolean
If true, displays master page items on document pages in the spread.
Spread
  splineItems : SplineItems
[read-only] The spline items collection.
Spread
  textFrames : TextFrames
[read-only] A collection of text frames.
Spread
  timingSettings : TimingSetting
[read-only] The object timing settings.
Spread
Public Methods
 MethodDefined By
  
addEventListenerSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Spread
  
createGuides(numberOfRowsParam:Number = 0, numberOfColumnsParam:Number = 0, rowGutterParam:Object = 0, columnGutterParam:Object = 0, guideColorParam:Object = null, fitMarginsParam:Boolean = false, removeExistingParam:Boolean = false, layerParam:Layer = null):void
Creates multiple guides on all pages of the spread.
Spread
  
detach():void
Detaches an overridden master page item from the master page.
Spread
  
duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Object
Duplicates the spread.
Spread
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Spread
 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
Resolves the object specifier, creating an array of object references.
Spread
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Spread
 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
  
move(toParam:LocationOptions = null, referenceParam:Object = null):Spread
Moves the spread.
Spread
  
place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file.
Spread
  
placeXML(usingParam:XMLElement = null, placePointParam:Array = null, autoflowingParam:Boolean = false):PageItem
Places the XML element onto a page.
Spread
  
remove():void
Deletes the Spread.
Spread
  
removeEventListenerSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Spread
  
Removes the override from a previously overridden master page item.
Spread
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Get the coordinates of the given location in the specified coordinate system.
Spread
  
select(existingSelectionParam:SelectionOptions = null):void
Selects the object.
Spread
  
setContent(usingParam:String = null, relativeBasePathParam:String = null):PageItem
Replaces the content of XML element with content imported from a file.
Spread
  
toSpecifier():String
Retrieves the object specifier.
Spread
  
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Transform the page item.
Spread
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
Get the transformation values of the page item.
Spread
 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
allGraphicsproperty
allGraphics:Object  [read-only]

Lists all graphics contained by the Spread.


Implementation
    public function get allGraphics():Object
allowPageShuffleproperty 
allowPageShuffle:Boolean

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.


Implementation
    public function get allowPageShuffle():Boolean
    public function set allowPageShuffle(value:Boolean):void
allPageItemsproperty 
allPageItems:Object  [read-only]

Lists all page items contained by the Spread.


Implementation
    public function get allPageItems():Object
appliedMasterproperty 
appliedMaster:MasterSpread

The master spread applied to the Spread. Can also accept: NothingEnum enumerator.


Implementation
    public function get appliedMaster():MasterSpread
    public function set appliedMaster(value:MasterSpread):void
buttonsproperty 
buttons:Buttons  [read-only]

A collection of buttons.


Implementation
    public function get buttons():Buttons
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
flattenerOverrideproperty 
flattenerOverride:SpreadFlattenerLevel

The transparency flattener preferences override for the spread.


Implementation
    public function get flattenerOverride():SpreadFlattenerLevel
    public function set flattenerOverride(value:SpreadFlattenerLevel):void
flattenerPreferencesproperty 
flattenerPreferences:FlattenerPreference  [read-only]

Flattener preference settings.


Implementation
    public function get flattenerPreferences():FlattenerPreference
formFieldsproperty 
formFields:FormFields  [read-only]

A collection of form fields.


Implementation
    public function get formFields():FormFields
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
guidesproperty 
guides:Guides  [read-only]

A collection of guides.


Implementation
    public function get guides():Guides
idproperty 
id:Number  [read-only]

The unique ID of the Spread.


Implementation
    public function get id():Number
idmlComponentNameproperty 
idmlComponentName:String

The IDML component name of the Spread.


Implementation
    public function get idmlComponentName():String
    public function set idmlComponentName(value:String):void
indexproperty 
index:Number  [read-only]

The index of the Spread within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String

The name of the Spread; this is an alias to the Spread's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemsproperty 
pageItems:PageItems  [read-only]

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.


Implementation
    public function get pageItems():PageItems
pagesproperty 
pages:Pages  [read-only]

A collection of pages.


Implementation
    public function get pages():Pages
pageTransitionDirectionproperty 
pageTransitionDirection:PageTransitionDirectionOptions

The direction of the page transition.


Implementation
    public function get pageTransitionDirection():PageTransitionDirectionOptions
    public function set pageTransitionDirection(value:PageTransitionDirectionOptions):void
pageTransitionDurationproperty 
pageTransitionDuration:PageTransitionDurationOptions

The duration of the page transition.


Implementation
    public function get pageTransitionDuration():PageTransitionDurationOptions
    public function set pageTransitionDuration(value:PageTransitionDurationOptions):void
pageTransitionTypeproperty 
pageTransitionType:PageTransitionTypeOptions

The type of page transition.


Implementation
    public function get pageTransitionType():PageTransitionTypeOptions
    public function set pageTransitionType(value:PageTransitionTypeOptions):void
parentproperty 
parent:Document  [read-only]

The parent of the Spread (a Document).


Implementation
    public function get parent():Document
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object

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
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
showMasterItemsproperty 
showMasterItems:Boolean

If true, displays master page items on document pages in the spread.


Implementation
    public function get showMasterItems():Boolean
    public function set showMasterItems(value:Boolean):void
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
timingSettingsproperty 
timingSettings:TimingSetting  [read-only]

The object timing settings.


Implementation
    public function get timingSettings():TimingSetting
Method Detail
addEventListenerSpread()method
public function addEventListenerSpread(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
createGuides()method 
public function createGuides(numberOfRowsParam:Number = 0, numberOfColumnsParam:Number = 0, rowGutterParam:Object = 0, columnGutterParam:Object = 0, guideColorParam:Object = null, fitMarginsParam:Boolean = false, removeExistingParam:Boolean = false, layerParam:Layer = null):void

Creates multiple guides on all pages of the spread.

Parameters

numberOfRowsParam:Number (default = 0) — (Number) The number of rows to create on each page. (Optional)
 
numberOfColumnsParam:Number (default = 0) — (Number) The number of columns to create on each page. (Optional)
 
rowGutterParam:Object (default = 0) — (Object) The height of the gutter between rows. (Optional)
 
columnGutterParam:Object (default = 0) — (Object) The width of the gutter between columns. (Optional)
 
guideColorParam:Object (default = null) — (Object) The color to make the 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 accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional)
 
fitMarginsParam:Boolean (default = false) — (Boolean) If true, the row height and column width are calculated based on the space within the page margins. If false, row height and column width are calculated based on the full page. (Optional)
 
removeExistingParam:Boolean (default = false) — (Boolean) If true, removes existing guides when creating new ones. (Optional)
 
layerParam:Layer (default = null) — (Layer) The layer on which to create the guides. (Optional)

detach()method 
public function detach():void

Detaches an overridden master page item from the master page.

duplicate()method 
public function duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Object

Duplicates the spread.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The location of the spread relative to the reference object or within the document. (Optional)
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread. (Optional)

Returns
Object
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

move()method 
public function move(toParam:LocationOptions = null, referenceParam:Object = null):Spread

Moves the spread.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The location of the spread relative to the reference object or within the document. (Optional)
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional)

Returns
Spread
place()method 
public function place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object

Places the file.

Parameters

fileNameParam:File (default = null) — (File) The file to place
 
placePointParam:Array (default = null) — (Array) The point at which to place (Optional)
 
destinationLayerParam:Layer (default = null) — (Layer) The layer on which to place (Optional)
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog (Optional)
 
autoflowingParam:Boolean (default = false) — (Boolean) Whether to autoflow placed text (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the placed object(s) (Optional)

Returns
Object
placeXML()method 
public function placeXML(usingParam:XMLElement = null, placePointParam:Array = null, autoflowingParam:Boolean = false):PageItem

Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.

Parameters

usingParam:XMLElement (default = null) — (XMLElement) The XML element to place.
 
placePointParam:Array (default = null) — (Array) The point at which to place the object, specified in the format [x, y].
 
autoflowingParam:Boolean (default = false) — (Boolean) If true, autoflows placed text. (Optional)

Returns
PageItem
remove()method 
public function remove():void

Deletes the Spread.

removeEventListenerSpread()method 
public function removeEventListenerSpread(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
removeOverride()method 
public function removeOverride():void

Removes the override from a previously overridden master page item.

resolve()method 
public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object

Get the coordinates of the given location in the specified coordinate system.

Parameters

locationParam:Object (default = null) — (Object) The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use.
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

Returns
Object
select()method 
public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the Spread in relation to previously selected objects. (Optional)

setContent()method 
public function setContent(usingParam:String = null, relativeBasePathParam:String = null):PageItem

Replaces the content of XML element with content imported from a file.

Parameters

usingParam:String (default = null) — (String) The file path to the import file.
 
relativeBasePathParam:String (default = null) — (String) Base path used to resolve relative paths. (Optional)

Returns
PageItem
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
transform()method 
public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void

Transform the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use
 
fromParam:Object (default = null) — (Object) The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
withMatrixParam:Object (default = null) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
 
replacingCurrentParam:Object (default = null) — (Object) Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

transformValuesOf()method 
public function transformValuesOf(inParam:CoordinateSpaces = null):Object

Get the transformation values of the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use

Returns
Object