Packagecom.adobe.indesign
Classpublic class Index
InheritanceIndex Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allTopics : Object
[read-only] The topics in the specified index section.
Index
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Index
  events : Events
[read-only] A collection of events.
Index
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Index.
Index
  index : Number
[read-only] The index of the Index within its containing object.
Index
  indexSections : IndexSections
[read-only] A collection of index sections.
Index
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Index
  label : String
A property that can be set to any string.
Index
  name : String
The name of the Index; this is an alias to the Index's label property.
Index
  parent : Document
[read-only] The parent of the Index (a Document).
Index
  properties : Object
A property that allows setting of several properties at the same time.
Index
  topics : Topics
[read-only] A collection of index topics.
Index
Public Methods
 MethodDefined By
  
addEventListenerIndex(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Index
  
capitalize(capitalizationOptionParam:IndexCapitalizationOptions = null):void
Makes the initial letter for the specified index topic or group of index topics upper case.
Index
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Index
 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
  
generate(onParam:Object = null, placePointParam:Array = null, destinationLayerParam:Layer = null, autoflowingParam:Boolean = false, includeOversetParam:Boolean = false):Object
Generates a new index story.
Index
 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.
Index
 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
  
importTopics(fromParam:File = null):void
Imports a list of index topics.
Index
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Index
 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
  
removeEventListenerIndex(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Index
  
Removes all index topics that do not have any index entries.
Index
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
Index
  
update():void
Updates the index preview pane.
Index
 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
allTopicsproperty
allTopics:Object  [read-only]

The topics in the specified index section.


Implementation
    public function get allTopics():Object
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
idproperty 
id:Number  [read-only]

The unique ID of the Index.


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

The index of the Index within its containing object.


Implementation
    public function get index():Number
indexSectionsproperty 
indexSections:IndexSections  [read-only]

A collection of index sections.


Implementation
    public function get indexSections():IndexSections
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the Index; this is an alias to the Index's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:Document  [read-only]

The parent of the Index (a Document).


Implementation
    public function get parent():Document
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
topicsproperty 
topics:Topics  [read-only]

A collection of index topics.


Implementation
    public function get topics():Topics
Method Detail
addEventListenerIndex()method
public function addEventListenerIndex(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)

extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
generate()method 
public function generate(onParam:Object = null, placePointParam:Array = null, destinationLayerParam:Layer = null, autoflowingParam:Boolean = false, includeOversetParam:Boolean = false):Object

Generates a new index story.

Parameters

onParam:Object (default = null) — (Object) The spread or page on which to place the story. Can accept: Page, Spread or MasterSpread. (Optional)
 
placePointParam:Array (default = null) — (Array) The coordinates of the upper left corner of the story bounding box, in the format [x, y]. (Optional)
 
destinationLayerParam:Layer (default = null) — (Layer) The layer on which to place the story. (Optional)
 
autoflowingParam:Boolean (default = false) — (Boolean) If true, allows the story to flow onto subsequent pages if the story does not fit on the specified page. If no subsequent pages exist in the document, creates the necessary pages. (Optional)
 
includeOversetParam:Boolean (default = false) — (Boolean) If true, includes topics in overset text in the story. (Optional)

Returns
Object
getElements()method 
public function getElements():Object

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

Returns
Object
importTopics()method 
public function importTopics(fromParam:File = null):void

Imports a list of index topics.

Parameters

fromParam:File (default = null) — (File) The file from which to import the topics.

insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

removeEventListenerIndex()method 
public function removeEventListenerIndex(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
removeUnusedTopics()method 
public function removeUnusedTopics():void

Removes all index topics that do not have any index entries.

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
update()method 
public function update():void

Updates the index preview pane. Note: Does not update the index.