Packagecom.adobe.indesign
Classpublic class CrossReferenceFormats
InheritanceCrossReferenceFormats Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
CrossReferenceFormats
Public Methods
 MethodDefined By
  
add(nameParam:String = null, withPropertiesParam:Object = null):CrossReferenceFormat
Creates a new cross reference format.
CrossReferenceFormats
  
Returns any CrossReferenceFormat in the collection.
CrossReferenceFormats
  
count():Number
Displays the number of elements in the CrossReferenceFormat.
CrossReferenceFormats
  
everyItem():Object
Returns every CrossReferenceFormat in the collection.
CrossReferenceFormats
 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
  
Returns the first CrossReferenceFormat in the collection.
CrossReferenceFormats
 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
  
item(indexParam:Object = null):CrossReferenceFormat
Returns the CrossReferenceFormat with the specified index or name.
CrossReferenceFormats
  
Returns the CrossReferenceFormat with the specified ID.
CrossReferenceFormats
  
itemByName(nameParam:String = null):CrossReferenceFormat
Returns the CrossReferenceFormat with the specified name.
CrossReferenceFormats
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the CrossReferenceFormats within the specified range.
CrossReferenceFormats
  
Returns the last CrossReferenceFormat in the collection.
CrossReferenceFormats
  
Returns the middle CrossReferenceFormat in the collection.
CrossReferenceFormats
  
Returns the CrossReferenceFormat whose index follows the specified CrossReferenceFormat in the collection.
CrossReferenceFormats
  
Returns the CrossReferenceFormat with the index previous to the specified index.
CrossReferenceFormats
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
CrossReferenceFormats
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
CrossReferenceFormats
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(nameParam:String = null, withPropertiesParam:Object = null):CrossReferenceFormat

Creates a new cross reference format.

Parameters

nameParam:String (default = null) — (String) The format name. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new CrossReferenceFormat (Optional)

Returns
CrossReferenceFormat
anyItem()method 
public function anyItem():CrossReferenceFormat

Returns any CrossReferenceFormat in the collection.

Returns
CrossReferenceFormat
count()method 
public function count():Number

Displays the number of elements in the CrossReferenceFormat.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every CrossReferenceFormat in the collection.

Returns
Object
firstItem()method 
public function firstItem():CrossReferenceFormat

Returns the first CrossReferenceFormat in the collection.

Returns
CrossReferenceFormat
item()method 
public function item(indexParam:Object = null):CrossReferenceFormat

Returns the CrossReferenceFormat with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
CrossReferenceFormat
itemByID()method 
public function itemByID(idParam:Number):CrossReferenceFormat

Returns the CrossReferenceFormat with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
CrossReferenceFormat
itemByName()method 
public function itemByName(nameParam:String = null):CrossReferenceFormat

Returns the CrossReferenceFormat with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

Returns
CrossReferenceFormat
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the CrossReferenceFormats within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The CrossReferenceFormat, index, or name at the beginning of the range. Can accept: CrossReferenceFormat, Long Integer or String.
 
toParam:Object (default = null) — (Object) The CrossReferenceFormat, index, or name at the end of the range. Can accept: CrossReferenceFormat, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():CrossReferenceFormat

Returns the last CrossReferenceFormat in the collection.

Returns
CrossReferenceFormat
middleItem()method 
public function middleItem():CrossReferenceFormat

Returns the middle CrossReferenceFormat in the collection.

Returns
CrossReferenceFormat
nextItem()method 
public function nextItem(objParam:CrossReferenceFormat = null):CrossReferenceFormat

Returns the CrossReferenceFormat whose index follows the specified CrossReferenceFormat in the collection.

Parameters

objParam:CrossReferenceFormat (default = null) — (CrossReferenceFormat) The CrossReferenceFormat whose index comes before the desired CrossReferenceFormat.

Returns
CrossReferenceFormat
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:CrossReferenceFormat = null):CrossReferenceFormat

Returns the CrossReferenceFormat with the index previous to the specified index.

Parameters

objParam:CrossReferenceFormat (default = null) — (CrossReferenceFormat) The index of the CrossReferenceFormat that follows the desired CrossReferenceFormat.

Returns
CrossReferenceFormat