Package | com.adobe.indesign |
Class | public class Topics |
Inheritance | Topics ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | Topics |
Method | Defined By | ||
---|---|---|---|
Creates a new index topic. | Topics | ||
Returns any Topic in the collection. | Topics | ||
count():Number
Displays the number of elements in the Topic. | Topics | ||
everyItem():Object
Returns every Topic in the collection. | Topics | ||
![]() | 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 Topic in the collection. | Topics | ||
![]() | 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 | |
Returns the Topic with the specified index or name. | Topics | ||
itemByName(nameParam:String = null):Topic
Returns the Topic with the specified name. | Topics | ||
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the Topics within the specified range. | Topics | ||
Returns the last Topic in the collection. | Topics | ||
Returns the middle Topic in the collection. | Topics | ||
Returns the Topic whose index follows the specified Topic in the collection. | Topics | ||
Returns the Topic with the index previous to the specified index. | Topics | ||
![]() | 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
| Topics | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| Topics |
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(nameParam:String = null, sortByParam:String = null, withPropertiesParam:Object = null):Topic
Since : | CS5 |
Creates a new index topic.
Parameters
nameParam:String (default = null ) — (String) The name of the topic. Note: This is the text that appears in the index.
| |
sortByParam:String (default = null ) — (String) The string to sort this topic by instead of the topic name. Note: The actual topic text, rather than the sort order text, appears in the index. (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new Topic (Optional)
|
Topic |
anyItem | () | method |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the Topic.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every Topic in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():Topic
Since : | CS5 |
Returns the first Topic in the collection.
ReturnsTopic |
item | () | method |
public function item(indexParam:Object = null):Topic
Since : | CS5 |
Returns the Topic with the specified index or name.
Parameters
indexParam:Object (default = null ) — (Object) The index or name. Can accept: Long Integer or String.
|
Topic |
itemByName | () | method |
public function itemByName(nameParam:String = null):Topic
Since : | CS5 |
Returns the Topic with the specified name.
Parameters
nameParam:String (default = null ) — (String) The name.
|
Topic |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
Returns the Topics within the specified range.
Parameters
fromParam:Object (default = null ) — (Object) The Topic, index, or name at the beginning of the range. Can accept: Topic, Long Integer or String.
| |
toParam:Object (default = null ) — (Object) The Topic, index, or name at the end of the range. Can accept: Topic, Long Integer or String.
|
Object |
lastItem | () | method |
middleItem | () | method |
public function middleItem():Topic
Since : | CS5 |
Returns the middle Topic in the collection.
ReturnsTopic |
nextItem | () | method |
public function nextItem(objParam:Topic = null):Topic
Since : | CS5 |
Returns the Topic whose index follows the specified Topic in the collection.
Parameters
objParam:Topic (default = null ) — (Topic) The Topic whose index comes before the desired Topic.
|
Topic |
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:Topic = null):Topic
Since : | CS5 |
Returns the Topic with the index previous to the specified index.
Parameters
objParam:Topic (default = null ) — (Topic) The index of the Topic that follows the desired Topic.
|
Topic |