Packagecom.adobe.illustrator
Classpublic class PathItems
InheritancePathItems Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

A collection of path items



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] number of elements in the collection
PathItems
 Inheritedparent : *
[read-only]
IllustratorHostObject
Public Methods
 MethodDefined By
  
create a path
PathItems
  
ellipse(top:Number = 100, left:Number = 100, width:Number = 50, height:Number = 100, reversed:Boolean = false, inscribed:Boolean = true):PathItem
Create an elliptical path item.
PathItems
 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):PathItem
Get the first element in the collection with the provided name.
PathItems
 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):PathItem
Get the element in the collection at the provided index.
PathItems
 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
  
polygon(centerX:Number = 200, centerY:Number = 300, radius:Number = 50, sides:Number = 8, reversed:Boolean = false):PathItem
Used to create a regular polygon path item.
PathItems
  
rectangle(top:Number, left:Number, width:Number, height:Number, reversed:Boolean = false):PathItem
Used to create a rectangular path item.
PathItems
  
removeAll():void
PathItems
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
roundedRectangle(top:Number, left:Number, width:Number, height:Number, horizontalRadius:Number = 15, verticalRadius:Number = 20, reversed:Boolean = false):PathItem
Used to create a rounded-corner rectangular path item.
PathItems
  
star(centerX:Number = 200, centerY:Number = 300, radius:Number = 50, innerRadius:Number = 20, points:Number = 5, reversed:Boolean = false):PathItem
Used to create a star-shaped path item.
PathItems
 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
PathItems
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
PathItems
Property Detail
lengthproperty
length:Number  [read-only]

Since : CS5

number of elements in the collection


Implementation
    public function get length():Number
Method Detail
add()method
public function add():PathItem

Since : CS5

create a path

Returns
PathItem
ellipse()method 
public function ellipse(top:Number = 100, left:Number = 100, width:Number = 50, height:Number = 100, reversed:Boolean = false, inscribed:Boolean = true):PathItem

Since : CS5

Create an elliptical path item.

Parameters

top:Number (default = 100) — (Number) the ellipse's bounds ( default: 100.0 )
 
left:Number (default = 100) — (Number) the ellipse's bounds ( default: 100.0 )
 
width:Number (default = 50) — (Number) the ellipse's bounds ( default: 50.0 )
 
height:Number (default = 100) — (Number) the height of the ellipse ( default: 100.0 )
 
reversed:Boolean (default = false) — (Boolean) is the ellipse path reversed? ( default: false )
 
inscribed:Boolean (default = true) — (Boolean) is the ellipse path inscribed? ( default: true )

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

Since : CS5

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

Parameters

nameParam:String

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

Since : CS5

Get the element in the collection at the provided index.

Parameters

idx:Number

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

Since : CS5

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

Parameters

idx:int

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

Since : CS5

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

Parameters

index:int

Returns
*
polygon()method 
public function polygon(centerX:Number = 200, centerY:Number = 300, radius:Number = 50, sides:Number = 8, reversed:Boolean = false):PathItem

Since : CS5

Used to create a regular polygon path item. Not for path item access.

Parameters

centerX:Number (default = 200) — (Number) ( default: 200.0 )
 
centerY:Number (default = 300) — (Number) ( default: 300.0 )
 
radius:Number (default = 50) — (Number) the radius of the polygon points ( default: 50.0 )
 
sides:Number (default = 8) — (Number) the number of sides on the polygon ( default: 8 )
 
reversed:Boolean (default = false) — (Boolean) is the polygon path reversed? ( default: false )

Returns
PathItem
rectangle()method 
public function rectangle(top:Number, left:Number, width:Number, height:Number, reversed:Boolean = false):PathItem

Since : CS5

Used to create a rectangular path item. Not for path item access.

Parameters

top:Number — (Number) the top coordinate of the rectangle's bounds
 
left:Number — (Number) the left coordinate of the rectangle's bounds
 
width:Number — (Number) the width of the rectangle
 
height:Number — (Number) the height of the rectangle
 
reversed:Boolean (default = false) — (Boolean) is the rectangle path reversed? ( default: false )

Returns
PathItem
removeAll()method 
public function removeAll():void

Since : CS5

roundedRectangle()method 
public function roundedRectangle(top:Number, left:Number, width:Number, height:Number, horizontalRadius:Number = 15, verticalRadius:Number = 20, reversed:Boolean = false):PathItem

Since : CS5

Used to create a rounded-corner rectangular path item. Not for path item access.

Parameters

top:Number — (Number)
 
left:Number — (Number)
 
width:Number — (Number)
 
height:Number — (Number)
 
horizontalRadius:Number (default = 15) — (Number) horizontal corner radius ( default: 15.0 )
 
verticalRadius:Number (default = 20) — (Number) vertical corner radius ( default: 20.0 )
 
reversed:Boolean (default = false) — (Boolean) is the rectangle path reversed? ( default: false )

Returns
PathItem
star()method 
public function star(centerX:Number = 200, centerY:Number = 300, radius:Number = 50, innerRadius:Number = 20, points:Number = 5, reversed:Boolean = false):PathItem

Since : CS5

Used to create a star-shaped path item. Not for path item access.

Parameters

centerX:Number (default = 200) — (Number) ( default: 200.0 )
 
centerY:Number (default = 300) — (Number) ( default: 300.0 )
 
radius:Number (default = 50) — (Number) the outside radius of the star points ( default: 50.0 )
 
innerRadius:Number (default = 20) — (Number) the inside radius of the star points ( default: 20.0 )
 
points:Number (default = 5) — (Number) the number of points on the star ( default: 5 )
 
reversed:Boolean (default = false) — (Boolean) is the star path reversed? ( default: false )

Returns
PathItem