Packagecom.yworks.yfiles.layout.planar
Interfacepublic interface EdgePairCursor extends YCursor

Defines a cursor which returns pairs of edges.



Public Methods
 MethodDefined By
 Inherited
current():Object
Returns the object currently pointed on.
YCursor
 Inherited
next():void
Moves this cursor one position forward.
YCursor
 Inherited
ok():Boolean
Returns true if the current cursor position is valid.
YCursor
  
pair(result:Vector.<Object>):void
Returns the pair of edges, the cursor is pointing on.
EdgePairCursor
 Inherited
prev():void
Moves this cursor one position backward (optional).
YCursor
 Inherited
size():int
Returns the number of elements that can be accessed with this cursor.
YCursor
 Inherited
toFirst():void
Moves this cursor to the first valid cursor position (optional).
YCursor
 Inherited
toLast():void
Moves this cursor to the last valid cursor position (optional).
YCursor
Method Detail
pair()method
public function pair(result:Vector.<Object>):void

Returns the pair of edges, the cursor is pointing on.

Parameters

result:Vector.<Object> — an array of Edge of length two. The pair will be stored int this array.