Package | com.adobe.indesign |
Class | public class MetadataPreference |
Inheritance | MetadataPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
author : String
The author of the document. | MetadataPreference | ||
copyrightInfoURL : String
The URL of the file that contains the linked copyright statement. | MetadataPreference | ||
copyrightNotice : String
The text to use as a copyright notice. | MetadataPreference | ||
copyrightStatus : CopyrightStatus
The copyright status of the document. | MetadataPreference | ||
creationDate : Date [read-only]
The creation date of the document. | MetadataPreference | ||
creator : String [read-only]
The name of the application used to create the document. | MetadataPreference | ||
description : String
The description of the MetadataPreference. | MetadataPreference | ||
documentTitle : String
The title of the document. | MetadataPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | MetadataPreference | ||
events : Events [override] [read-only]
A collection of events. | MetadataPreference | ||
format : String [read-only]
The format of the document. | MetadataPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | MetadataPreference | ||
jobName : String
The job name. | MetadataPreference | ||
keywords : Object
The list of keywords associated with the document. | MetadataPreference | ||
modificationDate : Date [read-only]
The most recent modification date of the document. | MetadataPreference | ||
parent : Object [override] [read-only]
The parent of the MetadataPreference (a Document). | MetadataPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | MetadataPreference | ||
serverURL : String [read-only]
The location of the document on the asset management server. | MetadataPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerMetadataPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MetadataPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
append(fromParam:File = null, affectAllParam:Boolean = false):void
Uses metadata from the specified external file to define any undefined metadata properties in the document. | MetadataPreference | ||
countContainer(namespaceParam:String = null, pathParam:String = null):Number
Counts the number of items in the container. | MetadataPreference | ||
createContainerItem(namespaceParam:String = null, pathParam:String = null, indexParam:Number = 0, containerParam:ContainerType = null):void
Creates an empty container. | MetadataPreference | ||
![]() | 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. | MetadataPreference | ||
getProperty(namespaceParam:String = null, pathParam:String = null):String
Gets the XMP property value associated with the specified path. | MetadataPreference | ||
![]() | 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 | |
removeEventListenerMetadataPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MetadataPreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
replace(usingParam:File = null, affectAllParam:Boolean = false):void
Replaces the current metadata in the document with metadata from the specified file. | MetadataPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
save(toParam:File = null):void
Saves the metadata in the document to an external file. | MetadataPreference | ||
setProperty(namespaceParam:String = null, pathParam:String = null, valueParam:String = null):void
Sets the XMP property associated with the specified path. | MetadataPreference | ||
toSpecifier():String [override]
Retrieves the object specifier. | MetadataPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
author | property |
author:String
Since : | CS5 |
The author of the document.
public function get author():String
public function set author(value:String):void
copyrightInfoURL | property |
copyrightInfoURL:String
Since : | CS5 |
The URL of the file that contains the linked copyright statement.
public function get copyrightInfoURL():String
public function set copyrightInfoURL(value:String):void
copyrightNotice | property |
copyrightNotice:String
Since : | CS5 |
The text to use as a copyright notice.
public function get copyrightNotice():String
public function set copyrightNotice(value:String):void
copyrightStatus | property |
copyrightStatus:CopyrightStatus
Since : | CS5 |
The copyright status of the document.
public function get copyrightStatus():CopyrightStatus
public function set copyrightStatus(value:CopyrightStatus):void
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
Since : | CS5 |
The description of the MetadataPreference.
public function get description():String
public function set description(value:String):void
documentTitle | property |
documentTitle:String
Since : | CS5 |
The title of the document.
public function get documentTitle():String
public function set documentTitle(value:String):void
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
Since : | CS5 |
The job name.
public function get jobName():String
public function set jobName(value:String):void
keywords | property |
keywords:Object
Since : | CS5 |
The list of keywords associated with the document.
public function get keywords():Object
public function set keywords(value:Object):void
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 MetadataPreference (a Document).
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
addEventListenerMetadataPreference | () | method |
public function addEventListenerMetadataPreference(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 |
append | () | method |
public function append(fromParam:File = null, affectAllParam:Boolean = false):void
Since : | CS5 |
Uses metadata from the specified external file to define any undefined metadata properties in the document.
Parameters
fromParam:File (default = null ) — (File) The path to the external file that contains the metadata.
| |
affectAllParam:Boolean (default = false ) — (Boolean) If true, also replaces existing metadata with data from the external file. If false, does not replace existing metadata. Note: Defaults to false. (Optional)
|
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 |
createContainerItem | () | method |
public function createContainerItem(namespaceParam:String = null, pathParam:String = null, indexParam:Number = 0, containerParam:ContainerType = null):void
Since : | CS5 |
Creates an empty container.
Parameters
namespaceParam:String (default = null ) — (String) The namespace of the container.
| |
pathParam:String (default = null ) — (String) The path to the container.
| |
indexParam:Number (default = 0 ) — (Number) The index of the item within the container. Specified values must be 1 or greater. To append the item to the end of the index and allow the next available value to be assigned, use 0. (Optional)
| |
containerParam:ContainerType (default = null ) — (ContainerType) The container type. Note: Required when the new item is the first item added to the container. (Optional)
|
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 |
removeEventListenerMetadataPreference | () | method |
public function removeEventListenerMetadataPreference(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 |
replace | () | method |
public function replace(usingParam:File = null, affectAllParam:Boolean = false):void
Since : | CS5 |
Replaces the current metadata in the document with metadata from the specified file.
Parameters
usingParam:File (default = null ) — (File) The full path to the file that contains the replacement metadata.
| |
affectAllParam:Boolean (default = false ) — (Boolean) If true, treats all properties as external. Note: Defaults to false. (Optional)
|
save | () | method |
public function save(toParam:File = null):void
Since : | CS5 |
Saves the metadata in the document to an external file.
Parameters
toParam:File (default = null ) — (File) The path to the external file.
|
setProperty | () | method |
public function setProperty(namespaceParam:String = null, pathParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the XMP property associated with the specified path.
Parameters
namespaceParam:String (default = null ) — (String) The namespace of the property.
| |
pathParam:String (default = null ) — (String) The specified path(s).
| |
valueParam:String (default = null ) — (String) The value to assign to the property. Note: To remove the property, pass an empty string.
|
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |