com.yworks.yfiles.layout

Class PartitionCellId

java.lang.Object

com.yworks.yfiles.layout.PartitionCellId

public class PartitionCellId
extends Object

PartitionCellId represents an identifier for partition cells of a partition grid structure.

See Also:

PartitionGrid

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionCellId.Cell This class represents a single partition cell, i.e., a pair consisting of a row and a column.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares this PartitionCellId instance with a given other PartitionCellId instance.
Iterable<PartitionCellId.Cell>	getCells() Gets a collection of elements of type PartitionCellId.Cell.
ColumnDescriptor	getColumn() Gets the first column associated with this partition cell identifier.
RowDescriptor	getRow() Gets the first row associated with this partition cell identifier.
int	hashCode() Returns the hash code value for this PartitionCellId instance.
boolean	isSpanning() Gets whether or not this PartitionCellId represents a multi-cell, i.e., a cell spanning multiple rows/columns.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object o)

Compares this PartitionCellId instance with a given other PartitionCellId instance.

Overrides:

equals in class Object

Parameters:

o - the given PartitionCellId instance

Returns:

true if the two objects are equal, false otherwise

getCells

public Iterable<PartitionCellId.Cell> getCells()

Gets a collection of elements of type PartitionCellId.Cell.

Each pair consists of a column and a row defining a single partition cell.

A partition cell identifier that covers more than one partition cell can only be assigned to group nodes.

Returns:

a Collection of elements of type PartitionCellId.Cell

getColumn

public ColumnDescriptor getColumn()

Gets the first column associated with this partition cell identifier.

Returns:

the first column associated with this partition cell identifier

getRow

public RowDescriptor getRow()

Gets the first row associated with this partition cell identifier.

Returns:

the first row associated with this partition cell identifier

hashCode

public int hashCode()

Returns the hash code value for this PartitionCellId instance.

Overrides:

hashCode in class Object

Returns:

the hash code value for this PartitionCellId instance

isSpanning

public boolean isSpanning()

Gets whether or not this PartitionCellId represents a multi-cell, i.e., a cell spanning multiple rows/columns.

This means that it was created using PartitionGrid.createCellSpanId(Collection, Collection), PartitionGrid.createCellSpanId(RowDescriptor, ColumnDescriptor, RowDescriptor, ColumnDescriptor), PartitionGrid.createCellSpanId(int, int, int, int), PartitionGrid.createColumnSpanId(int) or PartitionGrid.createRowSpanId(int).

Returns:

true if this PartitionCellId represents a multi-cell, false otherwise