Package | com.adobe.indesign |
Class | public class TOCStyleEntries |
Inheritance | TOCStyleEntries ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | TOCStyleEntries |
Method | Defined 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
Returns the first TOCStyleEntry in the collection. | TOCStyleEntries | ||
![]() | 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 | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
![]() | createWithArgs(args:Array):void | CSHostObject | |
![]() | 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 |
length | property |
length:Number
[read-only] Since : | CS5 |
The number of objects in the collection.
public function get length():Number
add | () | method |
public function add(styleNameParam:String = null, withPropertiesParam:Object = null):TOCStyleEntry
Since : | CS5 |
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)
|
TOCStyleEntry |
anyItem | () | method |
public function anyItem():TOCStyleEntry
Since : | CS5 |
Returns any TOCStyleEntry in the collection.
ReturnsTOCStyleEntry |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the TOCStyleEntry.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every TOCStyleEntry in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():TOCStyleEntry
Since : | CS5 |
Returns the first TOCStyleEntry in the collection.
ReturnsTOCStyleEntry |
item | () | method |
public function item(indexParam:Object = null):TOCStyleEntry
Since : | CS5 |
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.
|
TOCStyleEntry |
itemByName | () | method |
public function itemByName(nameParam:String = null):TOCStyleEntry
Since : | CS5 |
Returns the TOCStyleEntry with the specified name.
Parameters
nameParam:String (default = null ) — (String) The name.
|
TOCStyleEntry |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
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.
|
Object |
lastItem | () | method |
public function lastItem():TOCStyleEntry
Since : | CS5 |
Returns the last TOCStyleEntry in the collection.
ReturnsTOCStyleEntry |
middleItem | () | method |
public function middleItem():TOCStyleEntry
Since : | CS5 |
Returns the middle TOCStyleEntry in the collection.
ReturnsTOCStyleEntry |
nextItem | () | method |
public function nextItem(objParam:TOCStyleEntry = null):TOCStyleEntry
Since : | CS5 |
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.
|
TOCStyleEntry |
nextNameIndex | () | method |
override flash_proxy function nextNameIndex(idx:int):int
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
idx:int |
int |
nextValue | () | method |
override flash_proxy function nextValue(index:int):*
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
index:int |
* |
previousItem | () | method |
public function previousItem(objParam:TOCStyleEntry = null):TOCStyleEntry
Since : | CS5 |
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.
|
TOCStyleEntry |