Package | com.adobe.incopy |
Class | public class Spread |
Inheritance | Spread ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allGraphics : Object [read-only]
Lists all graphics contained by the Spread. | Spread | ||
allowPageShuffle : Boolean [read-only]
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 [read-only]
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 | ||
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 | ||
![]() | hostObjectDelegate : 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 | ||
parent : Document [read-only]
The parent of the Spread (a Document). | Spread | ||
polygons : Polygons [read-only]
A collection of polygons. | 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 | ||
splineItems : SplineItems [read-only]
The spline items collection. | Spread | ||
textFrames : TextFrames [read-only]
A collection of text frames. | Spread |
Method | Defined By | ||
---|---|---|---|
addEventListenerSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Spread | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Spread | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Spread | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Spread | ||
![]() | 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 | |
removeEventListenerSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Spread | ||
![]() | 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 | ||
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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Spread.
public function get allGraphics():Object
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
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Spread.
public function get allPageItems():Object
appliedMaster | property |
appliedMaster:MasterSpread
[read-only] Since : | CS5 |
The master spread applied to the Spread. Can also accept: NothingEnum enumerator.
public function get appliedMaster():MasterSpread
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
guides | property |
guides:Guides
[read-only] Since : | CS5 |
A collection of guides.
public function get guides():Guides
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Spread.
public function get id():Number
idmlComponentName | property |
idmlComponentName:String
Since : | CS5 |
The IDML component name of the Spread.
public function get idmlComponentName():String
public function set idmlComponentName(value:String):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Spread within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
Since : | CS5 |
The name of the Spread; this is an alias to the Spread's label property.
public function get name():String
public function set name(value:String):void
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
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.
public function get pageItems():PageItems
pages | property |
pages:Pages
[read-only] Since : | CS5 |
A collection of pages.
public function get pages():Pages
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the Spread (a Document).
public function get parent():Document
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
properties | property |
properties:Object
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
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
addEventListenerSpread | () | method |
public function addEventListenerSpread(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 |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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.
|
removeEventListenerSpread | () | method |
public function removeEventListenerSpread(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 |
resolve | () | method |
public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Since : | CS5 |
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)
|
Object |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
transform | () | method |
public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
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
Since : | CS5 |
Get the transformation values of the page item.
Parameters
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use
|
Object |