Packagecom.adobe.indesign
Classpublic class Documents
InheritanceDocuments 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.
Documents
Public Methods
 MethodDefined By
  
add(showingWindowParam:Boolean = true, documentPresetParam:DocumentPreset = null, withPropertiesParam:Object = null):Document
Creates a new document.
Documents
  
Returns any Document in the collection.
Documents
  
count():Number
Displays the number of elements in the Document.
Documents
  
everyItem():Object
Returns every Document in the collection.
Documents
 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 Document in the collection.
Documents
 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):Document
Returns the Document with the specified index or name.
Documents
  
itemByID(idParam:Number):Document
Returns the Document with the specified ID.
Documents
  
itemByName(nameParam:String = null):Document
Returns the Document with the specified name.
Documents
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the Documents within the specified range.
Documents
  
Returns the last Document in the collection.
Documents
  
Returns the middle Document in the collection.
Documents
  
nextItem(objParam:Document = null):Document
Returns the Document whose index follows the specified Document in the collection.
Documents
  
previousItem(objParam:Document = null):Document
Returns the Document with the index previous to the specified index.
Documents
 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
Documents
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
Documents
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(showingWindowParam:Boolean = true, documentPresetParam:DocumentPreset = null, withPropertiesParam:Object = null):Document

Creates a new document.

Parameters

showingWindowParam:Boolean (default = true) — (Boolean) If true, displays the document. (Optional)
 
documentPresetParam:DocumentPreset (default = null) — (DocumentPreset) The document preset to use. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new Document (Optional)

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

Returns any Document in the collection.

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

Displays the number of elements in the Document.

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

Returns every Document in the collection.

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

Returns the first Document in the collection.

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

Returns the Document with the specified index or name.

Parameters

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

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

Returns the Document with the specified ID.

Parameters

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

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

Returns the Document with the specified name.

Parameters

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

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

Returns the Documents within the specified range.

Parameters

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

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

Returns the last Document in the collection.

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

Returns the middle Document in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
Document