Packagecom.adobe.indesign
Classpublic class MasterSpreads
InheritanceMasterSpreads Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
MasterSpreads
Public Methods
 MethodDefined By
  
add(pagesPerSpreadParam:Number, withPropertiesParam:Object = null):MasterSpread
Creates a new master spread.
MasterSpreads
  
Returns any MasterSpread in the collection.
MasterSpreads
  
count():Number
Displays the number of elements in the MasterSpread.
MasterSpreads
  
everyItem():Object
Returns every MasterSpread in the collection.
MasterSpreads
 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
  
Returns the first MasterSpread in the collection.
MasterSpreads
 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
 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
  
item(indexParam:Object = null):MasterSpread
Returns the MasterSpread with the specified index or name.
MasterSpreads
  
itemByID(idParam:Number):MasterSpread
Returns the MasterSpread with the specified ID.
MasterSpreads
  
itemByName(nameParam:String = null):MasterSpread
Returns the MasterSpread with the specified name.
MasterSpreads
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the MasterSpreads within the specified range.
MasterSpreads
  
Returns the last MasterSpread in the collection.
MasterSpreads
  
Returns the middle MasterSpread in the collection.
MasterSpreads
  
Returns the MasterSpread whose index follows the specified MasterSpread in the collection.
MasterSpreads
  
Returns the MasterSpread with the index previous to the specified index.
MasterSpreads
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
MasterSpreads
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
MasterSpreads
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(pagesPerSpreadParam:Number, withPropertiesParam:Object = null):MasterSpread

Creates a new master spread.

Parameters

pagesPerSpreadParam:Number (default = NaN) — (Number) The number of pages to include in the master spread. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new MasterSpread (Optional)

Returns
MasterSpread
anyItem()method 
public function anyItem():MasterSpread

Returns any MasterSpread in the collection.

Returns
MasterSpread
count()method 
public function count():Number

Displays the number of elements in the MasterSpread.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every MasterSpread in the collection.

Returns
Object
firstItem()method 
public function firstItem():MasterSpread

Returns the first MasterSpread in the collection.

Returns
MasterSpread
item()method 
public function item(indexParam:Object = null):MasterSpread

Returns the MasterSpread with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
MasterSpread
itemByID()method 
public function itemByID(idParam:Number):MasterSpread

Returns the MasterSpread with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
MasterSpread
itemByName()method 
public function itemByName(nameParam:String = null):MasterSpread

Returns the MasterSpread with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

Returns
MasterSpread
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the MasterSpreads within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The MasterSpread, index, or name at the beginning of the range. Can accept: MasterSpread, Long Integer or String.
 
toParam:Object (default = null) — (Object) The MasterSpread, index, or name at the end of the range. Can accept: MasterSpread, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():MasterSpread

Returns the last MasterSpread in the collection.

Returns
MasterSpread
middleItem()method 
public function middleItem():MasterSpread

Returns the middle MasterSpread in the collection.

Returns
MasterSpread
nextItem()method 
public function nextItem(objParam:MasterSpread = null):MasterSpread

Returns the MasterSpread whose index follows the specified MasterSpread in the collection.

Parameters

objParam:MasterSpread (default = null) — (MasterSpread) The MasterSpread whose index comes before the desired MasterSpread.

Returns
MasterSpread
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:MasterSpread = null):MasterSpread

Returns the MasterSpread with the index previous to the specified index.

Parameters

objParam:MasterSpread (default = null) — (MasterSpread) The index of the MasterSpread that follows the desired MasterSpread.

Returns
MasterSpread