com.yworks.yfiles.layout.tree

Class AspectRatioTreeLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.tree.AspectRatioTreeLayoutData

public class AspectRatioTreeLayoutData
extends LayoutData

Specifies custom data for the AspectRatioTreeLayout.

Constructor Summary

Constructors

Constructor and Description
AspectRatioTreeLayoutData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
ItemMapping<INode,RootPlacement>	getRootPlacements() Gets the mapping from nodes with sub trees to their placements.
ItemMapping<INode,Double>	getSubtreeAspectRatios() Gets the mapping from nodes to the aspect ratio of their sub tree.
ItemMapping<INode,SubtreeArrangement>	getSubtreeRoutingPolicies() Gets the mapping from nodes to the routing policies of their sub trees.
void	setRootPlacements(ItemMapping<INode,RootPlacement> value) Sets the mapping from nodes with sub trees to their placements.
void	setSubtreeAspectRatios(ItemMapping<INode,Double> value) Sets the mapping from nodes to the aspect ratio of their sub tree.
void	setSubtreeRoutingPolicies(ItemMapping<INode,SubtreeArrangement> value) Sets the mapping from nodes to the routing policies of their sub trees.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AspectRatioTreeLayoutData

public AspectRatioTreeLayoutData()

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.

getRootPlacements

public final ItemMapping<INode,RootPlacement> getRootPlacements()

Gets the mapping from nodes with sub trees to their placements.

Returns:

The RootPlacements.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY, AspectRatioTreeLayout.getRootPlacement(java.lang.Object), setRootPlacements(ItemMapping)

getSubtreeAspectRatios

public final ItemMapping<INode,Double> getSubtreeAspectRatios()

Gets the mapping from nodes to the aspect ratio of their sub tree.

Returns:

The SubtreeAspectRatios.

See Also:

AspectRatioTreeLayout.SUBTREE_ASPECT_RATIO_DPKEY, setSubtreeAspectRatios(ItemMapping)

getSubtreeRoutingPolicies

public final ItemMapping<INode,SubtreeArrangement> getSubtreeRoutingPolicies()

Gets the mapping from nodes to the routing policies of their sub trees.

Returns:

The SubtreeRoutingPolicies.

See Also:

AspectRatioTreeLayout.SUBTREE_ROUTING_POLICY_DPKEY, AspectRatioTreeLayout.getSubtreeArrangement(java.lang.Object), setSubtreeRoutingPolicies(ItemMapping)

setRootPlacements

public final void setRootPlacements(ItemMapping<INode,RootPlacement> value)

Sets the mapping from nodes with sub trees to their placements.

Parameters:

value - The RootPlacements to set.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY, AspectRatioTreeLayout.getRootPlacement(java.lang.Object), getRootPlacements()

setSubtreeAspectRatios

public final void setSubtreeAspectRatios(ItemMapping<INode,Double> value)

Sets the mapping from nodes to the aspect ratio of their sub tree.

Parameters:

value - The SubtreeAspectRatios to set.

See Also:

AspectRatioTreeLayout.SUBTREE_ASPECT_RATIO_DPKEY, getSubtreeAspectRatios()

setSubtreeRoutingPolicies

public final void setSubtreeRoutingPolicies(ItemMapping<INode,SubtreeArrangement> value)

Sets the mapping from nodes to the routing policies of their sub trees.

Parameters:

value - The SubtreeRoutingPolicies to set.

See Also:

AspectRatioTreeLayout.SUBTREE_ROUTING_POLICY_DPKEY, AspectRatioTreeLayout.getSubtreeArrangement(java.lang.Object), getSubtreeRoutingPolicies()