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

Class GroupMultiRowReorderCommand

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.group.performance.command.GroupMultiRowReorderCommand

All Implemented Interfaces:

ILayerCommand

public class GroupMultiRowReorderCommand
extends MultiRowReorderCommand

Specialization of the MultiRowReorderCommand that ensures on conversion that the toPosition is between two groups.

Since:

1.6

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.reorder.command.MultiRowReorderCommand

toRowPositionCoordinate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GroupMultiRowReorderCommand(GroupMultiRowReorderCommand command)	Clone constructor.
	GroupMultiRowReorderCommand(ILayer layer, int[] fromRowPositions, int toRowPosition)
	GroupMultiRowReorderCommand(ILayer layer, int[] fromRowPositions, int toRowPosition, boolean reorderToTopEdge)
	GroupMultiRowReorderCommand(ILayer layer, List<Integer> fromRowPositions, int toRowPosition)
	GroupMultiRowReorderCommand(ILayer layer, List<Integer> fromRowPositions, int toRowPosition, boolean reorderToTopEdge)

Method Summary

Modifier and Type	Method	Description
GroupMultiRowReorderCommand	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.
void	setGroupToBottom(GroupModel.Group groupToBottom)
void	setGroupToTop(GroupModel.Group groupToTop)

Methods inherited from class org.eclipse.nebula.widgets.nattable.reorder.command.MultiRowReorderCommand

getFromRowPositions, getFromRowPositionsArray, getToRowPosition, isReorderByIndex, isReorderToTopEdge, setReorderByIndex, toggleCoordinateByEdge, updateFromRowPositions, updateToRowPosition

Methods inherited from class java.lang.Object

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

Constructor Details

GroupMultiRowReorderCommand

public GroupMultiRowReorderCommand(ILayer layer,
 List<Integer> fromRowPositions,
 int toRowPosition)

Parameters:

layer - The layer to which the row positions match.

fromRowPositions - The row positions to reorder.

toRowPosition - The target row position to reorder to.

Since:

2.0

GroupMultiRowReorderCommand

public GroupMultiRowReorderCommand(ILayer layer,
 List<Integer> fromRowPositions,
 int toRowPosition,
 boolean reorderToTopEdge)

Parameters:

layer - The layer to which the row positions match.

fromRowPositions - The row positions to reorder.

toRowPosition - The target row position to reorder to.

reorderToTopEdge - true if the reorder operation should be done on the top edge of the toRowPosition, false if it should be reordered to the bottom edge.

Since:

2.0

GroupMultiRowReorderCommand

public GroupMultiRowReorderCommand(ILayer layer,
 int[] fromRowPositions,
 int toRowPosition)

Parameters:

layer - The layer to which the row positions match.

fromRowPositions - The row positions to reorder.

toRowPosition - The target row position to reorder to.

Since:

2.0

GroupMultiRowReorderCommand

public GroupMultiRowReorderCommand(ILayer layer,
 int[] fromRowPositions,
 int toRowPosition,
 boolean reorderToTopEdge)

Parameters:

layer - The layer to which the row positions match.

fromRowPositions - The row positions to reorder.

toRowPosition - The target row position to reorder to.

reorderToTopEdge - true if the reorder operation should be done on the top edge of the toRowPosition, false if it should be reordered to the bottom edge.

Since:

2.0

GroupMultiRowReorderCommand

protected GroupMultiRowReorderCommand(GroupMultiRowReorderCommand command)

Clone constructor.

Parameters:

command - The command to clone.

Method Details

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

Overrides:

convertToTargetLayer in class MultiRowReorderCommand

Parameters:

targetLayer - the target layer

Returns:

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

setGroupToTop

public void setGroupToTop(GroupModel.Group groupToTop)

Parameters:

groupToTop - The GroupModel.Group that is on top of the toRowPosition. Needed to calculate the correct position to the bottom edge of a group in case of hidden rows.

Since:

2.0

setGroupToBottom

public void setGroupToBottom(GroupModel.Group groupToBottom)

Parameters:

groupToBottom - The GroupModel.Group that is at the toRowPosition. Needed to calculate the correct position to the top edge of a group in case of hidden rows.

Since:

2.0

cloneCommand

public GroupMultiRowReorderCommand 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

Overrides:

cloneCommand in class MultiRowReorderCommand

Returns:

a cloned instance of the command

See Also:

• GridLayer.doCommand(ILayerCommand)