Packagecom.yworks.yfiles.layout.router.polyline
Classpublic class CellSegmentInfo
InheritanceCellSegmentInfo Inheritance AbstractSegmentInfo Inheritance YObject Inheritance Object

Stores information about the part of an edge segment that lies inside a specified com.yworks.yfiles.layout.router.polyline.PartitionCell.

See also

com.yworks.yfiles.layout.router.polyline.PartitionCell


Public Properties
 PropertyDefined By
  cell : PartitionCell
[read-only] Returns the partition cell this part of the edge segment lies in.
CellSegmentInfo
  direction : Direction
[override] [read-only] Returns the direction this segment part points to.
CellSegmentInfo
 Inheritededge : Edge
[read-only] Returns the edge this segment info belongs to.
AbstractSegmentInfo
 Inheritedfixed : Boolean
[read-only] Determines whether or not this segment info is fixed, that means a fixed location has been determined inside its location range (locationRange).
AbstractSegmentInfo
 Inheritedlocation : Number
Getter: Returns the fixed location inside the location range (locationRange) that has been set before.
AbstractSegmentInfo
 InheritedlocationRange : Interval
[read-only] Returns the range, the location of the segment shall be placed in.
AbstractSegmentInfo
 InheritedmaxExtension : Interval
[read-only] Returns the maximum extension this segment will stretch.
AbstractSegmentInfo
 InheritedminExtension : Interval
[read-only] The minimal known extension of the segment, that is the minimal interval this segment will cover in any case.
AbstractSegmentInfo
 InheritedpreferredAlignment : int
Specifies whether this segment prefers to be placed close to the lower bound (ALIGNMENT_MIN), upper bound (ALIGNMENT_MAX) or somewhere (ALIGNMENT_ANY) of its location range.
AbstractSegmentInfo
 InheritedsegmentGroup : SegmentGroup
Getter: Returns the segment group this segment info belongs to or null if this segment info doesn't belong to any group.
AbstractSegmentInfo
 InheritedsegmentIndex : int
[read-only] Returns the index of this info's segment.
AbstractSegmentInfo
 Inheritedvertical : Boolean
[read-only] Determines whether or not the associated segment is vertical.
AbstractSegmentInfo
Public Methods
 MethodDefined By
  
CellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell, init:Boolean = true)
Creates a new instance.
CellSegmentInfo
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
CellSegmentInfo
 Inherited
hashCode():int
YObject
  
newCellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell):CellSegmentInfo
[static] Creates a new instance.
CellSegmentInfo
 Inherited
toString():String
AbstractSegmentInfo
Protected Methods
 MethodDefined By
 Inherited
initAbstractSegmentInfo1(edge:Edge, segmentNo:int, segment:LineSegment):void
AbstractSegmentInfo
 Inherited
initAbstractSegmentInfo2(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval):void
AbstractSegmentInfo
  
initCellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell):void
Initializes this object.
CellSegmentInfo
Public Constants
 ConstantDefined By
 InheritedALIGNMENT_ANY : int = 0
[static] Specifies that the segment can be placed somewhere in its location range.
AbstractSegmentInfo
 InheritedALIGNMENT_MAX : int = 1
[static] Specifies that the segment prefers to be placed close to the upper bound of its location range.
AbstractSegmentInfo
 InheritedALIGNMENT_MIN : int = -1
[static] Specifies that the segment prefers to be placed close to the lower bound of its location range.
AbstractSegmentInfo
Property Detail
cellproperty
cell:PartitionCell  [read-only]

Returns the partition cell this part of the edge segment lies in.


Implementation
    public function get cell():PartitionCell
directionproperty 
direction:Direction  [read-only] [override]

Returns the direction this segment part points to.


Implementation
    public function get direction():Direction
Constructor Detail
CellSegmentInfo()Constructor
public function CellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell, init:Boolean = true)

Creates a new instance.

Parameters
edge:Edge — The edge the segment of this info belongs to.
 
segmentIndex:int — The index of the segment this info belongs to.
 
direction:Direction — The direction the segment points to.
 
locationRange:Interval — The range the common location of this segment has to be inside.
 
minExtension:Interval — The minimal interval in extension direction this segment part is known to intersect.
 
maxExtension:Interval — The maximum interval in extension direction this segment part will span.
 
cell:PartitionCell — The partition cell this part of the edge segment lies inside.
 
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
initCellSegmentInfo()method 
protected final function initCellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell):void

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

Parameters

edge:Edge
 
segmentIndex:int
 
direction:Direction
 
locationRange:Interval
 
minExtension:Interval
 
maxExtension:Interval
 
cell:PartitionCell

See also

newCellSegmentInfo()method 
public static function newCellSegmentInfo(edge:Edge, segmentIndex:int, direction:Direction, locationRange:Interval, minExtension:Interval, maxExtension:Interval, cell:PartitionCell):CellSegmentInfo

Creates a new instance.

Parameters

edge:Edge — The edge the segment of this info belongs to.
 
segmentIndex:int — The index of the segment this info belongs to.
 
direction:Direction — The direction the segment points to.
 
locationRange:Interval — The range the common location of this segment has to be inside.
 
minExtension:Interval — The minimal interval in extension direction this segment part is known to intersect.
 
maxExtension:Interval — The maximum interval in extension direction this segment part will span.
 
cell:PartitionCell — The partition cell this part of the edge segment lies inside.

Returns
CellSegmentInfo