Package | com.adobe.photoshop |
Class | public class ActionDescriptor |
Inheritance | ActionDescriptor ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
count : Number [read-only]
number of keys contained in the descriptor
| ActionDescriptor | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
![]() | parent : * [read-only] | PhotoshopHostObject |
Method | Defined By | ||
---|---|---|---|
clear():void
Clears the descriptor. | ActionDescriptor | ||
erase(key:Number):void
Erases a key from the descriptor. | ActionDescriptor | ||
![]() | 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 | |
fromID(value:Number):void
Create descriptor from the given ID. | ActionDescriptor | ||
fromStream(value:String):void
Creates a descriptor from a stream of bytes; for reading from disk. | ActionDescriptor | ||
getBoolean(key:Number):Boolean
Gets the value of a key of type boolean. | ActionDescriptor | ||
getClass(key:Number):Number
Gets the value of a key of type class. | ActionDescriptor | ||
![]() | 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 | |
getData(key:Number):String
Gets raw byte data as a string value. | ActionDescriptor | ||
getDouble(key:Number):Number
Gets the value of a key of type double. | ActionDescriptor | ||
getEnumerationType(key:Number):Number
Gets the enumeration type of a key. | ActionDescriptor | ||
getEnumerationValue(key:Number):Number
Gets the enumeration value of a key. | ActionDescriptor | ||
getInteger(key:Number):Number
Gets the value of a key of type integer. | ActionDescriptor | ||
getKey(index:Number):Number
Gets the ID of the Nth key, provided by index. | ActionDescriptor | ||
getList(key:Number):ActionList
Gets the value of a key of type list. | ActionDescriptor | ||
getObjectType(key:Number):Number
Gets the class ID of an object in a key of type object. | ActionDescriptor | ||
getObjectValue(key:Number):ActionDescriptor
Gets the value of a key of type object. | ActionDescriptor | ||
getPath(key:Number):File
Gets the value of a key of type File. | ActionDescriptor | ||
getReference(key:Number):ActionReference
Gets the value of a key of type ActionReference. | ActionDescriptor | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
getString(key:Number):String
Gets the value of a key of type string. | ActionDescriptor | ||
getType(key:Number):DescValueType
Gets the type of a key. | ActionDescriptor | ||
getUnitDoubleType(key:Number):Number
Gets the unit type of a key of type UnitDouble. | ActionDescriptor | ||
getUnitDoubleValue(key:Number):Number
... | ActionDescriptor | ||
hasKey(key:Number):Boolean
... | ActionDescriptor | ||
![]() | 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 | |
isEqual(otherDesc:ActionDescriptor):Boolean
... | ActionDescriptor | ||
putBoolean(key:Number, value:Boolean):void
... | ActionDescriptor | ||
putClass(key:Number, value:Number):void
... | ActionDescriptor | ||
putData(key:Number, value:String):void
... | ActionDescriptor | ||
putDouble(key:Number, value:Number):void
... | ActionDescriptor | ||
putEnumerated(key:Number, enumType:Number, value:Number):void
... | ActionDescriptor | ||
putInteger(key:Number, value:Number):void
... | ActionDescriptor | ||
putList(key:Number, value:ActionList):void
... | ActionDescriptor | ||
putObject(key:Number, classID:Number, value:ActionDescriptor):void
... | ActionDescriptor | ||
putPath(key:Number, value:File):void
... | ActionDescriptor | ||
putReference(key:Number, value:ActionReference):void
... | ActionDescriptor | ||
putString(key:Number, value:String):void
... | ActionDescriptor | ||
putUnitDouble(key:Number, unitID:Number, value:Number):void
... | ActionDescriptor | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toStream():String
... | ActionDescriptor | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
count | property |
count:Number
[read-only] Since : | CS5 |
number of keys contained in the descriptor
public function get count():Number
clear | () | method |
public function clear():void
Since : | CS5 |
Clears the descriptor.
erase | () | method |
public function erase(key:Number):void
Since : | CS5 |
Erases a key from the descriptor.
Parameters
key:Number — (Number) ID of key to erase
|
fromID | () | method |
public function fromID(value:Number):void
Since : | CS5 |
Create descriptor from the given ID. Only use with Flash Panel interface.
Parameters
value:Number — (Number)
|
fromStream | () | method |
public function fromStream(value:String):void
Since : | CS5 |
Creates a descriptor from a stream of bytes; for reading from disk.
Parameters
value:String — (String)
|
getBoolean | () | method |
public function getBoolean(key:Number):Boolean
Since : | CS5 |
Gets the value of a key of type boolean.
Parameters
key:Number — (Number)
|
Boolean |
getClass | () | method |
public function getClass(key:Number):Number
Since : | CS5 |
Gets the value of a key of type class.
Parameters
key:Number — (Number)
|
Number |
getData | () | method |
public function getData(key:Number):String
Since : | CS5 |
Gets raw byte data as a string value.
Parameters
key:Number — (Number)
|
String |
getDouble | () | method |
public function getDouble(key:Number):Number
Since : | CS5 |
Gets the value of a key of type double.
Parameters
key:Number — (Number)
|
Number |
getEnumerationType | () | method |
public function getEnumerationType(key:Number):Number
Since : | CS5 |
Gets the enumeration type of a key.
Parameters
key:Number — (Number)
|
Number |
getEnumerationValue | () | method |
public function getEnumerationValue(key:Number):Number
Since : | CS5 |
Gets the enumeration value of a key.
Parameters
key:Number — (Number)
|
Number |
getInteger | () | method |
public function getInteger(key:Number):Number
Since : | CS5 |
Gets the value of a key of type integer.
Parameters
key:Number — (Number)
|
Number |
getKey | () | method |
public function getKey(index:Number):Number
Since : | CS5 |
Gets the ID of the Nth key, provided by index.
Parameters
index:Number — (Number)
|
Number |
getList | () | method |
public function getList(key:Number):ActionList
Since : | CS5 |
Gets the value of a key of type list.
Parameters
key:Number — (Number)
|
ActionList |
getObjectType | () | method |
public function getObjectType(key:Number):Number
Since : | CS5 |
Gets the class ID of an object in a key of type object.
Parameters
key:Number — (Number)
|
Number |
getObjectValue | () | method |
public function getObjectValue(key:Number):ActionDescriptor
Since : | CS5 |
Gets the value of a key of type object.
Parameters
key:Number — (Number)
|
ActionDescriptor |
getPath | () | method |
public function getPath(key:Number):File
Since : | CS5 |
Gets the value of a key of type File.
Parameters
key:Number — (Number)
|
File |
getReference | () | method |
public function getReference(key:Number):ActionReference
Since : | CS5 |
Gets the value of a key of type ActionReference.
Parameters
key:Number — (Number)
|
ActionReference |
getString | () | method |
public function getString(key:Number):String
Since : | CS5 |
Gets the value of a key of type string.
Parameters
key:Number — (Number)
|
String |
getType | () | method |
public function getType(key:Number):DescValueType
Since : | CS5 |
Gets the type of a key.
Parameters
key:Number — (Number)
|
DescValueType |
getUnitDoubleType | () | method |
public function getUnitDoubleType(key:Number):Number
Since : | CS5 |
Gets the unit type of a key of type UnitDouble.
Parameters
key:Number — (Number)
|
Number |
getUnitDoubleValue | () | method |
public function getUnitDoubleValue(key:Number):Number
Since : | CS5 |
...
Parameters
key:Number — (Number)
|
Number |
hasKey | () | method |
public function hasKey(key:Number):Boolean
Since : | CS5 |
...
Parameters
key:Number — (Number)
|
Boolean |
isEqual | () | method |
public function isEqual(otherDesc:ActionDescriptor):Boolean
Since : | CS5 |
...
Parameters
otherDesc:ActionDescriptor — (com.adobe.photoshop.ActionDescriptor)
|
Boolean |
putBoolean | () | method |
public function putBoolean(key:Number, value:Boolean):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:Boolean — (Boolean)
|
putClass | () | method |
public function putClass(key:Number, value:Number):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:Number — (Number)
|
putData | () | method |
public function putData(key:Number, value:String):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:String — (String)
|
putDouble | () | method |
public function putDouble(key:Number, value:Number):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:Number — (Number)
|
putEnumerated | () | method |
public function putEnumerated(key:Number, enumType:Number, value:Number):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
enumType:Number — (Number)
| |
value:Number — (Number)
|
putInteger | () | method |
public function putInteger(key:Number, value:Number):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:Number — (Number)
|
putList | () | method |
public function putList(key:Number, value:ActionList):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:ActionList — (com.adobe.photoshop.ActionList)
|
putObject | () | method |
public function putObject(key:Number, classID:Number, value:ActionDescriptor):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
classID:Number — (Number)
| |
value:ActionDescriptor — (com.adobe.photoshop.ActionDescriptor)
|
putPath | () | method |
public function putPath(key:Number, value:File):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:File — (flash.filesystem.File)
|
putReference | () | method |
public function putReference(key:Number, value:ActionReference):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:ActionReference — (com.adobe.photoshop.ActionReference)
|
putString | () | method |
public function putString(key:Number, value:String):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
value:String — (String)
|
putUnitDouble | () | method |
public function putUnitDouble(key:Number, unitID:Number, value:Number):void
Since : | CS5 |
...
Parameters
key:Number — (Number)
| |
unitID:Number — (Number)
| |
value:Number — (Number)
|
toStream | () | method |
public function toStream():String
Since : | CS5 |
...
ReturnsString |