Package | com.adobe.incopy |
Class | public class HyperlinkExternalPageDestination |
Inheritance | HyperlinkExternalPageDestination ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
destinationPageIndex : Number
The index of the page that the hyperlink destination points to. | HyperlinkExternalPageDestination | ||
documentPath : File
The path to the document that the hyperlink destination points to. | HyperlinkExternalPageDestination | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | HyperlinkExternalPageDestination | ||
events : Events [read-only]
A collection of events. | HyperlinkExternalPageDestination | ||
hidden : Boolean [read-only]
If true, the hyperlink is hidden. | HyperlinkExternalPageDestination | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the HyperlinkExternalPageDestination. | HyperlinkExternalPageDestination | ||
index : Number [read-only]
The index of the HyperlinkExternalPageDestination within its containing object. | HyperlinkExternalPageDestination | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | HyperlinkExternalPageDestination | ||
label : String
A property that can be set to any string. | HyperlinkExternalPageDestination | ||
name : String [read-only]
The name of the HyperlinkExternalPageDestination. | HyperlinkExternalPageDestination | ||
parent : Document [read-only]
The parent of the HyperlinkExternalPageDestination (a Document). | HyperlinkExternalPageDestination | ||
properties : Object
A property that allows setting of several properties at the same time. | HyperlinkExternalPageDestination | ||
viewBounds : Object
The view rectangle, specified in the format [y1, x1, y2, x2]. | HyperlinkExternalPageDestination | ||
viewPercentage : Number
The zoom percentage. | HyperlinkExternalPageDestination | ||
viewSetting : HyperlinkDestinationPageSetting
The destination page size when the page is reached by clicking the hyperlink. | HyperlinkExternalPageDestination |
Method | Defined By | ||
---|---|---|---|
addEventListenerHyperlinkExternalPageDestination(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | HyperlinkExternalPageDestination | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | HyperlinkExternalPageDestination | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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. | HyperlinkExternalPageDestination | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | 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. | HyperlinkExternalPageDestination | ||
![]() | 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 HyperlinkExternalPageDestination. | HyperlinkExternalPageDestination | ||
removeEventListenerHyperlinkExternalPageDestination(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | HyperlinkExternalPageDestination | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
showDestination():void
Jumps to the hyperlink destination. | HyperlinkExternalPageDestination | ||
toSpecifier():String
Retrieves the object specifier. | HyperlinkExternalPageDestination | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
destinationPageIndex | property |
destinationPageIndex:Number
Since : | CS5 |
The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page.
public function get destinationPageIndex():Number
public function set destinationPageIndex(value:Number):void
documentPath | property |
documentPath:File
Since : | CS5 |
The path to the document that the hyperlink destination points to.
public function get documentPath():File
public function set documentPath(value:File):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
hidden | property |
hidden:Boolean
[read-only] Since : | CS5 |
If true, the hyperlink is hidden.
public function get hidden():Boolean
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the HyperlinkExternalPageDestination.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the HyperlinkExternalPageDestination within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
[read-only] Since : | CS5 |
The name of the HyperlinkExternalPageDestination.
public function get name():String
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the HyperlinkExternalPageDestination (a Document).
public function get parent():Document
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
viewBounds | property |
viewBounds:Object
Since : | CS5 |
The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed. Can return: Ordered array containing top:Unit, left:Unit, bottom:Unit, right:Unit.
public function get viewBounds():Object
public function set viewBounds(value:Object):void
viewPercentage | property |
viewPercentage:Number
Since : | CS5 |
The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed.
public function get viewPercentage():Number
public function set viewPercentage(value:Number):void
viewSetting | property |
viewSetting:HyperlinkDestinationPageSetting
Since : | CS5 |
The destination page size when the page is reached by clicking the hyperlink.
public function get viewSetting():HyperlinkDestinationPageSetting
public function set viewSetting(value:HyperlinkDestinationPageSetting):void
addEventListenerHyperlinkExternalPageDestination | () | method |
public function addEventListenerHyperlinkExternalPageDestination(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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
Since : | CS5 |
Deletes the HyperlinkExternalPageDestination.
removeEventListenerHyperlinkExternalPageDestination | () | method |
public function removeEventListenerHyperlinkExternalPageDestination(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
showDestination | () | method |
public function showDestination():void
Since : | CS5 |
Jumps to the hyperlink destination.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |