Packagecom.adobe.indesign
Classpublic class Hyperlink
InheritanceHyperlink Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  borderColor : Object
The hyperlink border color.
Hyperlink
  borderStyle : HyperlinkAppearanceStyle
The hyperlink border style.
Hyperlink
  destination : Object
The text, page, or URL that the hyperlink points to.
Hyperlink
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Hyperlink
  events : Events
[read-only] A collection of events.
Hyperlink
  hidden : Boolean
[read-only] If true, the hyperlink is hidden.
Hyperlink
  highlight : HyperlinkAppearanceHighlight
The hyperlink highlight style.
Hyperlink
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Hyperlink.
Hyperlink
  index : Number
[read-only] The index of the Hyperlink within its containing object.
Hyperlink
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Hyperlink
  label : String
A property that can be set to any string.
Hyperlink
  name : String
The name of the Hyperlink.
Hyperlink
  parent : Document
[read-only] The parent of the Hyperlink (a Document).
Hyperlink
  properties : Object
A property that allows setting of several properties at the same time.
Hyperlink
  source : Object
The hyperlinked text or page item.
Hyperlink
  visible : Boolean
If true, the Hyperlink is visible.
Hyperlink
  width : HyperlinkAppearanceWidth
The stroke weight of the hyperlink border.
Hyperlink
Public Methods
 MethodDefined By
  
addEventListenerHyperlink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Hyperlink
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Hyperlink
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Hyperlink
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Hyperlink
 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
  
remove():void
Deletes the Hyperlink.
Hyperlink
  
removeEventListenerHyperlink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Hyperlink
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Jumps to the hyperlink destination.
Hyperlink
  
showSource():void
Jumps to the hyperlink source.
Hyperlink
  
toSpecifier():String
Retrieves the object specifier.
Hyperlink
 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
borderColorproperty
borderColor:Object

The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get borderColor():Object
    public function set borderColor(value:Object):void
borderStyleproperty 
borderStyle:HyperlinkAppearanceStyle

The hyperlink border style.


Implementation
    public function get borderStyle():HyperlinkAppearanceStyle
    public function set borderStyle(value:HyperlinkAppearanceStyle):void
destinationproperty 
destination:Object

The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination.


Implementation
    public function get destination():Object
    public function set destination(value:Object):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
hiddenproperty 
hidden:Boolean  [read-only]

If true, the hyperlink is hidden.


Implementation
    public function get hidden():Boolean
highlightproperty 
highlight:HyperlinkAppearanceHighlight

The hyperlink highlight style.


Implementation
    public function get highlight():HyperlinkAppearanceHighlight
    public function set highlight(value:HyperlinkAppearanceHighlight):void
idproperty 
id:Number  [read-only]

The unique ID of the Hyperlink.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the Hyperlink within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the Hyperlink.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:Document  [read-only]

The parent of the Hyperlink (a Document).


Implementation
    public function get parent():Document
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
sourceproperty 
source:Object

The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource.


Implementation
    public function get source():Object
    public function set source(value:Object):void
visibleproperty 
visible:Boolean

If true, the Hyperlink is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
widthproperty 
width:HyperlinkAppearanceWidth

The stroke weight of the hyperlink border.


Implementation
    public function get width():HyperlinkAppearanceWidth
    public function set width(value:HyperlinkAppearanceWidth):void
Method Detail
addEventListenerHyperlink()method
public function addEventListenerHyperlink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the Hyperlink.

removeEventListenerHyperlink()method 
public function removeEventListenerHyperlink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
showDestination()method 
public function showDestination():void

Jumps to the hyperlink destination.

showSource()method 
public function showSource():void

Jumps to the hyperlink source.

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String