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

Creates a new cross reference text source.

Parameters

sourceParam:Text (default = null) — (Text) The text or insertion point to create the source.
 
appliedFormatParam:CrossReferenceFormat (default = null) — (CrossReferenceFormat) Format used for cross reference source.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new CrossReferenceSource (Optional)

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

Returns any CrossReferenceSource in the collection.

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

Displays the number of elements in the CrossReferenceSource.

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

Returns every CrossReferenceSource in the collection.

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

Returns the first CrossReferenceSource in the collection.

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

Returns the CrossReferenceSource with the specified index or name.

Parameters

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

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

Returns the CrossReferenceSource with the specified ID.

Parameters

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

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

Returns the CrossReferenceSource with the specified name.

Parameters

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

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

Returns the CrossReferenceSources within the specified range.

Parameters

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

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

Returns the last CrossReferenceSource in the collection.

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

Returns the middle CrossReferenceSource in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
CrossReferenceSource