Packagecom.adobe.indesign
Classpublic class InsertionPoints
InheritanceInsertionPoints 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.
InsertionPoints
Public Methods
 MethodDefined By
  
Returns any InsertionPoint in the collection.
InsertionPoints
  
count():Number
Displays the number of elements in the InsertionPoint.
InsertionPoints
  
everyItem():Object
Returns every InsertionPoint in the collection.
InsertionPoints
 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 InsertionPoint in the collection.
InsertionPoints
 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):InsertionPoint
Returns the InsertionPoint with the specified index or name.
InsertionPoints
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the InsertionPoints within the specified range.
InsertionPoints
  
Returns the last InsertionPoint in the collection.
InsertionPoints
  
Returns the middle InsertionPoint in the collection.
InsertionPoints
  
Returns the InsertionPoint whose index follows the specified InsertionPoint in the collection.
InsertionPoints
  
Returns the InsertionPoint with the index previous to the specified index.
InsertionPoints
 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
InsertionPoints
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
InsertionPoints
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
anyItem()method
public function anyItem():InsertionPoint

Returns any InsertionPoint in the collection.

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

Displays the number of elements in the InsertionPoint.

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

Returns every InsertionPoint in the collection.

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

Returns the first InsertionPoint in the collection.

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

Returns the InsertionPoint with the specified index or name.

Parameters

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

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

Returns the InsertionPoints within the specified range.

Parameters

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

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

Returns the last InsertionPoint in the collection.

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

Returns the middle InsertionPoint in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
InsertionPoint