Packagecom.adobe.photoshop
Classpublic class PathItem
InheritancePathItem Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

A path or drawing object, such as the outline of a shape or a straight or curved line, which contains sub paths that comprise its geometry.



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  kind : PathKind
The type of path.
PathItem
  name : String
The name of the path item.
PathItem
 Inheritedparent : *
[read-only]
PhotoshopHostObject
  subPathItems : SubPathItems
[read-only] The sub path objects for this path item.
PathItem
Public Methods
 MethodDefined By
  
deselect():void
Unselects the selection, no path items are selected.
PathItem
  
duplicate(name:String = null):PathItem
Duplicate this object.
PathItem
  
fillPath(fillColor:Object = null, mode:ColorBlendMode = null, opacity:Number, preserveTransparency:Boolean, feather:Number, antiAlias:Boolean, wholePath:Boolean):void
Fills the area enclosed by the path.
PathItem
 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
 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
 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
  
makeClippingPath(flatness:Number):void
Makes this path item the clipping path for this document.
PathItem
  
makeSelection(feather:Number, antiAlias:Boolean, operation:SelectionType = null):void
Makes a selection object, whose border is the path, from this path item object.
PathItem
  
remove():void
delete the object
PathItem
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
select():void
Makes this path item the active or selected path item.
PathItem
  
strokePath(tool:ToolType = null, simulatePressure:Boolean):void
Strokes the path.
PathItem
 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
Property Detail
kindproperty
kind:PathKind

The type of path.


Implementation
    public function get kind():PathKind
    public function set kind(value:PathKind):void
nameproperty 
name:String

The name of the path item.


Implementation
    public function get name():String
    public function set name(value:String):void
subPathItemsproperty 
subPathItems:SubPathItems  [read-only]

The sub path objects for this path item.


Implementation
    public function get subPathItems():SubPathItems
Method Detail
deselect()method
public function deselect():void

Unselects the selection, no path items are selected.

duplicate()method 
public function duplicate(name:String = null):PathItem

Duplicate this object.

Parameters

name:String (default = null) — (String) The name for the new path.

Returns
PathItem
fillPath()method 
public function fillPath(fillColor:Object = null, mode:ColorBlendMode = null, opacity:Number, preserveTransparency:Boolean, feather:Number, antiAlias:Boolean, wholePath:Boolean):void

Fills the area enclosed by the path.

Parameters

fillColor:Object (default = null) — (Object) The color of the fill for this path.
 
mode:ColorBlendMode (default = null) — (com.adobe.photoshop.ColorBlendMode) The blending mode of the fill for this path.
 
opacity:Number (default = NaN) — (Number) The opacity of the fill for this path (as a percentage). Range: 0.0 to 100.0.
 
preserveTransparency:Boolean (default = NaN) — (Boolean) If true, transparency is preserved.
 
feather:Number (default = NaN) — (Number) The feather amount in pixels. Range: 0.0 to 250.0.
 
antiAlias:Boolean (default = NaN) — (Boolean) If true, uses anti-aliasing for the selection.
 
wholePath:Boolean (default = NaN) — (Boolean) If true, uses all subpaths when doing the fill.

makeClippingPath()method 
public function makeClippingPath(flatness:Number):void

Makes this path item the clipping path for this document.

Parameters

flatness:Number (default = NaN) — (Number) Flatness in device pixels; tells the PostScript printer how to approximate curves. Range: 0.2 to 100).

makeSelection()method 
public function makeSelection(feather:Number, antiAlias:Boolean, operation:SelectionType = null):void

Makes a selection object, whose border is the path, from this path item object.

Parameters

feather:Number (default = NaN) — (Number) The feather amount in pixels. Range: 0.0 to 250.0.
 
antiAlias:Boolean (default = NaN) — (Boolean) If true, the selection uses anti-aliasing.
 
operation:SelectionType (default = null) — (com.adobe.photoshop.SelectionType) The selection behavior relative to the existing selection (when a selection already exists).

remove()method 
public function remove():void

delete the object

select()method 
public function select():void

Makes this path item the active or selected path item.

strokePath()method 
public function strokePath(tool:ToolType = null, simulatePressure:Boolean):void

Strokes the path.

Parameters

tool:ToolType (default = null) — (com.adobe.photoshop.ToolType) The tool to use when stroking the path.
 
simulatePressure:Boolean (default = NaN) — (Boolean) If true, simulates the pressure when using the tool.