com.yworks.yfiles.layout

Class GraphLayoutLineWrapper

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.GraphLayoutLineWrapper

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class GraphLayoutLineWrapper
extends AbstractLayoutStage

GraphLayoutLineWrapper can line-wrap or column-wrap a graph layout.

This ILayoutStage supports both wrapping a layout at a given width (height) and wrapping a layout automatically at some width (height) such that the resulting overall aspect ratio is close to a desired target ratio.

The GraphLayoutLineWrapper can be used on an existing graph layout or on the result of the core layout algorithm.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Cuts the layout resulting from the core layout algorithm at a specified width/height and shifts the remaining graph into the next row/column until the layout has the desired width/height.
double	getEdgeSpacing() Gets the space that should be kept between edges.
double	getFixedWidth() Gets the desired width of the lines.
double	getSpacing() Gets the space between adjacent lines of the wrapped graph layout.
double	getTargetRatio() Gets the desired target aspect ratio for the layout.
boolean	isColumnModeEnabled() Gets whether this ILayoutStage wraps lines/rows or columns.
boolean	isFixedWidthLineBreaksEnabled() Gets whether the algorithm should use the fixed width or target aspect ratio to determine line breaks.
boolean	isMirrored() Gets whether or not every other line is mirrored.
void	setColumnModeEnabled(boolean value) Sets whether this ILayoutStage wraps lines/rows or columns.
void	setEdgeSpacing(double value) Sets the space that should be kept between edges.
void	setFixedWidth(double value) Sets the desired width of the lines.
void	setFixedWidthLineBreaksEnabled(boolean value) Sets whether the algorithm should use the fixed width or target aspect ratio to determine line breaks.
void	setMirrored(boolean value) Sets whether or not every other line is mirrored.
void	setSpacing(double value) Sets the space between adjacent lines of the wrapped graph layout.
void	setTargetRatio(double value) Sets the desired target aspect ratio for the layout.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphLayoutLineWrapper

public GraphLayoutLineWrapper()

Creates a new GraphLayoutLineWrapper instance with default settings.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Cuts the layout resulting from the core layout algorithm at a specified width/height and shifts the remaining graph into the next row/column until the layout has the desired width/height.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Parameters:

graph - the input graph

getEdgeSpacing

public double getEdgeSpacing()

Gets the space that should be kept between edges.

The spacing must be non-negative.

Throws:

IllegalArgumentException - if the given spacing is a negative value

Default Value:

The default value is 5.

Returns:

the space between edges

See Also:

setEdgeSpacing(double)

getFixedWidth

public double getFixedWidth()

Gets the desired width of the lines.

The GraphLayoutLineWrapper breaks the lines at the specified width.

In column mode, the fixed width is interpreted as fixed height for a column.

The algorithm will not necessarily be able to satisfy very small values, since the nodes need to fit completely into a line.

The specified width is only considered if FixedWidthLineBreaksEnabled returns true.

Default Value:

The default value is 500.

Returns:

the width of the lines

See Also:

setFixedWidthLineBreaksEnabled(boolean), setColumnModeEnabled(boolean), setFixedWidth(double)

getSpacing

public double getSpacing()

Gets the space between adjacent lines of the wrapped graph layout.

If the column mode is enabled, this spacing defines the distance between adjacent columns.

The spacing should be non-negative.

Throws:

IllegalArgumentException - if the spacing is negative

Default Value:

The default value is 10.

Returns:

the space between the lines

See Also:

setSpacing(double)

getTargetRatio

public double getTargetRatio()

Gets the desired target aspect ratio for the layout.

The aspect ratio needs to be greater than 0.

Throws:

IllegalArgumentException - if the target ratio is 0 or less

The specified width is only considered if FixedWidthLineBreaksEnabled returns false.

Default Value:

The default value is 1.

Returns:

the desired target aspect ratio in terms of width/height

See Also:

setFixedWidthLineBreaksEnabled(boolean), setTargetRatio(double)

isColumnModeEnabled

public boolean isColumnModeEnabled()

Gets whether this ILayoutStage wraps lines/rows or columns.

If this mode is enabled, the layout is wrapped vertically and new columns are appended to the right of the first column. Otherwise, the layout is wrapped horizontally and new rows are appended below the first row.

Also, the FixedWidth property will be interpreted as a fixed height if this mode is enabled.

Default Value:

The default value is false. The layout is wrapped horizontally, producing rows.

Returns:

true for column wrapping mode, false for row wrapping

See Also:

setFixedWidth(double), setColumnModeEnabled(boolean)

isFixedWidthLineBreaksEnabled

public boolean isFixedWidthLineBreaksEnabled()

Gets whether the algorithm should use the fixed width or target aspect ratio to determine line breaks.

Default Value:

The default value is false. The target aspect ratio defines how the line width is chosen.

Returns:

true if a fixed line width is used, false otherwise

See Also:

setFixedWidth(double), setTargetRatio(double), setFixedWidthLineBreaksEnabled(boolean)

isMirrored

public boolean isMirrored()

Gets whether or not every other line is mirrored.

When breaking a line and placing the remaining line below, this remainder can be rotated by 180 degrees. Then, the edges connecting both lines stay short. In case the remainder is not rotated, the edges are routed between the two lines to connect to the front of the non-mirrored line.

Default Value:

The default value is true. Every other line is mirrored.

Returns:

true if every second line is rotated by 180 degrees, false otherwise

See Also:

setMirrored(boolean)

setColumnModeEnabled

public void setColumnModeEnabled(boolean value)

Sets whether this ILayoutStage wraps lines/rows or columns.

If this mode is enabled, the layout is wrapped vertically and new columns are appended to the right of the first column. Otherwise, the layout is wrapped horizontally and new rows are appended below the first row.

Also, the FixedWidth property will be interpreted as a fixed height if this mode is enabled.

Default Value:

The default value is false. The layout is wrapped horizontally, producing rows.

Parameters:

value - true for column wrapping mode, false for row wrapping

See Also:

setFixedWidth(double), isColumnModeEnabled()

setEdgeSpacing

public void setEdgeSpacing(double value)

Sets the space that should be kept between edges.

The spacing must be non-negative.

Throws:

IllegalArgumentException - if the given spacing is a negative value

Default Value:

The default value is 5.

Parameters:

value - the space between edges

See Also:

getEdgeSpacing()

setFixedWidth

public void setFixedWidth(double value)

Sets the desired width of the lines.

The GraphLayoutLineWrapper breaks the lines at the specified width.

In column mode, the fixed width is interpreted as fixed height for a column.

The algorithm will not necessarily be able to satisfy very small values, since the nodes need to fit completely into a line.

The specified width is only considered if FixedWidthLineBreaksEnabled returns true.

Default Value:

The default value is 500.

Parameters:

value - the width of the lines

See Also:

setFixedWidthLineBreaksEnabled(boolean), setColumnModeEnabled(boolean), getFixedWidth()

setFixedWidthLineBreaksEnabled

public void setFixedWidthLineBreaksEnabled(boolean value)

Sets whether the algorithm should use the fixed width or target aspect ratio to determine line breaks.

Default Value:

The default value is false. The target aspect ratio defines how the line width is chosen.

Parameters:

value - true if a fixed line width is used, false otherwise

See Also:

setFixedWidth(double), setTargetRatio(double), isFixedWidthLineBreaksEnabled()

setMirrored

public void setMirrored(boolean value)

Sets whether or not every other line is mirrored.

When breaking a line and placing the remaining line below, this remainder can be rotated by 180 degrees. Then, the edges connecting both lines stay short. In case the remainder is not rotated, the edges are routed between the two lines to connect to the front of the non-mirrored line.

Default Value:

The default value is true. Every other line is mirrored.

Parameters:

value - true if every second line is rotated by 180 degrees, false otherwise

See Also:

isMirrored()

setSpacing

public void setSpacing(double value)

Sets the space between adjacent lines of the wrapped graph layout.

If the column mode is enabled, this spacing defines the distance between adjacent columns.

The spacing should be non-negative.

Throws:

IllegalArgumentException - if the spacing is negative

Default Value:

The default value is 10.

Parameters:

value - the space between the lines

See Also:

getSpacing()

setTargetRatio

public void setTargetRatio(double value)

Sets the desired target aspect ratio for the layout.

The aspect ratio needs to be greater than 0.

Throws:

IllegalArgumentException - if the target ratio is 0 or less

The specified width is only considered if FixedWidthLineBreaksEnabled returns false.

Default Value:

The default value is 1.

Parameters:

value - the desired target aspect ratio in terms of width/height

See Also:

setFixedWidthLineBreaksEnabled(boolean), getTargetRatio()