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

Class ColumnReorderCommand

java.lang.Object

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

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

ReorderColumnGroupCommand

public class ColumnReorderCommand
extends Object
implements ILayerCommand

Command to reorder a single column.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ColumnReorderCommand(ILayer layer, int fromColumnPosition, int toColumnPosition)
protected	ColumnReorderCommand(ColumnReorderCommand command)	Clone constructor.

Method Summary

Modifier and Type	Method	Description
ColumnReorderCommand	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	getFromColumnPosition()
int	getToColumnPosition()
boolean	isReorderToLeftEdge()
void	toggleCoordinateByEdge()	Toggles the coordinate from left edge to right edge and vice versa.
void	updateFromColumnPosition(int fromPosition)
void	updateToColumnPosition(int toPosition)

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnReorderCommand

public ColumnReorderCommand(ILayer layer,
                            int fromColumnPosition,
                            int toColumnPosition)

Parameters:

layer - The layer to which the column positions match.

fromColumnPosition - The column position to reorder.

toColumnPosition - The target column position to reorder to.

ColumnReorderCommand

protected ColumnReorderCommand(ColumnReorderCommand command)

Clone constructor.

Parameters:

command - The command to clone.

Method Detail

getFromColumnPosition

public int getFromColumnPosition()

Returns:

The column position that is reordered.

updateFromColumnPosition

public void updateFromColumnPosition(int fromPosition)

Parameters:

fromPosition - The new fromColumnPosition.

Since:

1.6

getToColumnPosition

public int getToColumnPosition()

Returns:

The column position to which the column should be reordered to.

updateToColumnPosition

public void updateToColumnPosition(int toPosition)

Parameters:

toPosition - The new toColumnPosition.

Since:

1.6

toggleCoordinateByEdge

public void toggleCoordinateByEdge()

Toggles the coordinate from left edge to right edge and vice versa. Will not toggle if the coordinate is right edge of the last column or the left edge of the first column.

Since:

1.6

isReorderToLeftEdge

public boolean isReorderToLeftEdge()

Returns:

true if the reorder operation should be done on the left edge of the toColumnPosition, false if it should be reordered to the right edge.

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 ColumnReorderCommand 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)