Packagecom.yworks.yfiles.layout.tree
Classpublic class MultiParentDescriptor
InheritanceMultiParentDescriptor Inheritance YObject Inheritance Object

This class is used by com.yworks.yfiles.layout.tree.GenericTreeLayouter to determine the desired layout of nodes that constitute a multi-parent structure. All nodes of such a structure are placed side by side and the incident edges are routed over common points for incoming edges and for outgoing edges.

See also

com.yworks.yfiles.layout.tree.GenericTreeLayouter.MULTI_PARENT_DESCRIPTOR_DPKEY
com.yworks.yfiles.layout.tree.GenericTreeLayouter


Public Properties
 PropertyDefined By
  edgeStyle : int
Specifies the routing style for edges that connect to nodes that constitute a multi-parent structure.
MultiParentDescriptor
  minimumBusDistance : Number
Specifies the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.
MultiParentDescriptor
  minimumNodeDistance : Number
Specifies the minimum distance between two nodes belonging to the same multi-parent structure.
MultiParentDescriptor
  verticalAlignment : Number
Specifies the relative vertical alignment of nodes belonging to the same multi-parent structure.
MultiParentDescriptor
Public Methods
 MethodDefined By
  
MultiParentDescriptor(init:Boolean = true)
MultiParentDescriptor
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
MultiParentDescriptor
 Inherited
hashCode():int
YObject
  
[static]
MultiParentDescriptor
Protected Methods
 MethodDefined By
  
MultiParentDescriptor
Public Constants
 ConstantDefined By
  EDGE_STYLE_ORTHOGONAL : int = 1
[static] Routing style for edges that are connected to nodes that constitute a multi-parent structure.
MultiParentDescriptor
  EDGE_STYLE_POLYLINE : int = 0
[static] Routing style for edges that are connected to nodes that constitute a multi-parent structure.
MultiParentDescriptor
  EDGE_STYLE_STRAIGHT : int = 2
[static] Routing style for edges that are connected to nodes that constitute a multi-parent structure.
MultiParentDescriptor
Property Detail
edgeStyleproperty
edgeStyle:int

Specifies the routing style for edges that connect to nodes that constitute a multi-parent structure. The routing style is applied only to the part of the edge route that is not shared.


Implementation
    public function get edgeStyle():int
    public function set edgeStyle(value:int):void

See also

minimumBusDistanceproperty 
minimumBusDistance:Number

Specifies the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes. In case the edges style is not orthogonal the bus only consists of a common point.


Implementation
    public function get minimumBusDistance():Number
    public function set minimumBusDistance(value:Number):void
minimumNodeDistanceproperty 
minimumNodeDistance:Number

Specifies the minimum distance between two nodes belonging to the same multi-parent structure.


Implementation
    public function get minimumNodeDistance():Number
    public function set minimumNodeDistance(value:Number):void
verticalAlignmentproperty 
verticalAlignment:Number

Specifies the relative vertical alignment of nodes belonging to the same multi-parent structure. A value of 0 means nodes are top aligned; a value of 1 means nodes are bottom aligned; a value of 0.5 means nodes are center aligned. Values outside the interval [0,1] will result in a compact node placement with unaligned nodes.

By default the compact placement with unaligned nodes is used.


Implementation
    public function get verticalAlignment():Number
    public function set verticalAlignment(value:Number):void
Constructor Detail
MultiParentDescriptor()Constructor
public function MultiParentDescriptor(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initMultiParentDescriptor()method 
protected final function initMultiParentDescriptor():void

newMultiParentDescriptor()method 
public static function newMultiParentDescriptor():MultiParentDescriptor

Returns
MultiParentDescriptor
Constant Detail
EDGE_STYLE_ORTHOGONALConstant
public static const EDGE_STYLE_ORTHOGONAL:int = 1

Routing style for edges that are connected to nodes that constitute a multi-parent structure. Using this style will route the part of the edges that doesn't share the same path orthogonally.

See also

EDGE_STYLE_POLYLINEConstant 
public static const EDGE_STYLE_POLYLINE:int = 0

Routing style for edges that are connected to nodes that constitute a multi-parent structure. Using this style will route the part of the edges that doesn't share the same path in a polyline fashion.

See also

EDGE_STYLE_STRAIGHTConstant 
public static const EDGE_STYLE_STRAIGHT:int = 2

Routing style for edges that are connected to nodes that constitute a multi-parent structure. Using this style will route the part of the edges that doesn't share the same path directly from the center of the multi-parent to the common point of the edges in the multi-parent structure.

See also