Packagecom.adobe.indesign
Classpublic class PathPoint
InheritancePathPoint Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  anchor : Object
The location of the path point on the page, in the format [x, y].
PathPoint
  eventListeners : EventListeners
[read-only] A collection of event listeners.
PathPoint
  events : Events
[read-only] A collection of events.
PathPoint
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the PathPoint within its containing object.
PathPoint
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
PathPoint
  leftDirection : Object
The left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y].
PathPoint
  parent : Path
[read-only] The parent of the PathPoint (a Path).
PathPoint
  pointType : PointType
The path point type.
PathPoint
  properties : Object
A property that allows setting of several properties at the same time.
PathPoint
  rightDirection : Object
The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y].
PathPoint
Public Methods
 MethodDefined By
  
addEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PathPoint
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
PathPoint
 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
  
join(referenceParam:PathPoint = null, givenParam:JoinOptions = null):void
Join this path point to another path point.
PathPoint
  
remove():void
Deletes the PathPoint.
PathPoint
  
removeEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PathPoint
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
PathPoint
 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
anchorproperty
anchor:Object

The location of the path point on the page, in the format [x, y].


Implementation
    public function get anchor():Object
    public function set anchor(value:Object):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the PathPoint within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leftDirectionproperty 
leftDirection:Object

The left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y].


Implementation
    public function get leftDirection():Object
    public function set leftDirection(value:Object):void
parentproperty 
parent:Path  [read-only]

The parent of the PathPoint (a Path).


Implementation
    public function get parent():Path
pointTypeproperty 
pointType:PointType

The path point type.


Implementation
    public function get pointType():PointType
    public function set pointType(value:PointType):void
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rightDirectionproperty 
rightDirection:Object

The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y].


Implementation
    public function get rightDirection():Object
    public function set rightDirection(value:Object):void
Method Detail
addEventListenerPathPoint()method
public function addEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
join()method 
public function join(referenceParam:PathPoint = null, givenParam:JoinOptions = null):void

Join this path point to another path point. The two points must be end points and their paths combined into a single path on a single page item.

Parameters

referenceParam:PathPoint (default = null) — (PathPoint) The reference object. The path point to join to
 
givenParam:JoinOptions (default = null) — (JoinOptions) The join option to use. (Optional)

remove()method 
public function remove():void

Deletes the PathPoint.

removeEventListenerPathPoint()method 
public function removeEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String