Packagecom.adobe.indesign
Classpublic class IndexCapitalizationOptions
InheritanceIndexCapitalizationOptions Inheritance CSEnumBase Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allEntries : IndexCapitalizationOptions
[static] [read-only] Alias for ALL_ENTRIES.
IndexCapitalizationOptions
  ALL_ENTRIES : IndexCapitalizationOptions
[static] [read-only] Capitalizes all index entries.
IndexCapitalizationOptions
  allLevel1Entries : IndexCapitalizationOptions
[static] [read-only] Alias for ALL_LEVEL_1_ENTRIES.
IndexCapitalizationOptions
  ALL_LEVEL_1_ENTRIES : IndexCapitalizationOptions
[static] [read-only] Capitalizes all level 1 entries.
IndexCapitalizationOptions
  enumCache : CSEnumSharedCache
[static] [read-only]
IndexCapitalizationOptions
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  includeSubentries : IndexCapitalizationOptions
[static] [read-only] Alias for INCLUDE_SUBENTRIES.
IndexCapitalizationOptions
  INCLUDE_SUBENTRIES : IndexCapitalizationOptions
[static] [read-only] Capitalizes the specified topic and its nested topics.
IndexCapitalizationOptions
  selectedEntry : IndexCapitalizationOptions
[static] [read-only] Alias for SELECTED_ENTRY.
IndexCapitalizationOptions
  SELECTED_ENTRY : IndexCapitalizationOptions
[static] [read-only] Capitalizes the specified topic but does not capitalize its nested topics.
IndexCapitalizationOptions
 Inheritedvalue : Object
[read-only] Returns the numerical value
CSEnumBase
Public Methods
 MethodDefined By
  
IndexCapitalizationOptions(ho:HostObject = null, enum:Number)
Constructor
IndexCapitalizationOptions
 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
 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
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
ALL_ENTRIESproperty
ALL_ENTRIES:IndexCapitalizationOptions  [read-only]

Capitalizes all index entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.


Implementation
    public static function get ALL_ENTRIES():IndexCapitalizationOptions
ALL_LEVEL_1_ENTRIESproperty 
ALL_LEVEL_1_ENTRIES:IndexCapitalizationOptions  [read-only]

Capitalizes all level 1 entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.


Implementation
    public static function get ALL_LEVEL_1_ENTRIES():IndexCapitalizationOptions
allEntriesproperty 
allEntries:IndexCapitalizationOptions  [read-only]

Alias for ALL_ENTRIES. Capitalizes all index entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.


Implementation
    public static function get allEntries():IndexCapitalizationOptions
allLevel1Entriesproperty 
allLevel1Entries:IndexCapitalizationOptions  [read-only]

Alias for ALL_LEVEL_1_ENTRIES. Capitalizes all level 1 entries. Note: Capitalizes only topics created before the capitalization statement appears in the script.


Implementation
    public static function get allLevel1Entries():IndexCapitalizationOptions
enumCacheproperty 
enumCache:CSEnumSharedCache  [read-only]


Implementation
    public static function get enumCache():CSEnumSharedCache
INCLUDE_SUBENTRIESproperty 
INCLUDE_SUBENTRIES:IndexCapitalizationOptions  [read-only]

Capitalizes the specified topic and its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the selected topic and its nested subtopics are created.


Implementation
    public static function get INCLUDE_SUBENTRIES():IndexCapitalizationOptions
includeSubentriesproperty 
includeSubentries:IndexCapitalizationOptions  [read-only]

Alias for INCLUDE_SUBENTRIES. Capitalizes the specified topic and its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the selected topic and its nested subtopics are created.


Implementation
    public static function get includeSubentries():IndexCapitalizationOptions
SELECTED_ENTRYproperty 
SELECTED_ENTRY:IndexCapitalizationOptions  [read-only]

Capitalizes the specified topic but does not capitalize its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the specified topic and its nested topics are created.


Implementation
    public static function get SELECTED_ENTRY():IndexCapitalizationOptions
selectedEntryproperty 
selectedEntry:IndexCapitalizationOptions  [read-only]

Alias for SELECTED_ENTRY. Capitalizes the specified topic but does not capitalize its nested topics. Valid only as parameter of the topic capitalize method; cannot be used as a parameter of the index capitalize method. Note: Must occur after the specified topic and its nested topics are created.


Implementation
    public static function get selectedEntry():IndexCapitalizationOptions
Constructor Detail
IndexCapitalizationOptions()Constructor
public function IndexCapitalizationOptions(ho:HostObject = null, enum:Number)

Constructor

Parameters
ho:HostObject (default = null) — Enumerations value
 
enum:Number (default = NaN)