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

Class KeyRowInsertEvent

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.event.RowVisualChangeEvent

org.eclipse.nebula.widgets.nattable.layer.event.RowStructuralChangeEvent

org.eclipse.nebula.widgets.nattable.layer.event.RowInsertEvent

org.eclipse.nebula.widgets.nattable.datachange.event.KeyRowInsertEvent

All Implemented Interfaces:

ILayerEvent, IStructuralChangeEvent, IVisualChangeEvent

public class KeyRowInsertEvent
extends RowInsertEvent

Extension of the RowInsertEvent that additionally carries the keys of the inserted objects. Used for example in combination with the DataChangeLayer to be able to revert an insert operation in a sorted or filtered state.

Since:

1.6

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyRowInsertEvent(KeyRowInsertEvent event)	Clone constructor.
	KeyRowInsertEvent(ILayer layer, int rowIndex, Object key, CellKeyHandler<?> keyHandler)	Creates a KeyRowInsertEvent for one inserted row object.
	KeyRowInsertEvent(ILayer layer, Collection<Range> rowPositionRanges, Collection<Object> keys, CellKeyHandler<?> keyHandler)	Creates a KeyRowInsertEvent for multiple inserted row objects.
	KeyRowInsertEvent(ILayer layer, Range rowPositionRange, Collection<Object> keys, CellKeyHandler<?> keyHandler)	Creates a KeyRowInsertEvent for multiple inserted row objects.

Method Summary

Modifier and Type	Method	Description
KeyRowInsertEvent	cloneEvent()
CellKeyHandler<?>	getKeyHandler()
List<Object>	getKeys()

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.event.RowInsertEvent

getRowDiffs

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.event.RowStructuralChangeEvent

getChangedPositionRectangles, getColumnDiffs, isHorizontalStructureChanged, isVerticalStructureChanged

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.event.RowVisualChangeEvent

convertToLocal, getLayer, getRowIndexes, getRowPositionRanges, setRowPositionRanges, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.event.ILayerEvent

convertToLocal

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.event.IVisualChangeEvent

getLayer

Constructor Details

KeyRowInsertEvent

public KeyRowInsertEvent(ILayer layer,
 int rowIndex,
 Object key,
 CellKeyHandler<?> keyHandler)

Creates a KeyRowInsertEvent for one inserted row object.

Parameters:

layer - The layer to which the row index is matching.

rowIndex - The index of the row that was inserted.

key - The key of the inserted row object.

keyHandler - The CellKeyHandler that was used to create the key.

KeyRowInsertEvent

public KeyRowInsertEvent(ILayer layer,
 Range rowPositionRange,
 Collection<Object> keys,
 CellKeyHandler<?> keyHandler)

Creates a KeyRowInsertEvent for multiple inserted row objects.

Parameters:

layer - The layer to which the row indexes are matching.

rowPositionRange - The position range of the inserted rows.

keys - The keys of the inserted rows.

keyHandler - The CellKeyHandler that was used to create the key.

KeyRowInsertEvent

public KeyRowInsertEvent(ILayer layer,
 Collection<Range> rowPositionRanges,
 Collection<Object> keys,
 CellKeyHandler<?> keyHandler)

Creates a KeyRowInsertEvent for multiple inserted row objects.

Parameters:

layer - The layer to which the row indexes are matching.

rowPositionRanges - The position ranges of the inserted rows.

keys - The keys of the inserted rows.

keyHandler - The CellKeyHandler that was used to create the key.

KeyRowInsertEvent

protected KeyRowInsertEvent(KeyRowInsertEvent event)

Clone constructor.

Parameters:

event - The event to clone.

Method Details

getKeys

public List<Object> getKeys()

Returns:

The keys of the inserted rows.

getKeyHandler

public CellKeyHandler<?> getKeyHandler()

Returns:

The CellKeyHandler that was used to create the key.

cloneEvent

public KeyRowInsertEvent cloneEvent()

Specified by:

cloneEvent in interface ILayerEvent

Overrides:

cloneEvent in class RowInsertEvent

Returns:

A cloned copy of the event. This cloned copy is provided to each listener.