Packagecom.adobe.indesign
Classpublic class IndexFormat
InheritanceIndexFormat Inheritance CSEnumBase Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  enumCache : CSEnumSharedCache
[static] [read-only]
IndexFormat
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  nestedFormat : IndexFormat
[static] [read-only] Alias for NESTED_FORMAT.
IndexFormat
  NESTED_FORMAT : IndexFormat
[static] [read-only] Places nested topics on the line below and indented from the parent topic.
IndexFormat
  runinFormat : IndexFormat
[static] [read-only] Alias for RUNIN_FORMAT.
IndexFormat
  RUNIN_FORMAT : IndexFormat
[static] [read-only] Places nested topics on the same line as their parent topic, separated by the specified separator.
IndexFormat
 Inheritedvalue : Object
[read-only] Returns the numerical value
CSEnumBase
Public Methods
 MethodDefined By
  
IndexFormat(ho:HostObject = null, enum:Number)
Constructor
IndexFormat
 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
enumCacheproperty
enumCache:CSEnumSharedCache  [read-only]


Implementation
    public static function get enumCache():CSEnumSharedCache
NESTED_FORMATproperty 
NESTED_FORMAT:IndexFormat  [read-only]

Places nested topics on the line below and indented from the parent topic.


Implementation
    public static function get NESTED_FORMAT():IndexFormat
nestedFormatproperty 
nestedFormat:IndexFormat  [read-only]

Alias for NESTED_FORMAT. Places nested topics on the line below and indented from the parent topic.


Implementation
    public static function get nestedFormat():IndexFormat
RUNIN_FORMATproperty 
RUNIN_FORMAT:IndexFormat  [read-only]

Places nested topics on the same line as their parent topic, separated by the specified separator.


Implementation
    public static function get RUNIN_FORMAT():IndexFormat
runinFormatproperty 
runinFormat:IndexFormat  [read-only]

Alias for RUNIN_FORMAT. Places nested topics on the same line as their parent topic, separated by the specified separator.


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

Constructor

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