com.yworks.yfiles.layout

Class TableLayoutConfigurator

java.lang.Object

com.yworks.yfiles.layout.TableLayoutConfigurator

public class TableLayoutConfigurator
extends Object

Creates a PartitionGrid that matches a given table configuration of an IGraph and registers IMapper for that grid at the graph.

Typically, this class is used as part of the convenience class LayoutExecutor to prepare(IGraph) a partition grid before the layout is calculated and restore(IGraph) the graph afterwards.

Constructor Summary

Constructors

Constructor and Description
TableLayoutConfigurator()

Method Summary

Modifier and Type	Method and Description
void	cleanUp(IGraph graph) Destroy all information that results from a previous prepare(IGraph) and a subsequent layout.
double[]	getColumnLayout(ITable originalTable, RectD nodeLayout) Return the sizes of all leaf rows.
double	getMinimumTableDistance() Gets the minimum distance between two different table nodes.
double[]	getRowLayout(ITable originalTable, RectD nodeLayout) Return the sizes of all leaf rows.
boolean	isCompaction() Specifies whether or not to enable size compaction for table nodes.
boolean	isFromSketchEnabled() Specifies whether or not from sketch mode should be enabled.
boolean	isHorizontalLayoutEnabled() Gets whether the configurator will prepare its associated graph for a vertical (that is top-to-bottom or bottom-to-top) layout calculation or a horizontal (that is left-to-right or right-to-left) one.
void	prepare(IGraph graph) Setup partition grid information from a graph that contains table structures.
void	restore(IGraph graph) Write back all information from the partition grid.
void	setCompaction(boolean value) Specifies whether or not to enable size compaction for table nodes.
void	setFromSketchEnabled(boolean value) Specifies whether or not from sketch mode should be enabled.
void	setHorizontalLayoutEnabled(boolean value) Sets whether the configurator will prepare its associated graph for a vertical (that is top-to-bottom or bottom-to-top) layout calculation or a horizontal (that is left-to-right or right-to-left) one.
void	setMinimumTableDistance(double value) Sets the minimum distance between two different table nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableLayoutConfigurator

public TableLayoutConfigurator()

Method Detail

cleanUp

public void cleanUp(IGraph graph)

Destroy all information that results from a previous prepare(IGraph) and a subsequent layout.

getColumnLayout

public double[] getColumnLayout(ITable originalTable,
                                RectD nodeLayout)

Return the sizes of all leaf rows.

This method does not modify originalTable. You also need to call cleanUp(IGraph) explicitly if you don't need the TableLayoutConfigurator anymore.

Parameters:

originalTable - The table

nodeLayout - The final layout of the node that owns the table

Returns:

The sizes of all leaf rows in originalTable, in their natural order.

getMinimumTableDistance

public final double getMinimumTableDistance()

Gets the minimum distance between two different table nodes.

Returns:

The MinimumTableDistance.

See Also:

setMinimumTableDistance(double)

getRowLayout

public double[] getRowLayout(ITable originalTable,
                             RectD nodeLayout)

Return the sizes of all leaf rows.

This method does not modify originalTable. You also need to call cleanUp(IGraph) explicitly if you don't need the TableLayoutConfigurator anymore.

Parameters:

originalTable - The table

nodeLayout - The final layout of the node that owns the table

Returns:

The sizes of all leaf rows in originalTable, in their natural order.

isCompaction

public final boolean isCompaction()

Specifies whether or not to enable size compaction for table nodes.

If size compaction is enabled, the size of a column or row (or a table node for that matter) may be reduced due to layout calculation, but never below the column's or row's minimum size. If size compaction is disabled, columns and rows (and therefore table nodes) may only grow due to layout calculation.

The default value for this property is true.

Returns:

The Compaction.

See Also:

setCompaction(boolean)

isFromSketchEnabled

public final boolean isFromSketchEnabled()

Specifies whether or not from sketch mode should be enabled.

If enabled, the positions of the table group nodes are considered, i.e., for horizontal layout configuration these nodes are sorted according to their y-coordinate and for vertical layout configuration according to their x-coordinate.

Returns:

The FromSketchEnabled.

See Also:

setFromSketchEnabled(boolean)

isHorizontalLayoutEnabled

public final boolean isHorizontalLayoutEnabled()

Gets whether the configurator will prepare its associated graph for a vertical (that is top-to-bottom or bottom-to-top) layout calculation or a horizontal (that is left-to-right or right-to-left) one.

The default value for this property is false.

Returns:

The HorizontalLayoutEnabled.

See Also:

setHorizontalLayoutEnabled(boolean)

prepare

public void prepare(IGraph graph)

Setup partition grid information from a graph that contains table structures.

restore

public void restore(IGraph graph)

Write back all information from the partition grid.

setCompaction

public final void setCompaction(boolean value)

Specifies whether or not to enable size compaction for table nodes.

If size compaction is enabled, the size of a column or row (or a table node for that matter) may be reduced due to layout calculation, but never below the column's or row's minimum size. If size compaction is disabled, columns and rows (and therefore table nodes) may only grow due to layout calculation.

The default value for this property is true.

Parameters:

value - The Compaction to set.

See Also:

isCompaction()

setFromSketchEnabled

public final void setFromSketchEnabled(boolean value)

Specifies whether or not from sketch mode should be enabled.

If enabled, the positions of the table group nodes are considered, i.e., for horizontal layout configuration these nodes are sorted according to their y-coordinate and for vertical layout configuration according to their x-coordinate.

Parameters:

value - The FromSketchEnabled to set.

See Also:

isFromSketchEnabled()

setHorizontalLayoutEnabled

public final void setHorizontalLayoutEnabled(boolean value)

Sets whether the configurator will prepare its associated graph for a vertical (that is top-to-bottom or bottom-to-top) layout calculation or a horizontal (that is left-to-right or right-to-left) one.

The default value for this property is false.

Parameters:

value - The HorizontalLayoutEnabled to set.

See Also:

isHorizontalLayoutEnabled()

setMinimumTableDistance

public final void setMinimumTableDistance(double value)

Sets the minimum distance between two different table nodes.

Parameters:

value - The MinimumTableDistance to set.

See Also:

getMinimumTableDistance()