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

Class MoveCellSelectionCommandHandler

java.lang.Object

org.eclipse.nebula.widgets.nattable.selection.MoveSelectionCommandHandler<MoveSelectionCommand>

org.eclipse.nebula.widgets.nattable.selection.MoveCellSelectionCommandHandler

All Implemented Interfaces:

ILayerCommandHandler<MoveSelectionCommand>

Direct Known Subclasses:

MoveRowSelectionCommandHandler

public class MoveCellSelectionCommandHandler
extends MoveSelectionCommandHandler<MoveSelectionCommand>

Specifies the semantics of moving the selection in the table, based on selecting the adjoining cell(s).

Field Summary

Fields

Modifier and Type	Field	Description
protected PositionCoordinate	lastSelectedCellPosition
protected int	newSelectedColumnPosition
protected int	newSelectedRowPosition

Fields inherited from class org.eclipse.nebula.widgets.nattable.selection.MoveSelectionCommandHandler

horizontalTraversalStrategy, selectionLayer, verticalTraversalStrategy

Constructor Summary

Constructors

Constructor	Description
MoveCellSelectionCommandHandler(SelectionLayer selectionLayer)	Create a MoveCellSelectionCommandHandler for the given SelectionLayer.
MoveCellSelectionCommandHandler(SelectionLayer selectionLayer, ITraversalStrategy traversalStrategy)	Create a MoveCellSelectionCommandHandler for the given SelectionLayer.
MoveCellSelectionCommandHandler(SelectionLayer selectionLayer, ITraversalStrategy horizontalTraversalStrategy, ITraversalStrategy verticalTraversalStrategy)	Create a MoveCellSelectionCommandHandler for the given SelectionLayer .

Method Summary

Modifier and Type	Method	Description
protected ITraversalStrategy	createIncrementalStrategy(ITraversalStrategy baseStrategy)	Creates a ITraversalStrategy that wraps the given base strategy but returning the step count + 1.
Class<MoveSelectionCommand>	getCommandClass()
protected void	moveLastSelectedDown(ITraversalStrategy traversalStrategy, boolean withShiftMask, boolean withControlMask)	Moves the selection from the current position down.
protected void	moveLastSelectedLeft(ITraversalStrategy traversalStrategy, boolean withShiftMask, boolean withControlMask)	Moves the selection from the current position to the left.
protected void	moveLastSelectedRight(ITraversalStrategy traversalStrategy, boolean withShiftMask, boolean withControlMask)	Moves the selection from the current position to the right.
protected void	moveLastSelectedUp(ITraversalStrategy traversalStrategy, boolean withShiftMask, boolean withControlMask)	Moves the selection from the current position up.
protected boolean	positionMoved()

Methods inherited from class org.eclipse.nebula.widgets.nattable.selection.MoveSelectionCommandHandler

doCommand, getTraversalStrategy, moveSelection

Methods inherited from class java.lang.Object

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

Field Detail

lastSelectedCellPosition

protected PositionCoordinate lastSelectedCellPosition

newSelectedColumnPosition

protected int newSelectedColumnPosition

newSelectedRowPosition

protected int newSelectedRowPosition

Constructor Detail

MoveCellSelectionCommandHandler

public MoveCellSelectionCommandHandler(SelectionLayer selectionLayer)

Create a MoveCellSelectionCommandHandler for the given SelectionLayer. Uses the ITraversalStrategy.AXIS_TRAVERSAL_STRATEGY as default strategy for selection movement.

Parameters:

selectionLayer - The SelectionLayer on which the selection should be performed.

MoveCellSelectionCommandHandler

public MoveCellSelectionCommandHandler(SelectionLayer selectionLayer,
                                       ITraversalStrategy traversalStrategy)

Create a MoveCellSelectionCommandHandler for the given SelectionLayer.

Parameters:

selectionLayer - The SelectionLayer on which the selection should be performed.

traversalStrategy - The strategy that should be used for selection movements. Can not be null.

MoveCellSelectionCommandHandler

public MoveCellSelectionCommandHandler(SelectionLayer selectionLayer,
                                       ITraversalStrategy horizontalTraversalStrategy,
                                       ITraversalStrategy verticalTraversalStrategy)

Create a MoveCellSelectionCommandHandler for the given SelectionLayer .

Parameters:

selectionLayer - The SelectionLayer on which the selection should be performed.

horizontalTraversalStrategy - The strategy that should be used for horizontal selection movements. Can not be null.

verticalTraversalStrategy - The strategy that should be used for vertical selection movements. Can not be null.

Method Detail

moveLastSelectedLeft

protected void moveLastSelectedLeft(ITraversalStrategy traversalStrategy,
                                    boolean withShiftMask,
                                    boolean withControlMask)

Description copied from class: MoveSelectionCommandHandler

Moves the selection from the current position to the left.

Specified by:

moveLastSelectedLeft in class MoveSelectionCommandHandler<MoveSelectionCommand>

Parameters:

traversalStrategy - the traversal strategy to determine the number of steps to move and the behavior on moving over the border

withShiftMask - boolean flag to indicate whether the shift key modifier is enabled or not

withControlMask - boolean flag to indicate whether the control key modifier is enabled or not

moveLastSelectedRight

protected void moveLastSelectedRight(ITraversalStrategy traversalStrategy,
                                     boolean withShiftMask,
                                     boolean withControlMask)

Description copied from class: MoveSelectionCommandHandler

Moves the selection from the current position to the right.

Specified by:

moveLastSelectedRight in class MoveSelectionCommandHandler<MoveSelectionCommand>

Parameters:

traversalStrategy - the traversal strategy to determine the number of steps to move and the behavior on moving over the border

withShiftMask - boolean flag to indicate whether the shift key modifier is enabled or not

withControlMask - boolean flag to indicate whether the control key modifier is enabled or not

moveLastSelectedUp

protected void moveLastSelectedUp(ITraversalStrategy traversalStrategy,
                                  boolean withShiftMask,
                                  boolean withControlMask)

Description copied from class: MoveSelectionCommandHandler

Moves the selection from the current position up.

Specified by:

moveLastSelectedUp in class MoveSelectionCommandHandler<MoveSelectionCommand>

Parameters:

traversalStrategy - the traversal strategy to determine the number of steps to move and the behavior on moving over the border

withShiftMask - boolean flag to indicate whether the shift key modifier is enabled or not

withControlMask - boolean flag to indicate whether the control key modifier is enabled or not

moveLastSelectedDown

protected void moveLastSelectedDown(ITraversalStrategy traversalStrategy,
                                    boolean withShiftMask,
                                    boolean withControlMask)

Description copied from class: MoveSelectionCommandHandler

Moves the selection from the current position down.

Specified by:

moveLastSelectedDown in class MoveSelectionCommandHandler<MoveSelectionCommand>

Parameters:

traversalStrategy - the traversal strategy to determine the number of steps to move and the behavior on moving over the border

withShiftMask - boolean flag to indicate whether the shift key modifier is enabled or not

withControlMask - boolean flag to indicate whether the control key modifier is enabled or not

createIncrementalStrategy

protected ITraversalStrategy createIncrementalStrategy(ITraversalStrategy baseStrategy)

Creates a ITraversalStrategy that wraps the given base strategy but returning the step count + 1. Used to perform incremental movement in case the base strategy specifies logic to determine whether a target cell is a valid move target or not.

Parameters:

baseStrategy - The ITraversalStrategy to wrap.

Returns:

A ITraversalStrategy that wraps the given base strategy using the given step count.

positionMoved

protected boolean positionMoved()

Returns:

true if the selection moved in any direction, false if the selection stays at the same position

getCommandClass

public Class<MoveSelectionCommand> getCommandClass()