Packagecom.adobe.indesign
Classpublic class Topic
InheritanceTopic Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  crossReferences : CrossReferences
[read-only] A collection of index cross references.
Topic
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Topic
  events : Events
[read-only] A collection of events.
Topic
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the Topic within its containing object.
Topic
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Topic
  name : String
The name of the Topic.
Topic
  pageReferences : PageReferences
[read-only] A collection of index page references.
Topic
  parent : Object
[read-only] The parent of the Topic (a IndexSection, Topic or Index).
Topic
  properties : Object
A property that allows setting of several properties at the same time.
Topic
  sortOrder : String
The string by which the topic is sorted instead of the topic name is not used.
Topic
  topics : Topics
[read-only] A collection of index topics.
Topic
Public Methods
 MethodDefined By
  
addEventListenerTopic(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Topic
  
capitalize(capitalizationOptionParam:IndexCapitalizationOptions = null):void
Makes the initial letter for the specified index topic or group of index topics upper case.
Topic
 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
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Topic
 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
  
remove():void
Deletes the Topic.
Topic
  
removeEventListenerTopic(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Topic
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
Topic
 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
Property Detail
crossReferencesproperty
crossReferences:CrossReferences  [read-only]

A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)


Implementation
    public function get crossReferences():CrossReferences
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the Topic within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
nameproperty 
name:String

The name of the Topic.


Implementation
    public function get name():String
    public function set name(value:String):void
pageReferencesproperty 
pageReferences:PageReferences  [read-only]

A collection of index page references.


Implementation
    public function get pageReferences():PageReferences
parentproperty 
parent:Object  [read-only]

The parent of the Topic (a IndexSection, Topic or Index).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
sortOrderproperty 
sortOrder:String

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.


Implementation
    public function get sortOrder():String
    public function set sortOrder(value:String):void
topicsproperty 
topics:Topics  [read-only]

A collection of index topics.


Implementation
    public function get topics():Topics
Method Detail
addEventListenerTopic()method
public function addEventListenerTopic(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
capitalize()method 
public function capitalize(capitalizationOptionParam:IndexCapitalizationOptions = null):void

Makes the initial letter for the specified index topic or group of index topics upper case.

Parameters

capitalizationOptionParam:IndexCapitalizationOptions (default = null) — (IndexCapitalizationOptions) The entry or entries to capitalize. (Optional)

getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
remove()method 
public function remove():void

Deletes the Topic.

removeEventListenerTopic()method 
public function removeEventListenerTopic(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String