Package | com.adobe.indesign |
Class | public class Link |
Inheritance | Link ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_ATTRIBUTE_CHANGED : String [static] [read-only]
Dispatched when the value of a property changes on this Link. | Link | ||
AFTER_DELETE : String [static] [read-only]
Dispatched after a Link is deleted. | Link | ||
AFTER_EMBED : String [static] [read-only]
Dispatched after a Link is embedded. | Link | ||
AFTER_MOVE : String [static] [read-only]
Dispatched after a Link is relocated from one object to another. | Link | ||
AFTER_NEW : String [static] [read-only]
Dispatched after a Link is created. | Link | ||
AFTER_UNEMBED : String [static] [read-only]
Dispatched after a Link is unembedded. | Link | ||
AFTER_UPDATE : String [static] [read-only]
Dispatched after a Link is updated. | Link | ||
assetID : String [read-only]
The asset ID of the linked object. | Link | ||
assetURL : String [read-only]
The asset URL of the linked object. | Link | ||
BEFORE_DELETE : String [static] [read-only]
Dispatched before a Link is deleted. | Link | ||
BEFORE_EMBED : String [static] [read-only]
Dispatched before a Link is embedded. | Link | ||
BEFORE_MOVE : String [static] [read-only]
Dispatched before a Link is relocated from one object to another. | Link | ||
BEFORE_UNEMBED : String [static] [read-only]
Dispatched before a Link is unembedded. | Link | ||
BEFORE_UPDATE : String [static] [read-only]
Dispatched before a Link is updated. | Link | ||
date : Date [read-only]
The date and time the Link was created. | Link | ||
edited : Boolean [read-only]
If true, indicates the linked object has been edited in the current document but the source file has not been updated. | Link | ||
editingState : EditingState [read-only]
The Version Cue editing state of the file. | Link | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Link | ||
events : Events [read-only]
A collection of events. | Link | ||
filePath : String [read-only]
The file path (colon delimited on the Mac OS). | Link | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Link. | Link | ||
index : Number [read-only]
The index of the link in the links collection. | Link | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Link | ||
label : String
A property that can be set to any string. | Link | ||
links : Links [read-only]
A collection of links. | Link | ||
linkType : String [read-only]
The file type of the linked object. | Link | ||
linkXmp : LinkMetadata [read-only]
XMP data for the link source file. | Link | ||
name : String [read-only]
The name of the Link. | Link | ||
needed : Boolean [read-only]
If true, indicates a link to a full-resolution version of the source file is needed. | Link | ||
parent : Object [read-only]
The linked object. | Link | ||
preferences : Preferences [read-only]
A collection of preferences objects. | Link | ||
properties : Object
A property that allows setting of several properties at the same time. | Link | ||
size : Number [read-only]
The size of the Link file. | Link | ||
status : LinkStatus [read-only]
The status of the link. | Link | ||
versionState : VersionState [read-only]
The Version Cue version state of the file. | Link |
Method | Defined By | ||
---|---|---|---|
addEventListenerLink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Link | ||
checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Check in to Version Cue. | Link | ||
copyLink(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Copies the link file to the specified location. | Link | ||
editOriginal():void
Opens the source file of the link in the default editor for the source file type. | Link | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Link | ||
![]() | 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. | Link | ||
![]() | 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. | Link | ||
![]() | 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 | |
relink(toParam:Object = null):void
Points the link to a new source file. | Link | ||
removeEventListenerLink(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Link | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
revealInBridge():void
Opens Adobe Bridge and selects the source file of the link. | Link | ||
revealInSystem():void
Opens the file system to the folder that contains the source file of the link, and selects the file. | Link | ||
show():void
Selects the link. | Link | ||
toSpecifier():String
Retrieves the object specifier. | Link | ||
unembed(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Unembeds the source file. | Link | ||
unlink():void
Embeds the source file in the document. | Link | ||
Updates the link if the source file has been changed. | Link | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_ATTRIBUTE_CHANGED | property |
AFTER_ATTRIBUTE_CHANGED:String
[read-only] Since : | CS5 |
Dispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable.
public static function get AFTER_ATTRIBUTE_CHANGED():String
AFTER_DELETE | property |
AFTER_DELETE:String
[read-only] Since : | CS5 |
Dispatched after a Link is deleted. This event bubbles. This event is not cancelable.
public static function get AFTER_DELETE():String
AFTER_EMBED | property |
AFTER_EMBED:String
[read-only] Since : | CS5 |
Dispatched after a Link is embedded. This event bubbles. This event is not cancelable.
public static function get AFTER_EMBED():String
AFTER_MOVE | property |
AFTER_MOVE:String
[read-only] Since : | CS5 |
Dispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable.
public static function get AFTER_MOVE():String
AFTER_NEW | property |
AFTER_NEW:String
[read-only] Since : | CS5 |
Dispatched after a Link is created. This event bubbles. This event is not cancelable.
public static function get AFTER_NEW():String
AFTER_UNEMBED | property |
AFTER_UNEMBED:String
[read-only] Since : | CS5 |
Dispatched after a Link is unembedded. This event bubbles. This event is not cancelable.
public static function get AFTER_UNEMBED():String
AFTER_UPDATE | property |
AFTER_UPDATE:String
[read-only] Since : | CS5 |
Dispatched after a Link is updated. This event bubbles. This event is not cancelable.
public static function get AFTER_UPDATE():String
assetID | property |
assetID:String
[read-only] Since : | CS5 |
The asset ID of the linked object.
public function get assetID():String
assetURL | property |
assetURL:String
[read-only] Since : | CS5 |
The asset URL of the linked object.
public function get assetURL():String
BEFORE_DELETE | property |
BEFORE_DELETE:String
[read-only] Since : | CS5 |
Dispatched before a Link is deleted. This event bubbles. This event is cancelable.
public static function get BEFORE_DELETE():String
BEFORE_EMBED | property |
BEFORE_EMBED:String
[read-only] Since : | CS5 |
Dispatched before a Link is embedded. This event bubbles. This event is cancelable.
public static function get BEFORE_EMBED():String
BEFORE_MOVE | property |
BEFORE_MOVE:String
[read-only] Since : | CS5 |
Dispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable.
public static function get BEFORE_MOVE():String
BEFORE_UNEMBED | property |
BEFORE_UNEMBED:String
[read-only] Since : | CS5 |
Dispatched before a Link is unembedded. This event bubbles. This event is cancelable.
public static function get BEFORE_UNEMBED():String
BEFORE_UPDATE | property |
BEFORE_UPDATE:String
[read-only] Since : | CS5 |
Dispatched before a Link is updated. This event bubbles. This event is cancelable.
public static function get BEFORE_UPDATE():String
date | property |
date:Date
[read-only] Since : | CS5 |
The date and time the Link was created.
public function get date():Date
edited | property |
edited:Boolean
[read-only] Since : | CS5 |
If true, indicates the linked object has been edited in the current document but the source file has not been updated.
public function get edited():Boolean
editingState | property |
editingState:EditingState
[read-only] Since : | CS5 |
The Version Cue editing state of the file.
public function get editingState():EditingState
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
filePath | property |
filePath:String
[read-only] Since : | CS5 |
The file path (colon delimited on the Mac OS). Can also accept: File.
public function get filePath():String
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Link.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the link in the links collection.
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
links | property |
links:Links
[read-only] Since : | CS5 |
A collection of links.
public function get links():Links
linkType | property |
linkType:String
[read-only] Since : | CS5 |
The file type of the linked object.
public function get linkType():String
linkXmp | property |
linkXmp:LinkMetadata
[read-only] Since : | CS5 |
XMP data for the link source file.
public function get linkXmp():LinkMetadata
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Link.
public function get name():String
needed | property |
needed:Boolean
[read-only] Since : | CS5 |
If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
public function get needed():Boolean
parent | property |
parent:Object
[read-only] Since : | CS5 |
The linked object. Can return: Story, Graphic, Movie or Sound.
public function get parent():Object
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
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
size | property |
size:Number
[read-only] Since : | CS5 |
The size of the Link file.
public function get size():Number
status | property |
status:LinkStatus
[read-only] Since : | CS5 |
The status of the link.
public function get status():LinkStatus
versionState | property |
versionState:VersionState
[read-only] Since : | CS5 |
The Version Cue version state of the file.
public function get versionState():VersionState
addEventListenerLink | () | method |
public function addEventListenerLink(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 |
checkIn | () | method |
public function checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Check in to Version Cue.
Parameters
versionCommentsParam:String (default = null ) — (String) The comment for this version (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) Forcibly save a version (Optional)
|
copyLink | () | method |
public function copyLink(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Copies the link file to the specified location.
Parameters
toParam:File (default = null ) — (File) The file or folder to which to copy the file.
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
editOriginal | () | method |
public function editOriginal():void
Since : | CS5 |
Opens the source file of the link in the default editor for the source file type.
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.
|
relink | () | method |
public function relink(toParam:Object = null):void
Since : | CS5 |
Points the link to a new source file.
Parameters
toParam:Object (default = null ) — (Object) The full path name of the new source file. Can accept: File or String.
|
removeEventListenerLink | () | method |
public function removeEventListenerLink(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 |
revealInBridge | () | method |
public function revealInBridge():void
Since : | CS5 |
Opens Adobe Bridge and selects the source file of the link.
revealInSystem | () | method |
public function revealInSystem():void
Since : | CS5 |
Opens the file system to the folder that contains the source file of the link, and selects the file.
show | () | method |
public function show():void
Since : | CS5 |
Selects the link.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
unembed | () | method |
public function unembed(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Unembeds the source file. If no folder is specified, creates a link to the original source file; if a folder is specified, copies the file to the folder and creates a link to the copied file.
Parameters
toParam:File (default = null ) — (File) The folder to which to copy the unembedded file. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
unlink | () | method |
public function unlink():void
Since : | CS5 |
Embeds the source file in the document.
update | () | method |
public function update():Link
Since : | CS5 |
Updates the link if the source file has been changed.
ReturnsLink |