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

Creates a new NavigationPoint.

Parameters

withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new NavigationPoint (Optional)

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

Returns any NavigationPoint in the collection.

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

Displays the number of elements in the NavigationPoint.

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

Returns every NavigationPoint in the collection.

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

Returns the first NavigationPoint in the collection.

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

Returns the NavigationPoint with the specified index or name.

Parameters

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

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

Returns the NavigationPoint with the specified ID.

Parameters

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

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

Returns the NavigationPoint with the specified name.

Parameters

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

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

Returns the NavigationPoints within the specified range.

Parameters

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

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

Returns the last NavigationPoint in the collection.

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

Returns the middle NavigationPoint in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
NavigationPoint