com.yworks.yfiles.layout.tree

Class AspectRatioNodePlacer

java.lang.Object

com.yworks.yfiles.layout.tree.AbstractNodePlacer

com.yworks.yfiles.layout.tree.AspectRatioNodePlacer

All Implemented Interfaces:

IFromSketchNodePlacer, INodePlacer, ICloneable, Cloneable

public class AspectRatioNodePlacer
extends AbstractNodePlacer
implements IFromSketchNodePlacer

This INodePlacer places the subtrees such that the overall aspect ratio of the arranged subtree will be close to a preferred aspect ratio.

Layout Style

The aspect ratio describes the relation between width and height of the subtree. To achieve the desired aspect ratio, this INodePlacer divides the child TreeLayout.SubtreeShapes into as much rows as needed. The edges are either routed along the rows or along the columns.

Aspect ratio 1

Aspect ratio 0.5

Aspect ratio 2

Field Summary

Fields inherited from class com.yworks.yfiles.layout.tree.AbstractNodePlacer

graph

Constructor Summary

Constructors

Constructor and Description
AspectRatioNodePlacer() Creates a new instance of AspectRatioNodePlacer with default settings.

Method Summary

Modifier and Type	Method and Description
Comparator<Object>	createFromSketchComparator() Creates an edge comparator which takes the initial coordinates of the nodes into account.
protected ParentConnectorDirection	determineChildConnector(Node child) Determines a connector direction for the given child node depending on whether or not the child nodes are arranged horizontally.
double	getAspectRatio() Gets the preferred aspect ratio (width/height) for the subtrees.
FillStyle	getFillStyle() Gets how rows/columns are aligned with each other.
double	getHorizontalDistance() Gets the horizontal distance between the TreeLayout.SubtreeShapes.
double	getVerticalDistance() Gets the vertical distance between the TreeLayout.SubtreeShapes.
boolean	isHorizontal() Gets whether child nodes are distributed in horizontal rows or vertical columns.
protected TreeLayout.SubtreeShape	placeSubtree(Node localRoot, ParentConnectorDirection parentConnectorDirection) Arranges the SubtreeShapes of children of the local root node in rows or columns that fit the specified aspect ratio.
void	setAspectRatio(double value) Sets the preferred aspect ratio (width/height) for the subtrees.
void	setFillStyle(FillStyle value) Sets how rows/columns are aligned with each other.
void	setHorizontal(boolean value) Sets whether child nodes are distributed in horizontal rows or vertical columns.
void	setHorizontalDistance(double value) Sets the horizontal distance between the TreeLayout.SubtreeShapes.
void	setVerticalDistance(double value) Sets the vertical distance between the TreeLayout.SubtreeShapes.

Methods inherited from class com.yworks.yfiles.layout.tree.AbstractNodePlacer

clone, createProcessor, determineChildConnectors, getNodeShape, getSubtreeShape, placeSubtree

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.layout.tree.INodePlacer

createProcessor, determineChildConnectors, placeSubtree

Constructor Detail

AspectRatioNodePlacer

public AspectRatioNodePlacer()

Creates a new instance of AspectRatioNodePlacer with default settings.

Method Detail

createFromSketchComparator

public Comparator<Object> createFromSketchComparator()

Creates an edge comparator which takes the initial coordinates of the nodes into account.

This Comparator defines the order of the outgoing edges of a node before the actual placement of the node's subtree is calculated. It also considers whether or not the rows are placed horiontally.

Specified by:

createFromSketchComparator in interface IFromSketchNodePlacer

Returns:

the Comparator for the edges

determineChildConnector

protected ParentConnectorDirection determineChildConnector(Node child)

Determines a connector direction for the given child node depending on whether or not the child nodes are arranged horizontally.

If the child nodes are distributed horizontally, the edge should connect north, otherwise it should connect west.

Specified by:

determineChildConnector in class AbstractNodePlacer

Parameters:

child - the child node

Returns:

ParentConnectorDirection.NORTH if nodes are placed in rows, ParentConnectorDirection.WEST otherwise

getAspectRatio

public double getAspectRatio()

Gets the preferred aspect ratio (width/height) for the subtrees.

This ratio determines among how many rows/columns the nodes will be distributed.

The aspect ratio needs to be positive.

Throws:

IllegalArgumentException - if the specified aspect ratio is 0 or negative

Default Value:

The default value is 1.

Returns:

the preferred ratio between width and height

See Also:

setAspectRatio(double)

getFillStyle

public FillStyle getFillStyle()

Gets how rows/columns are aligned with each other.

Throws:

IllegalArgumentException - if an unknown fill style is specified

Default Value:

The default value is FillStyle.LEADING

Returns:

one of the predefined fill styles

See Also:

setFillStyle(FillStyle)

getHorizontalDistance

public double getHorizontalDistance()

Gets the horizontal distance between the TreeLayout.SubtreeShapes.

The nodes will be placed next to each other, keeping this distance.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 40.

Returns:

the horizontal distance between elements

See Also:

setHorizontalDistance(double)

getVerticalDistance

public double getVerticalDistance()

Gets the vertical distance between the TreeLayout.SubtreeShapes.

The nodes will be placed below each other, keeping this distance.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 40.

Returns:

the vertical distance between elements

See Also:

setVerticalDistance(double)

isHorizontal

public boolean isHorizontal()

Gets whether child nodes are distributed in horizontal rows or vertical columns.

Default Value:

The default value is false. The child nodes are placed in vertical columns.

Returns:

true for horizontal rows, false for vertical columns

See Also:

setHorizontal(boolean)

placeSubtree

protected TreeLayout.SubtreeShape placeSubtree(Node localRoot,
                                               ParentConnectorDirection parentConnectorDirection)

Arranges the SubtreeShapes of children of the local root node in rows or columns that fit the specified aspect ratio.

Specified by:

placeSubtree in class AbstractNodePlacer

Parameters:

localRoot - the local root node

parentConnectorDirection - the direction of the connector

Returns:

the TreeLayout.SubtreeShape containing the local root and all its subtrees

setAspectRatio

public void setAspectRatio(double value)

Sets the preferred aspect ratio (width/height) for the subtrees.

This ratio determines among how many rows/columns the nodes will be distributed.

The aspect ratio needs to be positive.

Throws:

IllegalArgumentException - if the specified aspect ratio is 0 or negative

Default Value:

The default value is 1.

Parameters:

value - the preferred ratio between width and height

See Also:

getAspectRatio()

setFillStyle

public void setFillStyle(FillStyle value)

Sets how rows/columns are aligned with each other.

Throws:

IllegalArgumentException - if an unknown fill style is specified

Default Value:

The default value is FillStyle.LEADING

Parameters:

value - one of the predefined fill styles

See Also:

getFillStyle()

setHorizontal

public void setHorizontal(boolean value)

Sets whether child nodes are distributed in horizontal rows or vertical columns.

Default Value:

The default value is false. The child nodes are placed in vertical columns.

Parameters:

value - true for horizontal rows, false for vertical columns

See Also:

isHorizontal()

setHorizontalDistance

public void setHorizontalDistance(double value)

Sets the horizontal distance between the TreeLayout.SubtreeShapes.

The nodes will be placed next to each other, keeping this distance.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 40.

Parameters:

value - the horizontal distance between elements

See Also:

getHorizontalDistance()

setVerticalDistance

public void setVerticalDistance(double value)

Sets the vertical distance between the TreeLayout.SubtreeShapes.

The nodes will be placed below each other, keeping this distance.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the specified distance is negative

Default Value:

The default value is 40.

Parameters:

value - the vertical distance between elements

See Also:

getVerticalDistance()