Topic
An index topic.
Instance
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Mixed parent
The parent of the Topic (a IndexSection, Topic or Index).
Read Only
Number index
The index of the Topic within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
Read Only
Topics topics
A collection of index topics.
Read Only
CrossReferences crossReferences
A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)
Read Only
PageReferences pageReferences
A collection of index page references.
String sortOrder
The string by which the topic is sorted instead of the topic name is not used. Note: The actual topic text, rather than the sort order text, appears in the index.
String name
The name of the Topic.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the Topic.
capitalize( IndexCapitalizationOptions capitalizationOption )
Makes the initial letter for the specified index topic or group of index topics upper case.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the Topic.
Topic getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description