Package org.eclipse.nebula.widgets.nattable.datachange

Class IdIndexKeyHandler<T>

java.lang.Object

org.eclipse.nebula.widgets.nattable.datachange.IdIndexKeyHandler<T>

Type Parameters:

T - The type of the objects handled inside the NatTable.

All Implemented Interfaces:

CellKeyHandler<IdIndexIdentifier<T>>

public class IdIndexKeyHandler<T>
extends Object
implements CellKeyHandler<IdIndexIdentifier<T>>

Implementation of CellKeyHandler that uses IdIndexIdentifier as key object. Operates via IRowDataProvider and IRowIdAccessor to find the row index even in sorted or filtered collections again.

Since:

1.6

Constructor Summary

Constructors

Constructor	Description
IdIndexKeyHandler(IRowDataProvider<T> rowDataProvider, IRowIdAccessor<T> rowIdAccessor)	Creates an IdIndexKeyHandler that identifies the type to handle via reflection.
IdIndexKeyHandler(IRowDataProvider<T> rowDataProvider, IRowIdAccessor<T> rowIdAccessor, Class<T> type)

Method Summary

Modifier and Type	Method	Description
int	getColumnIndex(IdIndexIdentifier<T> key)
IdIndexIdentifier<T>	getKey(int columnIndex, int rowIndex)	Creates the cell key based on the given column index and row index.
IdIndexIdentifier<T>	getKeyWithColumnUpdate(IdIndexIdentifier<T> oldKey, int columnIndex)	Creates a new cell key based on the given key with an updated column index.
IdIndexIdentifier<T>	getKeyWithRowUpdate(IdIndexIdentifier<T> oldKey, int rowIndex)	Creates a new cell key based on the given key with an updated row index.
int	getRowIndex(IdIndexIdentifier<T> key)
boolean	updateOnHorizontalStructuralChange()
boolean	updateOnVerticalStructuralChange()

Methods inherited from class java.lang.Object

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

Constructor Details

IdIndexKeyHandler

public IdIndexKeyHandler(IRowDataProvider<T> rowDataProvider,
 IRowIdAccessor<T> rowIdAccessor)

Creates an IdIndexKeyHandler that identifies the type to handle via reflection. If the reflection fails or produces strange results, try to pass the type via IdIndexKeyHandler(IRowDataProvider, IRowIdAccessor, Class)

Parameters:

rowDataProvider - The IRowDataProvider needed to retrieve the modified row object.

rowIdAccessor - The IRowIdAccessor needed to retrieve the row object id.

IdIndexKeyHandler

public IdIndexKeyHandler(IRowDataProvider<T> rowDataProvider,
 IRowIdAccessor<T> rowIdAccessor,
 Class<T> type)

Parameters:

rowDataProvider - The IRowDataProvider needed to retrieve the modified row object.

rowIdAccessor - The IRowIdAccessor needed to retrieve the row object id.

type - The type of objects handled by the IRowDataProvider and the IRowIdAcccessor.

Since:

2.1

Method Details

getKey

public IdIndexIdentifier<T> getKey(int columnIndex,
 int rowIndex)

Description copied from interface: CellKeyHandler

Creates the cell key based on the given column index and row index.

Specified by:

getKey in interface CellKeyHandler<T>

Parameters:

columnIndex - The column index of the cell whose key should be generated.

rowIndex - The row index of the cell whose key should be generated.

Returns:

The key of the cell with the given indexes.

getKeyWithColumnUpdate

public IdIndexIdentifier<T> getKeyWithColumnUpdate(IdIndexIdentifier<T> oldKey,
 int columnIndex)

Description copied from interface: CellKeyHandler

Creates a new cell key based on the given key with an updated column index.

Specified by:

getKeyWithColumnUpdate in interface CellKeyHandler<T>

Parameters:

oldKey - The key that should be copied.

columnIndex - The column index that should be updated in the existing key.

Returns:

The key of the cell with the previous row identifier and the updated column identifier.

getKeyWithRowUpdate

public IdIndexIdentifier<T> getKeyWithRowUpdate(IdIndexIdentifier<T> oldKey,
 int rowIndex)

Description copied from interface: CellKeyHandler

Creates a new cell key based on the given key with an updated row index.

Specified by:

getKeyWithRowUpdate in interface CellKeyHandler<T>

Parameters:

oldKey - The key that should be copied.

rowIndex - The row index that should be updated in the existing key.

Returns:

The key of the cell with the previous column identifier and the updated row identifier.

getColumnIndex

public int getColumnIndex(IdIndexIdentifier<T> key)

Specified by:

getColumnIndex in interface CellKeyHandler<T>

Parameters:

key - The key from which the column index should be retrieved.

Returns:

The column index for the cell key.

getRowIndex

public int getRowIndex(IdIndexIdentifier<T> key)

Specified by:

getRowIndex in interface CellKeyHandler<T>

Parameters:

key - The key from which the row index should be retrieved.

Returns:

The row index for the cell key.

updateOnHorizontalStructuralChange

public boolean updateOnHorizontalStructuralChange()

Specified by:

updateOnHorizontalStructuralChange in interface CellKeyHandler<T>

Returns:

true if the keys created by this handler need to be updated on horizontal structural changes, false if the keys update automatically.

updateOnVerticalStructuralChange

public boolean updateOnVerticalStructuralChange()

Specified by:

updateOnVerticalStructuralChange in interface CellKeyHandler<T>

Returns:

true if the keys created by this handler need to be updated on vertical structural changes, false if the keys update automatically.