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

Creates a new hyperlink text destination.

Parameters

destinationParam:Text (default = null) — (Text) The text or insertion point location that the hyperlink points to.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new HyperlinkTextDestination (Optional)

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

Returns any HyperlinkTextDestination in the collection.

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

Displays the number of elements in the HyperlinkTextDestination.

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

Returns every HyperlinkTextDestination in the collection.

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

Returns the first HyperlinkTextDestination in the collection.

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

Returns the HyperlinkTextDestination with the specified index or name.

Parameters

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

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

Returns the HyperlinkTextDestination with the specified ID.

Parameters

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

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

Returns the HyperlinkTextDestination with the specified name.

Parameters

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

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

Returns the HyperlinkTextDestinations within the specified range.

Parameters

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

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

Returns the last HyperlinkTextDestination in the collection.

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

Returns the middle HyperlinkTextDestination in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
HyperlinkTextDestination