TreeLayoutData (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.LayoutData
- - com.yworks.yfiles.layout.tree.TreeLayoutData

public class TreeLayoutData
extends LayoutData

Specifies custom data for the TreeLayout.

Constructor Summary

Constructors
Constructor and Description

TreeLayoutData()

Constructors
Constructor and Description
`TreeLayoutData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph)` Applies this layout data to the specified `layoutGraphAdapter`.
`AbortHandler`	`getAbortHandler()` Gets the AbortHandler used during the layout.
`ItemCollection<INode>`	`getAssistantNodes()` Gets the collection of nodes the `AssistantNodePlacer` considers as assistants.
`ItemCollection<INode>`	`getDelegatingNodePlacersPrimaryNodes()` Gets the collection of nodes the `DelegatingNodePlacer` places with its `PrimaryPlacer`.
`ItemMapping<INode,Integer>`	`getGridNodePlacerRowIndices()` Gets the mapping from nodes to the index of the row the `GridNodePlacer` shall place the node in.
`ItemMapping<INode,Boolean>`	`getLeftRightPlacersLeftNodes()` Gets a mapping from nodes to a boolean value that specifies whether a node should be placed left of the bus (`true`) or right of the bus (`false`).
`ItemMapping<INode,NodeHalo>`	`getNodeHalos()` Gets the mapping from nodes to their `NodeHalo`.
`ItemMapping<INode,INodePlacer>`	`getNodePlacers()` Gets the mapping from nodes to their `INodePlacer`.
`ItemMapping<INode,Comparator<IEdge>>`	`getOutEdgeComparators()` Gets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
`ItemMapping<INode,IPortAssignment>`	`getPortAssignments()` Gets the mapping from nodes to their `IPortAssignment`.
`ItemMapping<IEdge,PortConstraint>`	`getSourcePortConstraints()` Gets a mapping from edges to their source `PortConstraint`.
`ItemMapping<IEdge,PortConstraint>`	`getTargetPortConstraints()` Gets a mapping from edges to their target `PortConstraint`.
`ItemMapping<INode,Boolean>`	`getTreeRoot()` Gets the mapping for marking the node that will be used as root node of the tree.
`void`	`setAbortHandler(AbortHandler value)` Sets the AbortHandler used during the layout.
`void`	`setAssistantNodes(ItemCollection<INode> value)` Sets the collection of nodes the `AssistantNodePlacer` considers as assistants.
`void`	`setDelegatingNodePlacersPrimaryNodes(ItemCollection<INode> value)` Sets the collection of nodes the `DelegatingNodePlacer` places with its `PrimaryPlacer`.
`void`	`setGridNodePlacerRowIndices(ItemMapping<INode,Integer> value)` Sets the mapping from nodes to the index of the row the `GridNodePlacer` shall place the node in.
`void`	`setLeftRightPlacersLeftNodes(ItemMapping<INode,Boolean> value)` Sets a mapping from nodes to a boolean value that specifies whether a node should be placed left of the bus (`true`) or right of the bus (`false`).
`void`	`setNodeHalos(ItemMapping<INode,NodeHalo> value)` Sets the mapping from nodes to their `NodeHalo`.
`void`	`setNodePlacers(ItemMapping<INode,INodePlacer> value)` Sets the mapping from nodes to their `INodePlacer`.
`void`	`setOutEdgeComparators(ItemMapping<INode,Comparator<IEdge>> value)` Sets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
`void`	`setPortAssignments(ItemMapping<INode,IPortAssignment> value)` Sets the mapping from nodes to their `IPortAssignment`.
`void`	`setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their source `PortConstraint`.
`void`	`setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their target `PortConstraint`.
`void`	`setTreeRoot(ItemMapping<INode,Boolean> value)` Sets the mapping for marking the node that will be used as root node of the tree.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TreeLayoutData
```
public TreeLayoutData()
```
- Method Detail
  - apply
```
public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)
```
    Description copied from class: LayoutData
    
    Applies this layout data to the specified layoutGraphAdapter.
    
    Specified by:
    
    apply in class LayoutData
    
    Parameters:
    
    adapter - The adapter to add the layout data to.
    
    layout - The layout that shall use this layout data.
    
    layoutGraph - The layout graph used for the layout calculation.
  - getAbortHandler
```
public final AbortHandler getAbortHandler()
```
    Gets the AbortHandler used during the layout.
    
    Returns:
    
    The AbortHandler.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)
  - getAssistantNodes
```
public final ItemCollection<INode> getAssistantNodes()
```
    Gets the collection of nodes the AssistantNodePlacer considers as assistants.
    This collection is only considered if NodePlacers returns any AssistantNodePlacer .
    
    Returns:
    
    The AssistantNodes.
    
    See Also:
    
    AssistantNodePlacer.ASSISTANT_NODE_DPKEY, setAssistantNodes(ItemCollection)
  - getDelegatingNodePlacersPrimaryNodes
```
public final ItemCollection<INode> getDelegatingNodePlacersPrimaryNodes()
```
    Gets the collection of nodes the DelegatingNodePlacer places with its PrimaryPlacer.
    This collection is only considered if NodePlacers returns any DelegatingNodePlacer .
    
    Returns:
    
    The DelegatingNodePlacersPrimaryNodes.
    
    See Also:
    
    DelegatingNodePlacer.PRIMARY_NODES_DPKEY, setDelegatingNodePlacersPrimaryNodes(ItemCollection)
  - getGridNodePlacerRowIndices
```
public final ItemMapping<INode,Integer> getGridNodePlacerRowIndices()
```
    Gets the mapping from nodes to the index of the row the GridNodePlacer shall place the node in.
    This collection is only considered if NodePlacers returns any GridNodePlacer .
    
    Returns:
    
    The GridNodePlacerRowIndices.
    
    See Also:
    
    GridNodePlacer.ROW_INDEX_DPKEY, setGridNodePlacerRowIndices(ItemMapping)
  - getLeftRightPlacersLeftNodes
```
public final ItemMapping<INode,Boolean> getLeftRightPlacersLeftNodes()
```
    Gets a mapping from nodes to a boolean value that specifies whether a node should be placed left of the bus (true) or right of the bus (false).
    This mapping is only considered if NodePlacers returns a LeftRightNodePlacer .
    
    Returns:
    
    The LeftRightPlacersLeftNodes.
    
    See Also:
    
    LeftRightNodePlacer.LEFT_RIGHT_DPKEY, setLeftRightPlacersLeftNodes(ItemMapping)
  - getNodeHalos
```
public final ItemMapping<INode,NodeHalo> getNodeHalos()
```
    Gets the mapping from nodes to their NodeHalo.
    
    Returns:
    
    The NodeHalos.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)
  - getNodePlacers
```
public final ItemMapping<INode,INodePlacer> getNodePlacers()
```
    Gets the mapping from nodes to their INodePlacer.
    
    Returns:
    
    The NodePlacers.
    
    See Also:
    
    TreeLayout.NODE_PLACER_DPKEY, setNodePlacers(ItemMapping)
  - getOutEdgeComparators
```
public final ItemMapping<INode,Comparator<IEdge>> getOutEdgeComparators()
```
    Gets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
    
    Returns:
    
    The OutEdgeComparators.
    
    See Also:
    
    TreeLayout.OUT_EDGE_COMPARATOR_DPKEY, setOutEdgeComparators(ItemMapping)
  - getPortAssignments
```
public final ItemMapping<INode,IPortAssignment> getPortAssignments()
```
    Gets the mapping from nodes to their IPortAssignment.
    
    Returns:
    
    The PortAssignments.
    
    See Also:
    
    TreeLayout.PORT_ASSIGNMENT_DPKEY, setPortAssignments(ItemMapping)
  - getSourcePortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getSourcePortConstraints()
```
    Gets a mapping from edges to their source PortConstraint.
    
    Returns:
    
    The SourcePortConstraints.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, setSourcePortConstraints(ItemMapping)
  - getTargetPortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getTargetPortConstraints()
```
    Gets a mapping from edges to their target PortConstraint.
    
    Returns:
    
    The TargetPortConstraints.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setTargetPortConstraints(ItemMapping)
  - getTreeRoot
```
public final ItemMapping<INode,Boolean> getTreeRoot()
```
    Gets the mapping for marking the node that will be used as root node of the tree.
    
    Returns:
    
    The TreeRoot.
    
    See Also:
    
    TreeLayout.SELECTED_ROOT_DPKEY, setTreeRoot(ItemMapping)
  - setAbortHandler
```
public final void setAbortHandler(AbortHandler value)
```
    Sets the AbortHandler used during the layout.
    
    Parameters:
    
    value - The AbortHandler to set.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()
  - setAssistantNodes
```
public final void setAssistantNodes(ItemCollection<INode> value)
```
    Sets the collection of nodes the AssistantNodePlacer considers as assistants.
    This collection is only considered if NodePlacers returns any AssistantNodePlacer .
    
    Parameters:
    
    value - The AssistantNodes to set.
    
    See Also:
    
    AssistantNodePlacer.ASSISTANT_NODE_DPKEY, getAssistantNodes()
  - setDelegatingNodePlacersPrimaryNodes
```
public final void setDelegatingNodePlacersPrimaryNodes(ItemCollection<INode> value)
```
    Sets the collection of nodes the DelegatingNodePlacer places with its PrimaryPlacer.
    This collection is only considered if NodePlacers returns any DelegatingNodePlacer .
    
    Parameters:
    
    value - The DelegatingNodePlacersPrimaryNodes to set.
    
    See Also:
    
    DelegatingNodePlacer.PRIMARY_NODES_DPKEY, getDelegatingNodePlacersPrimaryNodes()
  - setGridNodePlacerRowIndices
```
public final void setGridNodePlacerRowIndices(ItemMapping<INode,Integer> value)
```
    Sets the mapping from nodes to the index of the row the GridNodePlacer shall place the node in.
    This collection is only considered if NodePlacers returns any GridNodePlacer .
    
    Parameters:
    
    value - The GridNodePlacerRowIndices to set.
    
    See Also:
    
    GridNodePlacer.ROW_INDEX_DPKEY, getGridNodePlacerRowIndices()
  - setLeftRightPlacersLeftNodes
```
public final void setLeftRightPlacersLeftNodes(ItemMapping<INode,Boolean> value)
```
    Sets a mapping from nodes to a boolean value that specifies whether a node should be placed left of the bus (true) or right of the bus (false).
    This mapping is only considered if NodePlacers returns a LeftRightNodePlacer .
    
    Parameters:
    
    value - The LeftRightPlacersLeftNodes to set.
    
    See Also:
    
    LeftRightNodePlacer.LEFT_RIGHT_DPKEY, getLeftRightPlacersLeftNodes()
  - setNodeHalos
```
public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)
```
    Sets the mapping from nodes to their NodeHalo.
    
    Parameters:
    
    value - The NodeHalos to set.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, getNodeHalos()
  - setNodePlacers
```
public final void setNodePlacers(ItemMapping<INode,INodePlacer> value)
```
    Sets the mapping from nodes to their INodePlacer.
    
    Parameters:
    
    value - The NodePlacers to set.
    
    See Also:
    
    TreeLayout.NODE_PLACER_DPKEY, getNodePlacers()
  - setOutEdgeComparators
```
public final void setOutEdgeComparators(ItemMapping<INode,Comparator<IEdge>> value)
```
    Sets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
    
    Parameters:
    
    value - The OutEdgeComparators to set.
    
    See Also:
    
    TreeLayout.OUT_EDGE_COMPARATOR_DPKEY, getOutEdgeComparators()
  - setPortAssignments
```
public final void setPortAssignments(ItemMapping<INode,IPortAssignment> value)
```
    Sets the mapping from nodes to their IPortAssignment.
    
    Parameters:
    
    value - The PortAssignments to set.
    
    See Also:
    
    TreeLayout.PORT_ASSIGNMENT_DPKEY, getPortAssignments()
  - setSourcePortConstraints
```
public final void setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their source PortConstraint.
    
    Parameters:
    
    value - The SourcePortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, getSourcePortConstraints()
  - setTargetPortConstraints
```
public final void setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their target PortConstraint.
    
    Parameters:
    
    value - The TargetPortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, getTargetPortConstraints()
  - setTreeRoot
```
public final void setTreeRoot(ItemMapping<INode,Boolean> value)
```
    Sets the mapping for marking the node that will be used as root node of the tree.
    
    Parameters:
    
    value - The TreeRoot to set.
    
    See Also:
    
    TreeLayout.SELECTED_ROOT_DPKEY, getTreeRoot()

Class TreeLayoutData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeLayoutData

Method Detail

apply

getAbortHandler

getAssistantNodes

getDelegatingNodePlacersPrimaryNodes

getGridNodePlacerRowIndices

getLeftRightPlacersLeftNodes

getNodeHalos

getNodePlacers

getOutEdgeComparators

getPortAssignments

getSourcePortConstraints

getTargetPortConstraints

getTreeRoot

setAbortHandler

setAssistantNodes

setDelegatingNodePlacersPrimaryNodes

setGridNodePlacerRowIndices

setLeftRightPlacersLeftNodes

setNodeHalos

setNodePlacers

setOutEdgeComparators

setPortAssignments

setSourcePortConstraints

setTargetPortConstraints

setTreeRoot