This class provides layout information about the nodes of the graph during a run of the HierarchicalLayout.
Inheritance Hierarchy
Remarks
HierarchicalLayoutNodeContext is a descriptor for each node of the graph during the hierarchical layout used internally by the algorithm implementations.
Instances of this interface can be obtained during the layout from instances of the HierarchicalLayoutContext.
HierarchicalLayoutNodeContext typically carries the type of the node and depending on the type an optional associatedEdge and associatedNode. Optionally, it may carry a geometric description of the borders of the node and descriptors for various aspects of the layout.
This class cannot be instantiated
Members
No filters for this type
Properties
Gets the associated LayoutEdge of the LayoutNode of this HierarchicalLayoutNodeContext instance (for example when the node itself is a bend or same-layer center node).
Gets the associated LayoutEdge of the LayoutNode of this HierarchicalLayoutNodeContext instance (for example when the node itself is a bend or same-layer center node).
Gets the associated LayoutNode of this HierarchicalLayoutNodeContext instance (for example, when the node itself is a back-loop proxy or side proxy).
Gets the associated LayoutNode of this HierarchicalLayoutNodeContext instance (for example, when the node itself is a back-loop proxy or side proxy).
Gets the column instance bound to the LayoutNode of this HierarchicalLayoutNodeContext instance or null if the node is not contained in a column of a LayoutGrid.
Gets the column instance bound to the LayoutNode of this HierarchicalLayoutNodeContext instance or
null if the node is not contained in a column of a LayoutGrid.The column of a node is derived from the specified LayoutGrid but does not match the original instance associated with the grid. Independent of the layout orientation, the returned column descriptor always restricts the sequencing of the nodes.
readonlyfinal
Gets the edge grouping ID of the LayoutNode of this HierarchicalLayoutNodeContext instance if the node is a bus-group node.
Gets the edge grouping ID of the LayoutNode of this HierarchicalLayoutNodeContext instance if the node is a bus-group node.
final
Property Value
an edge grouping ID or
null if this node does not belong to an edge group node constructSee Also
Gets the first same-layer edge ListCell<T> of all same-layer edges or null if there exists no same-layer edge.
Gets the first same-layer edge ListCell<T> of all same-layer edges or
null if there exists no same-layer edge.readonlyfinal
Property Value
a ListCell<T> containing the first same-layer edge or
null if no same-layer edge existsGets the group node this node belongs to.
Gets the group node this node belongs to.
readonlyfinal
Property Value
The group node to which the associated LayoutNode belongs or
null if the associated LayoutNode is a top-level node.Gets the hint of the incremental mode of the LayoutNode of this HierarchicalLayoutNodeContext instance if this node is of type REGULAR.
Gets the hint of the incremental mode of the LayoutNode of this HierarchicalLayoutNodeContext instance if this node is of type REGULAR.
The corresponding hint has been set by incrementalNodes.
readonlyfinal
Property Value
the hint of this LayoutNode or a hint instance that marks this node as non-incremental
Gets the index of the layer instance to which the LayoutNode of this HierarchicalLayoutNodeContext instance belongs.
Gets the index of the layer instance to which the LayoutNode of this HierarchicalLayoutNodeContext instance belongs.
Gets the HierarchicalLayoutNodeDescriptor instance initially bound to the LayoutNode of this HierarchicalLayoutNodeContext instance or null if no HierarchicalLayoutNodeDescriptor has been registered.
Gets the HierarchicalLayoutNodeDescriptor instance initially bound to the LayoutNode of this HierarchicalLayoutNodeContext instance or
null if no HierarchicalLayoutNodeDescriptor has been registered.readonlyfinal
Property Value
A HierarchicalLayoutNodeDescriptor instance or
null if no HierarchicalLayoutNodeDescriptor has been registered.Gets the current position of the LayoutNode of this HierarchicalLayoutNodeContext instance within its layer.
Gets the current position of the LayoutNode of this HierarchicalLayoutNodeContext instance within its layer.
This may not always be up-to-date depending on which phase the layout algorithm is currently executed.
readonlyfinal
Property Value
The zero-based position index of the LayoutNode within its current layer
Gets the number of same-layer edges associated with the LayoutNode of this HierarchicalLayoutNodeContext instance.
Gets the number of same-layer edges associated with the LayoutNode of this HierarchicalLayoutNodeContext instance.
readonlyfinal
Property Value
the number of same-layer edges associated with the node
Gets the type constant for the LayoutNode of this HierarchicalLayoutNodeContext instance.
Gets the type constant for the LayoutNode of this HierarchicalLayoutNodeContext instance.
readonlyfinal
Property Value
one of the predefined type constants