Packagecom.adobe.indesign
Classpublic class CrossReferenceSource
InheritanceCrossReferenceSource Inheritance HyperlinkTextSource Inheritance CSHostObject Inheritance flash.utils.Proxy

HyperlinkTextSource



Public Properties
 PropertyDefined By
  appliedCharacterStyle : CharacterStyle
[override] Character style of the hyperlink text source.
CrossReferenceSource
  appliedFormat : CrossReferenceFormat
Format used for cross reference source.
CrossReferenceSource
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
CrossReferenceSource
  events : Events
[override] [read-only] A collection of events.
CrossReferenceSource
  hidden : Boolean
[override] [read-only] If true, the hyperlink is hidden.
CrossReferenceSource
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[override] [read-only] The unique ID of the CrossReferenceSource.
CrossReferenceSource
  index : Number
[override] [read-only] The index of the CrossReferenceSource within its containing object.
CrossReferenceSource
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
CrossReferenceSource
  label : String
[override] A property that can be set to any string.
CrossReferenceSource
  name : String
[override] The name of the CrossReferenceSource.
CrossReferenceSource
  parent : Document
[override] [read-only] The parent of the CrossReferenceSource (a Document).
CrossReferenceSource
  properties : Object
[override] A property that allows setting of several properties at the same time.
CrossReferenceSource
  sourceText : Text
[override] The hyperlinked text or insertion point.
CrossReferenceSource
Public Methods
 MethodDefined By
  
addEventListenerCrossReferenceSource(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
CrossReferenceSource
 Inherited
addEventListenerHyperlinkTextSource(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
HyperlinkTextSource
  
extractLabel(keyParam:String = null):String
[override] Gets the label value associated with the specified key.
CrossReferenceSource
 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
[override] Resolves the object specifier, creating an array of object references.
CrossReferenceSource
 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
[override] Sets the label to the value associated with the specified key.
CrossReferenceSource
 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
[override] Deletes the CrossReferenceSource.
CrossReferenceSource
  
removeEventListenerCrossReferenceSource(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
CrossReferenceSource
 Inherited
removeEventListenerHyperlinkTextSource(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
HyperlinkTextSource
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
showSource():void
[override] Jumps to the hyperlink source.
CrossReferenceSource
  
toSpecifier():String
[override] Retrieves the object specifier.
CrossReferenceSource
  
update():void
Updates cross reference text source content.
CrossReferenceSource
 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
appliedCharacterStyleproperty
appliedCharacterStyle:CharacterStyle[override]

Character style of the hyperlink text source.


Implementation
    public function get appliedCharacterStyle():CharacterStyle
    public function set appliedCharacterStyle(value:CharacterStyle):void
appliedFormatproperty 
appliedFormat:CrossReferenceFormat

Format used for cross reference source.


Implementation
    public function get appliedFormat():CrossReferenceFormat
    public function set appliedFormat(value:CrossReferenceFormat):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


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

If true, the hyperlink is hidden.


Implementation
    public function get hidden():Boolean
idproperty 
id:Number  [read-only] [override]

The unique ID of the CrossReferenceSource.


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

The index of the CrossReferenceSource within its containing object.


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

Returns true if the object specifier resolves to valid objects.


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

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[override]

The name of the CrossReferenceSource.


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

The parent of the CrossReferenceSource (a Document).


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

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
sourceTextproperty 
sourceText:Text[override]

The hyperlinked text or insertion point.


Implementation
    public function get sourceText():Text
    public function set sourceText(value:Text):void
Method Detail
addEventListenerCrossReferenceSource()method
public function addEventListenerCrossReferenceSource(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 
override 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 
override public function getElements():Object

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

Returns
Object
insertLabel()method 
override 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 
override public function remove():void

Deletes the CrossReferenceSource.

removeEventListenerCrossReferenceSource()method 
public function removeEventListenerCrossReferenceSource(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
showSource()method 
override public function showSource():void

Jumps to the hyperlink source.

toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String
update()method 
public function update():void

Updates cross reference text source content.