Package org.eclipse.nebula.widgets.nattable.group.performance.action

Class ColumnHeaderReorderDragMode

java.lang.Object

org.eclipse.nebula.widgets.nattable.viewport.action.AutoScrollDragMode

org.eclipse.nebula.widgets.nattable.reorder.action.ColumnReorderDragMode

org.eclipse.nebula.widgets.nattable.group.performance.action.ColumnHeaderReorderDragMode

All Implemented Interfaces:

IDragMode

Direct Known Subclasses:

GroupByColumnGroupReorderDragMode

public class ColumnHeaderReorderDragMode
extends ColumnReorderDragMode

Extends the regular column drag functionality to work with column groups. It does the following checks:

1. Checks that the destination is not part of a Unbreakable column group
2. Checks if the destination is between two adjoining column groups

Since:

1.6

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.nebula.widgets.nattable.reorder.action.ColumnReorderDragMode

ColumnReorderDragMode.ColumnReorderOverlayPainter

Nested classes/interfaces inherited from class org.eclipse.nebula.widgets.nattable.viewport.action.AutoScrollDragMode

AutoScrollDragMode.AutoScrollRunnable

Field Summary

Fields

Modifier and Type	Field	Description
protected int	dragFromGridRowPosition

Fields inherited from class org.eclipse.nebula.widgets.nattable.reorder.action.ColumnReorderDragMode

currentEvent, dragFromGridColumnPosition, initialEvent, natTable, targetOverlayPainter

Fields inherited from class org.eclipse.nebula.widgets.nattable.viewport.action.AutoScrollDragMode

horizontalBorderOffset, verticalBorderOffset

Constructor Summary

Constructors

Constructor	Description
ColumnHeaderReorderDragMode(ColumnGroupHeaderLayer columnGroupHeaderLayer)

Method Summary

Modifier and Type	Method	Description
protected ILayerCell	getColumnCell(int x)
protected CellEdgeEnum	getMoveDirection(int x)
boolean	isValidTargetColumnPosition(ILayer natLayer, int fromGridColumnPosition, int toGridColumnPosition)
protected boolean	isValidTargetColumnPosition(ILayer natLayer, int fromGridColumnPosition, int toGridColumnPosition, int level, int fromPosition, int toPosition)	Test if the reorder is valid for the given level.
void	mouseDown(NatTable natTable, org.eclipse.swt.events.MouseEvent event)

Methods inherited from class org.eclipse.nebula.widgets.nattable.reorder.action.ColumnReorderDragMode

fireMoveEndCommand, fireMoveStartCommand, getDragFromGridColumnPosition, getDragToGridColumnPosition, mouseMove, mouseUp

Methods inherited from class org.eclipse.nebula.widgets.nattable.viewport.action.AutoScrollDragMode

performDragAction

Methods inherited from class java.lang.Object

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

Field Detail

dragFromGridRowPosition

protected int dragFromGridRowPosition

Constructor Detail

ColumnHeaderReorderDragMode

public ColumnHeaderReorderDragMode(ColumnGroupHeaderLayer columnGroupHeaderLayer)

Parameters:

columnGroupHeaderLayer - The ColumnGroupHeaderLayer to which this drag mode should be assigned to.

Method Detail

mouseDown

public void mouseDown(NatTable natTable,
                      org.eclipse.swt.events.MouseEvent event)

Specified by:

mouseDown in interface IDragMode

Overrides:

mouseDown in class ColumnReorderDragMode

isValidTargetColumnPosition

public boolean isValidTargetColumnPosition(ILayer natLayer,
                                           int fromGridColumnPosition,
                                           int toGridColumnPosition)

Overrides:

isValidTargetColumnPosition in class ColumnReorderDragMode

isValidTargetColumnPosition

protected boolean isValidTargetColumnPosition(ILayer natLayer,
                                              int fromGridColumnPosition,
                                              int toGridColumnPosition,
                                              int level,
                                              int fromPosition,
                                              int toPosition)

Test if the reorder is valid for the given level.

Parameters:

natLayer - The layer on which the drag operation is triggered, typically the NatTable instance.

fromGridColumnPosition - The from position related to the given natLayer.

toGridColumnPosition - The to position related to the given natLayer.

level - The grouping level for which the check should be performed.

fromPosition - The from position related to the positionLayer of the ColumnGroupHeaderLayer.

toPosition - The to position related to the positionLayer of the ColumnGroupHeaderLayer.

Returns:

true if the reorder would be valid on the specified level, false if not.

getMoveDirection

protected CellEdgeEnum getMoveDirection(int x)

Overrides:

getMoveDirection in class ColumnReorderDragMode

getColumnCell

protected ILayerCell getColumnCell(int x)

Overrides:

getColumnCell in class ColumnReorderDragMode

Parameters:

x - The x coordinate to determine the column of the NatTable.

Returns:

The cell at the given x coordinate and the y coordinate of the initial event.