Package | com.adobe.illustrator |
Class | public class Artboards |
Inheritance | Artboards ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
number of elements in the collection
| Artboards | ||
![]() | parent : * [read-only] | IllustratorHostObject |
Method | Defined By | ||
---|---|---|---|
add artboard object
| Artboards | ||
![]() | 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 | |
getActiveArtboardIndex():Number
Retrieves the index position of the active artboard in the document's list. | Artboards | ||
Get the first element in the collection with the provided name. | Artboards | ||
![]() | 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. | Artboards | ||
insert(artboardRect:Array, index:Number):void
Insert an Artboard at specified location
| Artboards | ||
![]() | 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 | |
remove(index:Number):void
Delete artboard object. | Artboards | ||
removeAll():void | Artboards | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
setActiveArtboardIndex(index:Number):void
Makes a specific artboard active, and makes it current in the iteration order. | Artboards | ||
![]() | 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
| Artboards | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| Artboards |
length | property |
length:Number
[read-only] Since : | CS5 |
number of elements in the collection
public function get length():Number
add | () | method |
public function add(artboardRect:Array):Artboard
Since : | CS5 |
add artboard object
Parameters
artboardRect:Array — (Array) size and position of artboard
|
Artboard |
getActiveArtboardIndex | () | method |
public function getActiveArtboardIndex():Number
Since : | CS5 |
Retrieves the index position of the active artboard in the document's list.
ReturnsNumber |
getByName | () | method |
public function getByName(artboardName:String):Artboard
Since : | CS5.5 |
Get the first element in the collection with the provided name.
Parameters
artboardName:String — (String) The name of the artboard
|
Artboard |
index | () | method |
public function index(idx:Number):Artboard
Since : | CS5 |
Get the element in the collection at the provided index.
Parameters
idx:Number |
Artboard |
insert | () | method |
public function insert(artboardRect:Array, index:Number):void
Since : | CS5.5 |
Insert an Artboard at specified location
Parameters
artboardRect:Array — (Array) size and position of artboard
| |
index:Number — (Number) index position where artboard should be inserted
|
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 |
* |
remove | () | method |
public function remove(index:Number):void
Since : | CS5 |
Delete artboard object.
Parameters
index:Number — (Number) Index of the crop area to be deleted.
|
removeAll | () | method |
public function removeAll():void
Since : | CS5 |
setActiveArtboardIndex | () | method |
public function setActiveArtboardIndex(index:Number):void
Since : | CS5 |
Makes a specific artboard active, and makes it current in the iteration order.
Parameters
index:Number — (Number) The 0-based index position of the artboard in the document list.
|