Package | com.adobe.indesign |
Class | public class IndexOptions |
Inheritance | IndexOptions ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | IndexOptions | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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 | |
![]() | 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 | ||
![]() | 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 | |
removeEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | IndexOptions | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | IndexOptions | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
beforeCrossReferenceSeparator | property |
beforeCrossReferenceSeparator:String
Since : | CS5 |
The character(s) inserted at the start of cross references.
public function get beforeCrossReferenceSeparator():String
public function set beforeCrossReferenceSeparator(value:String):void
betweenEntriesSeparator | property |
betweenEntriesSeparator:String
Since : | CS5 |
The character(s) inserted between index entries when runin-style index format is used for nested topics.
public function get betweenEntriesSeparator():String
public function set betweenEntriesSeparator(value:String):void
betweenPageNumbersSeparator | property |
betweenPageNumbersSeparator:String
Since : | CS5 |
The character(s) inserted between separate page numbers, page numbers and page ranges, and series of page ranges.
public function get betweenPageNumbersSeparator():String
public function set betweenPageNumbersSeparator(value:String):void
crossReferenceStyle | property |
crossReferenceStyle:CharacterStyle
Since : | CS5 |
The character style applied to cross references.
public function get crossReferenceStyle():CharacterStyle
public function set crossReferenceStyle(value:CharacterStyle):void
crossReferenceTopicStyle | property |
crossReferenceTopicStyle:CharacterStyle
Since : | CS5 |
The character style applied to cross reference topics.
public function get crossReferenceTopicStyle():CharacterStyle
public function set crossReferenceTopicStyle(value:CharacterStyle):void
entryEndSeparator | property |
entryEndSeparator:String
Since : | CS5 |
The character(s) inserted at the end of each index entry.
public function get entryEndSeparator():String
public function set entryEndSeparator(value:String):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
followingTopicSeparator | property |
followingTopicSeparator:String
Since : | CS5 |
The character(s) inserted after each index topic.
public function get followingTopicSeparator():String
public function set followingTopicSeparator(value:String):void
includeBookDocuments | property |
includeBookDocuments:Boolean
Since : | CS5 |
If true, includes topics and page references from all the documents in a book.
public function get includeBookDocuments():Boolean
public function set includeBookDocuments(value:Boolean):void
includeEmptyIndexSections | property |
includeEmptyIndexSections:Boolean
Since : | CS5 |
If true, displays headings for sections with no index topics. Note: Valid only when include section headings is true.
public function get includeEmptyIndexSections():Boolean
public function set includeEmptyIndexSections(value:Boolean):void
includeHiddenEntries | property |
includeHiddenEntries:Boolean
Since : | CS5 |
If true, includes topics and page references on hidden layers.
public function get includeHiddenEntries():Boolean
public function set includeHiddenEntries(value:Boolean):void
includeSectionHeadings | property |
includeSectionHeadings:Boolean
Since : | CS5 |
If true, displays the letters of the alphabet as index section headings.
public function get includeSectionHeadings():Boolean
public function set includeSectionHeadings(value:Boolean):void
indexFormat | property |
indexFormat:IndexFormat
Since : | CS5 |
The format for level 2 and lower index topics.
public function get indexFormat():IndexFormat
public function set indexFormat(value:IndexFormat):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
level1Style | property |
level1Style:ParagraphStyle
Since : | CS5 |
The paragraph style applied to level 1 index topics.
public function get level1Style():ParagraphStyle
public function set level1Style(value:ParagraphStyle):void
level2Style | property |
level2Style:ParagraphStyle
Since : | CS5 |
The paragraph style applied to level 2 index topics.
public function get level2Style():ParagraphStyle
public function set level2Style(value:ParagraphStyle):void
level3Style | property |
level3Style:ParagraphStyle
Since : | CS5 |
The paragraph style applied to level 3 index topics.
public function get level3Style():ParagraphStyle
public function set level3Style(value:ParagraphStyle):void
level4Style | property |
level4Style:ParagraphStyle
Since : | CS5 |
The paragraph style applied to level 4 index topics.
public function get level4Style():ParagraphStyle
public function set level4Style(value:ParagraphStyle):void
pageNumberStyle | property |
pageNumberStyle:CharacterStyle
Since : | CS5 |
The character style applied to page numbers in the index.
public function get pageNumberStyle():CharacterStyle
public function set pageNumberStyle(value:CharacterStyle):void
pageRangeSeparator | property |
pageRangeSeparator:String
Since : | CS5 |
The character(s) inserted between page numbers to indicate a page range.
public function get pageRangeSeparator():String
public function set pageRangeSeparator(value:String):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the IndexOptions (a Document or Application).
public function get parent():Object
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
replaceExistingIndex | property |
replaceExistingIndex:Boolean
Since : | CS5 |
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.
public function get replaceExistingIndex():Boolean
public function set replaceExistingIndex(value:Boolean):void
sectionHeadingStyle | property |
sectionHeadingStyle:ParagraphStyle
Since : | CS5 |
The paragraph style applied to index section headings. Note: Valid when include section headings is true.
public function get sectionHeadingStyle():ParagraphStyle
public function set sectionHeadingStyle(value:ParagraphStyle):void
title | property |
title:String
Since : | CS5 |
The title of the generated index.
public function get title():String
public function set title(value:String):void
titleStyle | property |
titleStyle:ParagraphStyle
Since : | CS5 |
The paragraph style applied to the title of the generated index. Can also accept: String.
public function get titleStyle():ParagraphStyle
public function set titleStyle(value:ParagraphStyle):void
addEventListenerIndexOptions | () | method |
public function addEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerIndexOptions | () | method |
public function removeEventListenerIndexOptions(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |