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

Adds a TOC style entry.

Parameters

styleNameParam:String (default = null) — (String) The paragraph style to include as TOC entries in the TOC. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new TOCStyleEntry (Optional)

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

Returns any TOCStyleEntry in the collection.

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

Displays the number of elements in the TOCStyleEntry.

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

Returns every TOCStyleEntry in the collection.

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

Returns the first TOCStyleEntry in the collection.

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

Returns the TOCStyleEntry with the specified index or name.

Parameters

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

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

Returns the TOCStyleEntry with the specified name.

Parameters

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

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

Returns the TOCStyleEntries within the specified range.

Parameters

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

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

Returns the last TOCStyleEntry in the collection.

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

Returns the middle TOCStyleEntry in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
TOCStyleEntry