Package | com.adobe.indesign |
Class | public class PathPoint |
Inheritance | PathPoint ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PathPoint | ||
![]() | 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 | |
![]() | 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 | ||
![]() | 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 | |
![]() | 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 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | PathPoint | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
anchor | property |
anchor:Object
Since : | CS5 |
The location of the path point on the page, in the format [x, y].
public function get anchor():Object
public function set anchor(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the PathPoint within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
leftDirection | property |
leftDirection:Object
Since : | CS5 |
The left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y].
public function get leftDirection():Object
public function set leftDirection(value:Object):void
parent | property |
parent:Path
[read-only] Since : | CS5 |
The parent of the PathPoint (a Path).
public function get parent():Path
pointType | property |
pointType:PointType
Since : | CS5 |
The path point type.
public function get pointType():PointType
public function set pointType(value:PointType):void
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rightDirection | property |
rightDirection:Object
Since : | CS5 |
The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y].
public function get rightDirection():Object
public function set rightDirection(value:Object):void
addEventListenerPathPoint | () | method |
public function addEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
join | () | method |
public function join(referenceParam:PathPoint = null, givenParam:JoinOptions = null):void
Since : | CS5 |
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
Since : | CS5 |
Deletes the PathPoint.
removeEventListenerPathPoint | () | method |
public function removeEventListenerPathPoint(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |