com.yworks.yfiles.layout

Class PartitionGridData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.PartitionGridData

public class PartitionGridData
extends LayoutData

Specifies a PartitionGrid for a layout.

The PartitionCellId mapping has to be specified by either setting the CellIds property, or both the RowIndices and ColumnIndices properties. When CellIds is set, the Grid property is expected to be set as well. Otherwise the size of the grid may be induced by the maximum row and column indices returned by RowIndices and ColumnIndices.

Note that cell spanning is only supported using the CellIds.

Constructor Summary

Constructors

Constructor and Description
PartitionGridData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
ContextItemMapping<INode,PartitionCellId,PartitionGrid>	getCellIds() Gets the mapping from nodes to PartitionCellId using the partition grid as context.
ItemMapping<INode,Integer>	getColumnIndices() Gets the mapping from nodes to the index of their columns.
PartitionGrid	getGrid() Gets the partition grid.
ItemMapping<INode,Integer>	getRowIndices() Gets the mapping from nodes to the index of their rows.
void	setCellIds(ContextItemMapping<INode,PartitionCellId,PartitionGrid> value) Sets the mapping from nodes to PartitionCellId using the partition grid as context.
void	setColumnIndices(ItemMapping<INode,Integer> value) Sets the mapping from nodes to the index of their columns.
void	setGrid(PartitionGrid value) Sets the partition grid.
void	setRowIndices(ItemMapping<INode,Integer> value) Sets the mapping from nodes to the index of their rows.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionGridData

public PartitionGridData()

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.

getCellIds

public final ContextItemMapping<INode,PartitionCellId,PartitionGrid> getCellIds()

Gets the mapping from nodes to PartitionCellId using the partition grid as context.

Returns:

The CellIds.

See Also:

setCellIds(ContextItemMapping)

getColumnIndices

public final ItemMapping<INode,Integer> getColumnIndices()

Gets the mapping from nodes to the index of their columns.

Returns:

The ColumnIndices.

See Also:

setColumnIndices(ItemMapping)

getGrid

public final PartitionGrid getGrid()

Gets the partition grid.

Returns:

The Grid.

See Also:

PartitionGrid.PARTITION_GRID_DPKEY, setGrid(PartitionGrid)

getRowIndices

public final ItemMapping<INode,Integer> getRowIndices()

Gets the mapping from nodes to the index of their rows.

Returns:

The RowIndices.

See Also:

setRowIndices(ItemMapping)

setCellIds

public final void setCellIds(ContextItemMapping<INode,PartitionCellId,PartitionGrid> value)

Sets the mapping from nodes to PartitionCellId using the partition grid as context.

Parameters:

value - The CellIds to set.

See Also:

getCellIds()

setColumnIndices

public final void setColumnIndices(ItemMapping<INode,Integer> value)

Sets the mapping from nodes to the index of their columns.

Parameters:

value - The ColumnIndices to set.

See Also:

getColumnIndices()

setGrid

public final void setGrid(PartitionGrid value)

Sets the partition grid.

Parameters:

value - The Grid to set.

See Also:

PartitionGrid.PARTITION_GRID_DPKEY, getGrid()

setRowIndices

public final void setRowIndices(ItemMapping<INode,Integer> value)

Sets the mapping from nodes to the index of their rows.

Parameters:

value - The RowIndices to set.

See Also:

getRowIndices()