Package | com.adobe.photoshop |
Class | public class Documents |
Inheritance | Documents ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
number of elements in the collection
| Documents | ||
![]() | parent : * [read-only] | PhotoshopHostObject |
Method | Defined By | ||
---|---|---|---|
add(width:Object = null, height:Object = null, resolution:Number = 72, name:String = null, mode:NewDocumentMode = null, initialFill:DocumentFill = null, pixelAspectRatio:Number = 1.0, bitsPerChannel:BitsPerChannelType = null, colorProfileName:String = null):Document
a document
| Documents | ||
![]() | 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 | |
Get the first element in the collection with the provided name. | Documents | ||
![]() | 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 | |
![]() | 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 | |
Get the element in the collection at the provided index. | Documents | ||
![]() | 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 | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
![]() | createWithArgs(args:Array):void | CSHostObject | |
![]() | hostCreate(args:Array):void | CSHostObject | |
nextNameIndex(idx:int):int [override]
Overriding this allows us to support for each...in
| Documents | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| Documents |
length | property |
length:Number
[read-only] Since : | CS5 |
number of elements in the collection
public function get length():Number
add | () | method |
public function add(width:Object = null, height:Object = null, resolution:Number = 72, name:String = null, mode:NewDocumentMode = null, initialFill:DocumentFill = null, pixelAspectRatio:Number = 1.0, bitsPerChannel:BitsPerChannelType = null, colorProfileName:String = null):Document
Since : | CS5 |
a document
Parameters
width:Object (default = null ) — (Object) width of the document (unit value)
| |
height:Object (default = null ) — (Object) height of the document (unit value)
| |
resolution:Number (default = 72 ) — (Number) Resolution of the document (in pixels per inch) ( default: 72.0 )
| |
name:String (default = null ) — (String) name of document
| |
mode:NewDocumentMode (default = null ) — (com.adobe.photoshop.NewDocumentMode) document mode (Bitmap, Grayscale, RGB, CMYK or Lab) ( default: NewDocumentMode.RGB )
| |
initialFill:DocumentFill (default = null ) — (com.adobe.photoshop.DocumentFill) Initial fill of the document ( default: DocumentFill.WHITE )
| |
pixelAspectRatio:Number (default = 1.0 ) — (Number) Initial pixel aspect ratio of the document ( default: 1.0 )
| |
bitsPerChannel:BitsPerChannelType (default = null ) — (com.adobe.photoshop.BitsPerChannelType) number of bits per channel ( default: BitsPerChannelType.EIGHT )
| |
colorProfileName:String (default = null ) — (String) name of color profile for document
|
Document |
getByName | () | method |
public function getByName(nameParam:String):Document
Since : | CS5 |
Get the first element in the collection with the provided name.
Parameters
nameParam:String |
Document |
index | () | method |
public function index(idx:Number):Document
Since : | CS5 |
Get the element in the collection at the provided index.
Parameters
idx:Number |
Document |
nextNameIndex | () | method |
override flash_proxy function nextNameIndex(idx:int):int
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
idx:int |
int |
nextValue | () | method |
override flash_proxy function nextValue(index:int):*
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
index:int |
* |