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

Class RowSelectionEvent

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.selection.event.RowSelectionEvent

All Implemented Interfaces:

ILayerEvent, IVisualChangeEvent, ISelectionEvent

public class RowSelectionEvent
extends RowVisualChangeEvent
implements ISelectionEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RowSelectionEvent(RowSelectionEvent event)
	RowSelectionEvent(SelectionLayer selectionLayer, int[] rowPositions, int rowPositionToMoveIntoViewport, boolean withShiftMask, boolean withControlMask)	Constructor.
	RowSelectionEvent(SelectionLayer selectionLayer, Collection<Integer> rowPositions, int rowPositionToMoveIntoViewport, boolean withShiftMask, boolean withControlMask)	Constructor.
	RowSelectionEvent(SelectionLayer selectionLayer, Range rowPositionRange, int rowPositionToMoveIntoViewport, boolean withShiftMask, boolean withControlMask)	Constructor.

Method Summary

Modifier and Type	Method	Description
RowSelectionEvent	cloneEvent()
boolean	convertToLocal(ILayer localLayer)	Convert the column/row positions carried by the event to the layer about to handle the event.
int	getRowPositionToMoveIntoViewport()
SelectionLayer	getSelectionLayer()
boolean	isWithControlMask()	Returns if the control mask is used.
boolean	isWithShiftMask()	Returns if the shift mask is used.

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

getChangedPositionRectangles, getLayer, getRowIndexes, getRowPositionRanges, setRowPositionRanges, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RowSelectionEvent

public RowSelectionEvent(SelectionLayer selectionLayer,
 Collection<Integer> rowPositions,
 int rowPositionToMoveIntoViewport,
 boolean withShiftMask,
 boolean withControlMask)

Constructor.

Parameters:

selectionLayer - The selection layer.

rowPositions - The positions of the rows.

rowPositionToMoveIntoViewport - The row position to move into the viewport.

withShiftMask - Boolean to determinate if the shift mask is used.

withControlMask - Boolean to determinate if the control mask is used.

Since:

1.4

RowSelectionEvent

public RowSelectionEvent(SelectionLayer selectionLayer,
 int[] rowPositions,
 int rowPositionToMoveIntoViewport,
 boolean withShiftMask,
 boolean withControlMask)

Constructor.

Parameters:

selectionLayer - The selection layer.

rowPositions - The positions of the rows.

rowPositionToMoveIntoViewport - The row position to move into the viewport.

withShiftMask - Boolean to determinate if the shift mask is used.

withControlMask - Boolean to determinate if the control mask is used.

Since:

2.0

RowSelectionEvent

public RowSelectionEvent(SelectionLayer selectionLayer,
 Range rowPositionRange,
 int rowPositionToMoveIntoViewport,
 boolean withShiftMask,
 boolean withControlMask)

Constructor.

Parameters:

selectionLayer - The selection layer.

rowPositionRange - The range of row positions that where selected.

rowPositionToMoveIntoViewport - The row position to move into the viewport.

withShiftMask - Boolean to determinate if the shift mask is used.

withControlMask - Boolean to determinate if the control mask is used.

Since:

1.6

RowSelectionEvent

protected RowSelectionEvent(RowSelectionEvent event)

Method Details

getSelectionLayer

public SelectionLayer getSelectionLayer()

Specified by:

getSelectionLayer in interface ISelectionEvent

getRowPositionToMoveIntoViewport

public int getRowPositionToMoveIntoViewport()

isWithShiftMask

public boolean isWithShiftMask()

Returns if the shift mask is used.

Returns:

true if the shift mask is used, false otherwise.

Since:

1.4

isWithControlMask

public boolean isWithControlMask()

Returns if the control mask is used.

Returns:

true if the control mask is used, false otherwise.

Since:

1.4

convertToLocal

public boolean convertToLocal(ILayer localLayer)

Description copied from interface: ILayerEvent

Convert the column/row positions carried by the event to the layer about to handle the event.

Specified by:

convertToLocal in interface ILayerEvent

Overrides:

convertToLocal in class RowVisualChangeEvent

Parameters:

localLayer - layer about to receive the event

Returns:

TRUE if successfully converted, FALSE otherwise

cloneEvent

public RowSelectionEvent cloneEvent()

Specified by:

cloneEvent in interface ILayerEvent

Returns:

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