Package | com.adobe.indesign |
Class | public class Index |
Inheritance | Index ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | 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 | |
generate(onParam:Object = null, placePointParam:Array = null, destinationLayerParam:Layer = null, autoflowingParam:Boolean = false, includeOversetParam:Boolean = false):Object
Generates a new index story. | Index | ||
![]() | 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 | ||
![]() | 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 | |
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 | ||
![]() | 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 | ||
removeUnusedTopics():void
Removes all index topics that do not have any index entries. | Index | ||
![]() | 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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allTopics | property |
allTopics:Object
[read-only] Since : | CS5 |
The topics in the specified index section.
public function get allTopics():Object
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Index.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Index within its containing object.
public function get index():Number
indexSections | property |
indexSections:IndexSections
[read-only] Since : | CS5 |
A collection of index sections.
public function get indexSections():IndexSections
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
Since : | CS5 |
The name of the Index; this is an alias to the Index's label property.
public function get name():String
public function set name(value:String):void
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the Index (a Document).
public function get parent():Document
properties | property |
properties:Object
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
topics | property |
topics:Topics
[read-only] Since : | CS5 |
A collection of index topics.
public function get topics():Topics
addEventListenerIndex | () | method |
public function addEventListenerIndex(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 |
capitalize | () | method |
public function capitalize(capitalizationOptionParam:IndexCapitalizationOptions = null):void
Since : | CS5 |
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
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
generate | () | method |
public function generate(onParam:Object = null, placePointParam:Array = null, destinationLayerParam:Layer = null, autoflowingParam:Boolean = false, includeOversetParam:Boolean = false):Object
Since : | CS5 |
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)
|
Object |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
importTopics | () | method |
public function importTopics(fromParam:File = null):void
Since : | CS5 |
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
Since : | CS5 |
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
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 |
removeUnusedTopics | () | method |
public function removeUnusedTopics():void
Since : | CS5 |
Removes all index topics that do not have any index entries.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
update | () | method |
public function update():void
Since : | CS5 |
Updates the index preview pane. Note: Does not update the index.