Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class EdgeCellInfo
InheritanceEdgeCellInfo Inheritance YObject Inheritance Object

Encapsulates the information that determines the route of a specific edge within a specific partition cell.



Public Properties
 PropertyDefined By
  bendCount : int
[read-only] Returns the number of bends the edge has inside this cell.
EdgeCellInfo
  cell : PartitionCell
[read-only] Returns the cell the edge is routed in.
EdgeCellInfo
  cellSegmentInfos : YList
[read-only] Gets the com.yworks.yfiles.layout.router.polyline.CellSegmentInfo s for the the segment parts of this edge that run inside this cell.
EdgeCellInfo
  edge : Edge
[read-only] Returns the edge whose routing in the cell is described.
EdgeCellInfo
  enterDirection : Direction
[read-only] Returns the direction, this edge uses to enter this cell.
EdgeCellInfo
  enterInterval : OrthogonalInterval
[read-only] Returns the interval, the edge uses to enter this cell.
EdgeCellInfo
  enterSegmentGroup : SegmentGroup
Getter: Returns the segment group containing the entering segment.
EdgeCellInfo
  enterSegmentNo : int
Specifies the index of the edge segment that enters this cell.
EdgeCellInfo
  exitDirection : Direction
[read-only] Returns the direction, this edge uses to exit this cell.
EdgeCellInfo
  exitInterval : OrthogonalInterval
[read-only] Returns the interval, the edge uses to exit this cell.
EdgeCellInfo
  exitSegmentGroup : SegmentGroup
Getter: Returns the segment group containing the exiting segment.
EdgeCellInfo
  exitSegmentNo : int
Specifies the index of the edge segment that exits this cell.
EdgeCellInfo
  type : int
[read-only] Returns the routing type the edge uses in this cell.
EdgeCellInfo
Public Methods
 MethodDefined By
  
EdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int, init:Boolean = true)
Creates a new instance.
EdgeCellInfo
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
EdgeCellInfo
 Inherited
hashCode():int
YObject
  
newEdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int):EdgeCellInfo
[static] Creates a new instance.
EdgeCellInfo
  
toString():String
Returns a String representation of the shape in which the edge crosses the com.yworks.yfiles.layout.router.polyline.PartitionCell.
EdgeCellInfo
Protected Methods
 MethodDefined By
  
initEdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int):void
Initializes this object.
EdgeCellInfo
Public Constants
 ConstantDefined By
  TYPE_BENDING : int = 2
[static] Routing type information representing a crossing of the cell with a single bend, i.e.
EdgeCellInfo
  TYPE_END : int = 4
[static] Routing type information representing the source or target end of an edge being in the cell, i.e.
EdgeCellInfo
  TYPE_STRAIGHT : int = 0
[static] Routing type information representing a straight crossing of the cell, i.e.
EdgeCellInfo
  TYPE_STRAIGHT_BENDING : int = 1
[static] Routing type information representing a crossing of the cell with three segments, i.e.
EdgeCellInfo
  TYPE_U_TURN : int = 3
[static] Routing type information representing a crossing of the cell by making a u-turn, i.e.
EdgeCellInfo
Property Detail
bendCountproperty
bendCount:int  [read-only]

Returns the number of bends the edge has inside this cell.


Implementation
    public function get bendCount():int
cellproperty 
cell:PartitionCell  [read-only]

Returns the cell the edge is routed in.


Implementation
    public function get cell():PartitionCell
cellSegmentInfosproperty 
cellSegmentInfos:YList  [read-only]

Gets the com.yworks.yfiles.layout.router.polyline.CellSegmentInfo s for the the segment parts of this edge that run inside this cell.


Implementation
    public function get cellSegmentInfos():YList

See also

edgeproperty 
edge:Edge  [read-only]

Returns the edge whose routing in the cell is described.


Implementation
    public function get edge():Edge
enterDirectionproperty 
enterDirection:Direction  [read-only]

Returns the direction, this edge uses to enter this cell.


Implementation
    public function get enterDirection():Direction
enterIntervalproperty 
enterInterval:OrthogonalInterval  [read-only]

Returns the interval, the edge uses to enter this cell.


Implementation
    public function get enterInterval():OrthogonalInterval
enterSegmentGroupproperty 
enterSegmentGroup:SegmentGroup

Getter: Returns the segment group containing the entering segment.

Setter: Sets the segment group containing the entering segment and updates the enter interval to use the segment groups common enter interval.


Implementation
    public function get enterSegmentGroup():SegmentGroup
    public function set enterSegmentGroup(value:SegmentGroup):void

See also

enterSegmentNoproperty 
enterSegmentNo:int

Specifies the index of the edge segment that enters this cell.


Implementation
    public function get enterSegmentNo():int
    public function set enterSegmentNo(value:int):void
exitDirectionproperty 
exitDirection:Direction  [read-only]

Returns the direction, this edge uses to exit this cell.


Implementation
    public function get exitDirection():Direction
exitIntervalproperty 
exitInterval:OrthogonalInterval  [read-only]

Returns the interval, the edge uses to exit this cell.


Implementation
    public function get exitInterval():OrthogonalInterval
exitSegmentGroupproperty 
exitSegmentGroup:SegmentGroup

Getter: Returns the segment group containing the exiting segment.

Setter: Sets the segment group containing the exiting segment and updates the exit interval to use the segment groups common enter interval.


Implementation
    public function get exitSegmentGroup():SegmentGroup
    public function set exitSegmentGroup(value:SegmentGroup):void

See also

exitSegmentNoproperty 
exitSegmentNo:int

Specifies the index of the edge segment that exits this cell.


Implementation
    public function get exitSegmentNo():int
    public function set exitSegmentNo(value:int):void
typeproperty 
type:int  [read-only]

Returns the routing type the edge uses in this cell. This is one of:


Implementation
    public function get type():int

See also

Constructor Detail
EdgeCellInfo()Constructor
public function EdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int, init:Boolean = true)

Creates a new instance.

Parameters
edge:Edge — The edge whose routing in the cell is described.
 
cell:PartitionCell — The cell the edge is routed in.
 
enterInterval:OrthogonalInterval — The interval, the edge uses to enter the cell.
 
exitInterval:OrthogonalInterval — The interval, the edge uses to exit the cell.
 
enterDirection:Direction — The direction, the edge enters the cell.
 
exitDirection:Direction — The direction, the edge exits the cell.
 
enterSegmentNo:int — The index of the edge segment that enters the cell.
 
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initEdgeCellInfo()method 
protected final function initEdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int):void

Initializes this object. See the documentation of the corresponding factory method newEdgeCellInfo() for details.

Parameters

edge:Edge
 
cell:PartitionCell
 
enterInterval:OrthogonalInterval
 
exitInterval:OrthogonalInterval
 
enterDirection:Direction
 
exitDirection:Direction
 
enterSegmentNo:int

See also

newEdgeCellInfo()method 
public static function newEdgeCellInfo(edge:Edge, cell:PartitionCell, enterInterval:OrthogonalInterval, exitInterval:OrthogonalInterval, enterDirection:Direction, exitDirection:Direction, enterSegmentNo:int):EdgeCellInfo

Creates a new instance.

Parameters

edge:Edge — The edge whose routing in the cell is described.
 
cell:PartitionCell — The cell the edge is routed in.
 
enterInterval:OrthogonalInterval — The interval, the edge uses to enter the cell.
 
exitInterval:OrthogonalInterval — The interval, the edge uses to exit the cell.
 
enterDirection:Direction — The direction, the edge enters the cell.
 
exitDirection:Direction — The direction, the edge exits the cell.
 
enterSegmentNo:int — The index of the edge segment that enters the cell.

Returns
EdgeCellInfo
toString()method 
public function toString():String

Returns a String representation of the shape in which the edge crosses the com.yworks.yfiles.layout.router.polyline.PartitionCell.

Returns
String — A String representation of the shape in which the edge crosses the com.yworks.yfiles.layout.router.polyline.PartitionCell.

See also

Constant Detail
TYPE_BENDINGConstant
public static const TYPE_BENDING:int = 2

Routing type information representing a crossing of the cell with a single bend, i.e. the edge enters the cell in one direction, makes a bend and exits the cell in an orthogonal direction.

See also

TYPE_ENDConstant 
public static const TYPE_END:int = 4

Routing type information representing the source or target end of an edge being in the cell, i.e. the enter and/or exit interval is null.

See also

TYPE_STRAIGHTConstant 
public static const TYPE_STRAIGHT:int = 0

Routing type information representing a straight crossing of the cell, i.e. a single orthogonal segment of edge enters and exits the cell.

See also

TYPE_STRAIGHT_BENDINGConstant 
public static const TYPE_STRAIGHT_BENDING:int = 1

Routing type information representing a crossing of the cell with three segments, i.e. the edge enters and exits the cell using the same direction but has an orthogonal middle segment between the entering and exiting segment.

See also

TYPE_U_TURNConstant 
public static const TYPE_U_TURN:int = 3

Routing type information representing a crossing of the cell by making a u-turn, i.e. the edge enters and exits the cell on the same side using two turns and an orthogonal middle segment.

See also