Packagecom.adobe.indesign
Classpublic class BookContents
InheritanceBookContents 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.
BookContents
Public Methods
 MethodDefined By
  
add(fullNameParam:File = null, atParam:Number = -1, withPropertiesParam:Object = null):BookContent
Creates a new book content object.
BookContents
  
Returns any BookContent in the collection.
BookContents
  
count():Number
Displays the number of elements in the BookContent.
BookContents
  
everyItem():Object
Returns every BookContent in the collection.
BookContents
 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 BookContent in the collection.
BookContents
 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):BookContent
Returns the BookContent with the specified index or name.
BookContents
  
itemByID(idParam:Number):BookContent
Returns the BookContent with the specified ID.
BookContents
  
itemByName(nameParam:String = null):BookContent
Returns the BookContent with the specified name.
BookContents
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the BookContents within the specified range.
BookContents
  
Returns the last BookContent in the collection.
BookContents
  
Returns the middle BookContent in the collection.
BookContents
  
Returns the BookContent whose index follows the specified BookContent in the collection.
BookContents
  
Returns the BookContent with the index previous to the specified index.
BookContents
 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
BookContents
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
BookContents
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(fullNameParam:File = null, atParam:Number = -1, withPropertiesParam:Object = null):BookContent

Creates a new book content object.

Parameters

fullNameParam:File (default = null) — (File) The full path name of the new book content object.
 
atParam:Number (default = -1) — (Number) The location of the book content object within the book. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new BookContent (Optional)

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

Returns any BookContent in the collection.

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

Displays the number of elements in the BookContent.

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

Returns every BookContent in the collection.

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

Returns the first BookContent in the collection.

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

Returns the BookContent with the specified index or name.

Parameters

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

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

Returns the BookContent with the specified ID.

Parameters

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

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

Returns the BookContent with the specified name.

Parameters

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

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

Returns the BookContents within the specified range.

Parameters

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

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

Returns the last BookContent in the collection.

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

Returns the middle BookContent in the collection.

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

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

Parameters

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

Returns
BookContent
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:BookContent = null):BookContent

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

Parameters

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

Returns
BookContent