Packagecom.adobe.photoshop
Classpublic class Documents
InheritanceDocuments Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

A collection of documents



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] number of elements in the collection
Documents
 Inheritedparent : *
[read-only]
PhotoshopHostObject
Public Methods
 MethodDefined By
  
add(width:String = null, height:String = 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
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
getByName(nameParam:String):Document
Get the first element in the collection with the provided name.
Documents
 Inherited
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
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
index(idx:Number):Document
Get the element in the collection at the provided index.
Documents
 Inherited
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
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
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
Property Detail
lengthproperty
length:Number  [read-only]

number of elements in the collection


Implementation
    public function get length():Number
Method Detail
add()method
public function add(width:String = null, height:String = 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

Parameters

width:String (default = null) — (String) width of the document (unit value)
 
height:String (default = null) — (String) 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

Returns
Document
getByName()method 
public function getByName(nameParam:String):Document

Get the first element in the collection with the provided name.

Parameters

nameParam:String

Returns
Document
index()method 
public function index(idx:Number):Document

Get the element in the collection at the provided index.

Parameters

idx:Number

Returns
Document
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*