Packagecom.adobe.incopy
Classpublic class MasterSpread
InheritanceMasterSpread Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5



Public Properties
 PropertyDefined By
  allGraphics : Object
[read-only] Lists all graphics contained by the MasterSpread.
MasterSpread
  allPageItems : Object
[read-only] Lists all page items contained by the MasterSpread.
MasterSpread
  appliedMaster : MasterSpread
[read-only] The master spread applied to the MasterSpread.
MasterSpread
  baseName : String
[read-only] The name of the master spread.
MasterSpread
  buttons : Buttons
[read-only] A collection of buttons.
MasterSpread
  epstexts : EPSTexts
[read-only] EPSTexts
MasterSpread
  eventListeners : EventListeners
[read-only] A collection of event listeners.
MasterSpread
  events : Events
[read-only] A collection of events.
MasterSpread
  formFields : FormFields
[read-only] A collection of form fields.
MasterSpread
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
MasterSpread
  groups : Groups
[read-only] A collection of groups.
MasterSpread
  guides : Guides
[read-only] A collection of guides.
MasterSpread
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the MasterSpread.
MasterSpread
  idmlComponentName : String
The IDML component name of the MasterSpread.
MasterSpread
  index : Number
[read-only] The index of the MasterSpread within its containing object.
MasterSpread
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
MasterSpread
  label : String
A property that can be set to any string.
MasterSpread
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
MasterSpread
  name : String
[read-only] The name of the MasterSpread.
MasterSpread
  namePrefix : String
[read-only] The prefix of the master spread name.
MasterSpread
  ovals : Ovals
[read-only] A collection of ellipses.
MasterSpread
  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.
MasterSpread
  pages : Pages
[read-only] A collection of pages.
MasterSpread
  parent : Document
[read-only] The parent of the MasterSpread (a Document).
MasterSpread
  polygons : Polygons
[read-only] A collection of polygons.
MasterSpread
  properties : Object
A property that allows setting of several properties at the same time.
MasterSpread
  rectangles : Rectangles
[read-only] A collection of rectangles.
MasterSpread
  splineItems : SplineItems
[read-only] The spline items collection.
MasterSpread
  textFrames : TextFrames
[read-only] A collection of text frames.
MasterSpread
Public Methods
 MethodDefined By
  
addEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
MasterSpread
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
MasterSpread
 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.
MasterSpread
 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.
MasterSpread
 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
  
removeEventListenerMasterSpread(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
MasterSpread
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
MasterSpread
 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]

Since : CS5

Lists all graphics contained by the MasterSpread.


Implementation
    public function get allGraphics():Object
allPageItemsproperty 
allPageItems:Object  [read-only]

Since : CS5

Lists all page items contained by the MasterSpread.


Implementation
    public function get allPageItems():Object
appliedMasterproperty 
appliedMaster:MasterSpread  [read-only]

Since : CS5

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


Implementation
    public function get appliedMaster():MasterSpread
baseNameproperty 
baseName:String  [read-only]

Since : CS5

The name of the master spread.


Implementation
    public function get baseName():String
buttonsproperty 
buttons:Buttons  [read-only]

Since : CS5

A collection of buttons.


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

Since : CS5

EPSTexts


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

Since : CS5

A collection of event listeners.


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

Since : CS5

A collection of events.


Implementation
    public function get events():Events
formFieldsproperty 
formFields:FormFields  [read-only]

Since : CS5

A collection of form fields.


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

Since : CS5

A collection of graphic lines.


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

Since : CS5

A collection of groups.


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

Since : CS5

A collection of guides.


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

Since : CS5

The unique ID of the MasterSpread.


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

Since : CS5

The IDML component name of the MasterSpread.


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

Since : CS5

The index of the MasterSpread within its containing object.


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

Since : CS5

Returns true if the object specifier resolves to valid objects.


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

Since : CS5

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]

Since : CS5

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String  [read-only]

Since : CS5

The name of the MasterSpread.


Implementation
    public function get name():String
namePrefixproperty 
namePrefix:String  [read-only]

Since : CS5

The prefix of the master spread name.


Implementation
    public function get namePrefix():String
ovalsproperty 
ovals:Ovals  [read-only]

Since : CS5

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemsproperty 
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.


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

Since : CS5

A collection of pages.


Implementation
    public function get pages():Pages
parentproperty 
parent:Document  [read-only]

Since : CS5

The parent of the MasterSpread (a Document).


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

Since : CS5

A collection of polygons.


Implementation
    public function get polygons():Polygons
propertiesproperty 
properties:Object

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

Since : CS5

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
splineItemsproperty 
splineItems:SplineItems  [read-only]

Since : CS5

The spline items collection.


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

Since : CS5

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
Method Detail
addEventListenerMasterSpread()method
public function addEventListenerMasterSpread(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
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.

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

Since : CS5

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

Returns
Object
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.

removeEventListenerMasterSpread()method 
public function removeEventListenerMasterSpread(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 
public function toSpecifier():String

Since : CS5

Retrieves the object specifier.

Returns
String