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

Create a new list style.

Parameters

nameParam:String (default = null) — (String) Name
 
continueNumbersAcrossStoriesParam:Boolean (default = NaN) — (Boolean) If true, numbering will continue across stories. (Optional)
 
continueNumbersAcrossDocumentsParam:Boolean (default = NaN) — (Boolean) If true, numbering will continue across book documents. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new NumberingList (Optional)

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

Returns any NumberingList in the collection.

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

Displays the number of elements in the NumberingList.

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

Returns every NumberingList in the collection.

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

Returns the first NumberingList in the collection.

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

Returns the NumberingList with the specified index or name.

Parameters

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

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

Returns the NumberingList with the specified ID.

Parameters

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

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

Returns the NumberingList with the specified name.

Parameters

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

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

Returns the NumberingLists within the specified range.

Parameters

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

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

Returns the last NumberingList in the collection.

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

Returns the middle NumberingList in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
NumberingList