Packagecom.adobe.indesign
Classpublic class IndexOptions
InheritanceIndexOptions Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  beforeCrossReferenceSeparator : String
The character(s) inserted at the start of cross references.
IndexOptions
  betweenEntriesSeparator : String
The character(s) inserted between index entries when runin-style index format is used for nested topics.
IndexOptions
  betweenPageNumbersSeparator : String
The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.
IndexOptions
  crossReferenceStyle : CharacterStyle
The character style applied to cross references.
IndexOptions
  crossReferenceTopicStyle : CharacterStyle
The character style applied to cross reference topics.
IndexOptions
  entryEndSeparator : String
The character(s) inserted at the end of each index entry.
IndexOptions
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
IndexOptions
  events : Events
[override] [read-only] A collection of events.
IndexOptions
  followingTopicSeparator : String
The character(s) inserted after each index topic.
IndexOptions
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  includeBookDocuments : Boolean
If true, includes topics and page references from all the documents in a book.
IndexOptions
  includeEmptyIndexSections : Boolean
If true, displays headings for sections with no index topics.
IndexOptions
  includeHiddenEntries : Boolean
If true, includes topics and page references on hidden layers.
IndexOptions
  includeSectionHeadings : Boolean
If true, displays the letters of the alphabet as index section headings.
IndexOptions
  indexFormat : IndexFormat
The format for level 2 and lower index topics.
IndexOptions
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
IndexOptions
  level1Style : ParagraphStyle
The paragraph style applied to level 1 index topics.
IndexOptions
  level2Style : ParagraphStyle
The paragraph style applied to level 2 index topics.
IndexOptions
  level3Style : ParagraphStyle
The paragraph style applied to level 3 index topics.
IndexOptions
  level4Style : ParagraphStyle
The paragraph style applied to level 4 index topics.
IndexOptions
  pageNumberStyle : CharacterStyle
The character style applied to page numbers in the index.
IndexOptions
  pageRangeSeparator : String
The character(s) inserted between page numbers to indicate a page range.
IndexOptions
  parent : Object
[override] [read-only] The parent of the IndexOptions (a Document or Application).
IndexOptions
  properties : Object
[override] A property that allows setting of several properties at the same time.
IndexOptions
  replaceExistingIndex : Boolean
If true, replaces the content of the existing index.
IndexOptions
  sectionHeadingStyle : ParagraphStyle
The paragraph style applied to index section headings.
IndexOptions
  title : String
The title of the generated index.
IndexOptions
  titleStyle : ParagraphStyle
The paragraph style applied to the title of the generated index.
IndexOptions
Public Methods
 MethodDefined By
  
addEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
IndexOptions
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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
[override] Resolves the object specifier, creating an array of object references.
IndexOptions
 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
  
removeEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
IndexOptions
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
IndexOptions
 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
beforeCrossReferenceSeparatorproperty
beforeCrossReferenceSeparator:String

The character(s) inserted at the start of cross references.


Implementation
    public function get beforeCrossReferenceSeparator():String
    public function set beforeCrossReferenceSeparator(value:String):void
betweenEntriesSeparatorproperty 
betweenEntriesSeparator:String

The character(s) inserted between index entries when runin-style index format is used for nested topics.


Implementation
    public function get betweenEntriesSeparator():String
    public function set betweenEntriesSeparator(value:String):void
betweenPageNumbersSeparatorproperty 
betweenPageNumbersSeparator:String

The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.


Implementation
    public function get betweenPageNumbersSeparator():String
    public function set betweenPageNumbersSeparator(value:String):void
crossReferenceStyleproperty 
crossReferenceStyle:CharacterStyle

The character style applied to cross references.


Implementation
    public function get crossReferenceStyle():CharacterStyle
    public function set crossReferenceStyle(value:CharacterStyle):void
crossReferenceTopicStyleproperty 
crossReferenceTopicStyle:CharacterStyle

The character style applied to cross reference topics.


Implementation
    public function get crossReferenceTopicStyle():CharacterStyle
    public function set crossReferenceTopicStyle(value:CharacterStyle):void
entryEndSeparatorproperty 
entryEndSeparator:String

The character(s) inserted at the end of each index entry.


Implementation
    public function get entryEndSeparator():String
    public function set entryEndSeparator(value:String):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
followingTopicSeparatorproperty 
followingTopicSeparator:String

The character(s) inserted after each index topic.


Implementation
    public function get followingTopicSeparator():String
    public function set followingTopicSeparator(value:String):void
includeBookDocumentsproperty 
includeBookDocuments:Boolean

If true, includes topics and page references from all the documents in a book.


Implementation
    public function get includeBookDocuments():Boolean
    public function set includeBookDocuments(value:Boolean):void
includeEmptyIndexSectionsproperty 
includeEmptyIndexSections:Boolean

If true, displays headings for sections with no index topics. Note: Valid only when include section headings is true.


Implementation
    public function get includeEmptyIndexSections():Boolean
    public function set includeEmptyIndexSections(value:Boolean):void
includeHiddenEntriesproperty 
includeHiddenEntries:Boolean

If true, includes topics and page references on hidden layers.


Implementation
    public function get includeHiddenEntries():Boolean
    public function set includeHiddenEntries(value:Boolean):void
includeSectionHeadingsproperty 
includeSectionHeadings:Boolean

If true, displays the letters of the alphabet as index section headings.


Implementation
    public function get includeSectionHeadings():Boolean
    public function set includeSectionHeadings(value:Boolean):void
indexFormatproperty 
indexFormat:IndexFormat

The format for level 2 and lower index topics.


Implementation
    public function get indexFormat():IndexFormat
    public function set indexFormat(value:IndexFormat):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
level1Styleproperty 
level1Style:ParagraphStyle

The paragraph style applied to level 1 index topics.


Implementation
    public function get level1Style():ParagraphStyle
    public function set level1Style(value:ParagraphStyle):void
level2Styleproperty 
level2Style:ParagraphStyle

The paragraph style applied to level 2 index topics.


Implementation
    public function get level2Style():ParagraphStyle
    public function set level2Style(value:ParagraphStyle):void
level3Styleproperty 
level3Style:ParagraphStyle

The paragraph style applied to level 3 index topics.


Implementation
    public function get level3Style():ParagraphStyle
    public function set level3Style(value:ParagraphStyle):void
level4Styleproperty 
level4Style:ParagraphStyle

The paragraph style applied to level 4 index topics.


Implementation
    public function get level4Style():ParagraphStyle
    public function set level4Style(value:ParagraphStyle):void
pageNumberStyleproperty 
pageNumberStyle:CharacterStyle

The character style applied to page numbers in the index.


Implementation
    public function get pageNumberStyle():CharacterStyle
    public function set pageNumberStyle(value:CharacterStyle):void
pageRangeSeparatorproperty 
pageRangeSeparator:String

The character(s) inserted between page numbers to indicate a page range.


Implementation
    public function get pageRangeSeparator():String
    public function set pageRangeSeparator(value:String):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the IndexOptions (a Document or Application).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

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
replaceExistingIndexproperty 
replaceExistingIndex:Boolean

If true, replaces the content of the existing index. Note: Replaces only index content; does not update the index location or other index properties that may have been changed.


Implementation
    public function get replaceExistingIndex():Boolean
    public function set replaceExistingIndex(value:Boolean):void
sectionHeadingStyleproperty 
sectionHeadingStyle:ParagraphStyle

The paragraph style applied to index section headings. Note: Valid when include section headings is true.


Implementation
    public function get sectionHeadingStyle():ParagraphStyle
    public function set sectionHeadingStyle(value:ParagraphStyle):void
titleproperty 
title:String

The title of the generated index.


Implementation
    public function get title():String
    public function set title(value:String):void
titleStyleproperty 
titleStyle:ParagraphStyle

The paragraph style applied to the title of the generated index. Can also accept: String.


Implementation
    public function get titleStyle():ParagraphStyle
    public function set titleStyle(value:ParagraphStyle):void
Method Detail
addEventListenerIndexOptions()method
public function addEventListenerIndexOptions(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
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerIndexOptions()method 
public function removeEventListenerIndexOptions(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 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String