Package org.eclipse.nebula.widgets.nattable.reorder.command

Class RowReorderCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.reorder.command.RowReorderCommand

All Implemented Interfaces:

ILayerCommand

public class RowReorderCommand
extends Object
implements ILayerCommand

Command for reordering a single row.

Constructor Summary

Constructors

Modifier	Constructor	Description
	RowReorderCommand(ILayer layer, int fromRowPosition, int toRowPosition)
protected	RowReorderCommand(RowReorderCommand command)	Constructor used for cloning purposes

Method Summary

Modifier and Type	Method	Description
RowReorderCommand	cloneCommand()	Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
boolean	convertToTargetLayer(ILayer targetLayer)	Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.
int	getFromRowPosition()
int	getToRowPosition()
boolean	isReorderToTopEdge()
void	toggleCoordinateByEdge()	Toggles the coordinate from top edge to bottom edge and vice versa.
void	updateFromRowPosition(int fromPosition)
void	updateToRowPosition(int toPosition)

Methods inherited from class java.lang.Object

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

Constructor Detail

RowReorderCommand

public RowReorderCommand(ILayer layer,
                         int fromRowPosition,
                         int toRowPosition)

Parameters:

layer - The layer the positions are related to

fromRowPosition - The position of the row that should be reordered

toRowPosition - The position of the row to which the dragged row should be dropped

RowReorderCommand

protected RowReorderCommand(RowReorderCommand command)

Constructor used for cloning purposes

Parameters:

command - The command which is base for the new one

Method Detail

getFromRowPosition

public int getFromRowPosition()

Returns:

The position of the row that should be reordered

updateFromRowPosition

public void updateFromRowPosition(int fromPosition)

Parameters:

fromPosition - The new fromRowPosition.

Since:

1.6

getToRowPosition

public int getToRowPosition()

Returns:

The position of the row to which the dragged row should be dropped

updateToRowPosition

public void updateToRowPosition(int toPosition)

Parameters:

toPosition - The new toRowPosition.

Since:

1.6

toggleCoordinateByEdge

public void toggleCoordinateByEdge()

Toggles the coordinate from top edge to bottom edge and vice versa. Will not toggle if the coordinate is bottom edge of the last row or the top edge of the first row.

Since:

1.6

isReorderToTopEdge

public boolean isReorderToTopEdge()

Returns:

Flag to indicate if the row is dragged to the top edge of the layer.

convertToTargetLayer

public boolean convertToTargetLayer(ILayer targetLayer)

Description copied from interface: ILayerCommand

Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer. If it is not possible to convert the command to the target layer, then this method will return false and the state of this command object will remain unchanged. Note: Commands should not be processed if they fail conversion.

Specified by:

convertToTargetLayer in interface ILayerCommand

Parameters:

targetLayer - the target layer

Returns:

true if the command is valid after conversion, false if the command is no longer valid.

cloneCommand

public RowReorderCommand cloneCommand()

Description copied from interface: ILayerCommand

Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.

Specified by:

cloneCommand in interface ILayerCommand

Returns:

a cloned instance of the command

See Also:

GridLayer.doCommand(ILayerCommand)