Packagecom.adobe.indesign
Classpublic class CrossReferences
InheritanceCrossReferences 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.
CrossReferences
Public Methods
 MethodDefined By
  
add(referencedTopicParam:Topic = null, crossReferenceTypeParam:CrossReferenceType = null, customTypeStringParam:String = null, withPropertiesParam:Object = null):CrossReference
Creates a new cross reference.
CrossReferences
  
Returns any CrossReference in the collection.
CrossReferences
  
count():Number
Displays the number of elements in the CrossReference.
CrossReferences
  
everyItem():Object
Returns every CrossReference in the collection.
CrossReferences
 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 CrossReference in the collection.
CrossReferences
 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):CrossReference
Returns the CrossReference with the specified index or name.
CrossReferences
  
itemByID(idParam:Number):CrossReference
Returns the CrossReference with the specified ID.
CrossReferences
  
itemByName(nameParam:String = null):CrossReference
Returns the CrossReference with the specified name.
CrossReferences
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the CrossReferences within the specified range.
CrossReferences
  
Returns the last CrossReference in the collection.
CrossReferences
  
Returns the middle CrossReference in the collection.
CrossReferences
  
Returns the CrossReference whose index follows the specified CrossReference in the collection.
CrossReferences
  
Returns the CrossReference with the index previous to the specified index.
CrossReferences
 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
CrossReferences
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
CrossReferences
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(referencedTopicParam:Topic = null, crossReferenceTypeParam:CrossReferenceType = null, customTypeStringParam:String = null, withPropertiesParam:Object = null):CrossReference

Creates a new cross reference.

Parameters

referencedTopicParam:Topic (default = null) — (Topic) The topic that the cross reference points to.
 
crossReferenceTypeParam:CrossReferenceType (default = null) — (CrossReferenceType) The cross reference type.
 
customTypeStringParam:String (default = null) — (String) The custom string to use in the cross reference. Valid only for custom cross reference types. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new CrossReference (Optional)

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

Returns any CrossReference in the collection.

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

Displays the number of elements in the CrossReference.

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

Returns every CrossReference in the collection.

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

Returns the first CrossReference in the collection.

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

Returns the CrossReference with the specified index or name.

Parameters

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

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

Returns the CrossReference with the specified ID.

Parameters

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

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

Returns the CrossReference with the specified name.

Parameters

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

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

Returns the CrossReferences within the specified range.

Parameters

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

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

Returns the last CrossReference in the collection.

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

Returns the middle CrossReference in the collection.

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

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

Parameters

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

Returns
CrossReference
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:CrossReference = null):CrossReference

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

Parameters

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

Returns
CrossReference