Packagecom.adobe.indesign
Classpublic class ArticleChildren
InheritanceArticleChildren Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5.5



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
ArticleChildren
Public Methods
 MethodDefined By
  
Returns any ArticleChild in the collection.
ArticleChildren
  
count():Number
Displays the number of elements in the ArticleChild.
ArticleChildren
  
everyItem():Object
Returns every ArticleChild in the collection.
ArticleChildren
 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 ArticleChild in the collection.
ArticleChildren
 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):ArticleChild
Returns the ArticleChild with the specified index or name.
ArticleChildren
  
itemByID(idParam:Number):ArticleChild
Returns the ArticleChild with the specified ID.
ArticleChildren
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the ArticleChildren within the specified range.
ArticleChildren
  
Returns the last ArticleChild in the collection.
ArticleChildren
  
Returns the middle ArticleChild in the collection.
ArticleChildren
  
Returns the ArticleChild whose index follows the specified ArticleChild in the collection.
ArticleChildren
  
Returns the ArticleChild with the index previous to the specified index.
ArticleChildren
 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
ArticleChildren
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
ArticleChildren
Property Detail
lengthproperty
length:Number  [read-only]

Since : CS5.5

The number of objects in the collection.


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

Since : CS5.5

Returns any ArticleChild in the collection.

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

Since : CS5.5

Displays the number of elements in the ArticleChild.

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

Since : CS5.5

Returns every ArticleChild in the collection.

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

Since : CS5.5

Returns the first ArticleChild in the collection.

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

Since : CS5.5

Returns the ArticleChild with the specified index or name.

Parameters

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

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

Since : CS5.5

Returns the ArticleChild with the specified ID.

Parameters

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

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

Since : CS5.5

Returns the ArticleChildren within the specified range.

Parameters

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

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

Since : CS5.5

Returns the last ArticleChild in the collection.

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

Since : CS5.5

Returns the middle ArticleChild in the collection.

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

Since : CS5.5

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

Parameters

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

Returns
ArticleChild
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Since : CS5.5

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Since : CS5.5

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:ArticleChild = null):ArticleChild

Since : CS5.5

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

Parameters

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

Returns
ArticleChild