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

Creates a new kinsoku table.

Parameters

nameParam:String (default = null) — (String) The name of the new kinsoku table.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new KinsokuTable (Optional)

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

Returns any KinsokuTable in the collection.

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

Displays the number of elements in the KinsokuTable.

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

Returns every KinsokuTable in the collection.

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

Returns the first KinsokuTable in the collection.

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

Returns the KinsokuTable with the specified index or name.

Parameters

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

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

Returns the KinsokuTable with the specified ID.

Parameters

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

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

Returns the KinsokuTable with the specified name.

Parameters

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

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

Returns the KinsokuTables within the specified range.

Parameters

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

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

Returns the last KinsokuTable in the collection.

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

Returns the middle KinsokuTable in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
KinsokuTable