Package | com.adobe.indesign |
Class | public class LinkMetadata |
Inheritance | LinkMetadata ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
author : String [read-only]
The author of the document. | LinkMetadata | ||
copyrightInfoURL : String [read-only]
The URL of the file that contains the linked copyright statement. | LinkMetadata | ||
copyrightNotice : String [read-only]
The text to use as a copyright notice. | LinkMetadata | ||
copyrightStatus : CopyrightStatus [read-only]
The copyright status of the document. | LinkMetadata | ||
creationDate : Date [read-only]
The creation date of the document. | LinkMetadata | ||
creator : String [read-only]
The name of the application used to create the document. | LinkMetadata | ||
description : String [read-only]
The description of the LinkMetadata. | LinkMetadata | ||
documentTitle : String [read-only]
The title of the document. | LinkMetadata | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | LinkMetadata | ||
events : Events [override] [read-only]
A collection of events. | LinkMetadata | ||
format : String [read-only]
The format of the document. | LinkMetadata | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | LinkMetadata | ||
jobName : String [read-only]
The job name. | LinkMetadata | ||
keywords : Object [read-only]
The list of keywords associated with the document. | LinkMetadata | ||
modificationDate : Date [read-only]
The most recent modification date of the document. | LinkMetadata | ||
parent : Object [override] [read-only]
The parent of the LinkMetadata (a Link). | LinkMetadata | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | LinkMetadata | ||
serverURL : String [read-only]
The location of the document on the asset management server. | LinkMetadata |
Method | Defined By | ||
---|---|---|---|
addEventListenerLinkMetadata(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | LinkMetadata | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
countContainer(namespaceParam:String = null, pathParam:String = null):Number
Counts the number of items in the container. | LinkMetadata | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | LinkMetadata | ||
getProperty(namespaceParam:String = null, pathParam:String = null):String
Gets the XMP property value associated with the specified path. | LinkMetadata | ||
![]() | 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 | |
![]() | 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 | |
removeEventListenerLinkMetadata(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | LinkMetadata | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | LinkMetadata | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
author | property |
author:String
[read-only] Since : | CS5 |
The author of the document.
public function get author():String
copyrightInfoURL | property |
copyrightInfoURL:String
[read-only] Since : | CS5 |
The URL of the file that contains the linked copyright statement.
public function get copyrightInfoURL():String
copyrightNotice | property |
copyrightNotice:String
[read-only] Since : | CS5 |
The text to use as a copyright notice.
public function get copyrightNotice():String
copyrightStatus | property |
copyrightStatus:CopyrightStatus
[read-only] Since : | CS5 |
The copyright status of the document.
public function get copyrightStatus():CopyrightStatus
creationDate | property |
creationDate:Date
[read-only] Since : | CS5 |
The creation date of the document.
public function get creationDate():Date
creator | property |
creator:String
[read-only] Since : | CS5 |
The name of the application used to create the document.
public function get creator():String
description | property |
description:String
[read-only] Since : | CS5 |
The description of the LinkMetadata.
public function get description():String
documentTitle | property |
documentTitle:String
[read-only] Since : | CS5 |
The title of the document.
public function get documentTitle():String
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
format | property |
format:String
[read-only] Since : | CS5 |
The format of the document.
public function get format():String
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
jobName | property |
jobName:String
[read-only] Since : | CS5 |
The job name.
public function get jobName():String
keywords | property |
keywords:Object
[read-only] Since : | CS5 |
The list of keywords associated with the document.
public function get keywords():Object
modificationDate | property |
modificationDate:Date
[read-only] Since : | CS5 |
The most recent modification date of the document.
public function get modificationDate():Date
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the LinkMetadata (a Link).
public function get parent():Object
properties | property |
properties:Object
[override] 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
serverURL | property |
serverURL:String
[read-only] Since : | CS5 |
The location of the document on the asset management server.
public function get serverURL():String
addEventListenerLinkMetadata | () | method |
public function addEventListenerLinkMetadata(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 |
countContainer | () | method |
public function countContainer(namespaceParam:String = null, pathParam:String = null):Number
Since : | CS5 |
Counts the number of items in the container.
Parameters
namespaceParam:String (default = null ) — (String) The namespace of the container.
| |
pathParam:String (default = null ) — (String) The path to the container.
|
Number |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
getProperty | () | method |
public function getProperty(namespaceParam:String = null, pathParam:String = null):String
Since : | CS5 |
Gets the XMP property value associated with the specified path.
Parameters
namespaceParam:String (default = null ) — (String) The namespace of the property.
| |
pathParam:String (default = null ) — (String) The specified path.
|
String |
removeEventListenerLinkMetadata | () | method |
public function removeEventListenerLinkMetadata(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 |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |