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

Class ViewportSelectRowGroupCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractRowCommand

org.eclipse.nebula.widgets.nattable.group.command.ViewportSelectRowGroupCommand

All Implemented Interfaces:

ILayerCommand

public class ViewportSelectRowGroupCommand
extends AbstractRowCommand

Command to trigger the selection of all rows belonging to a row group.

Since:

1.6

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewportSelectRowGroupCommand(ViewportSelectRowGroupCommand command)	Clone constructor.
	ViewportSelectRowGroupCommand(ILayer layer, int rowPosition, int originRowPosition, int rowSpan, boolean withShiftMask, boolean withControlMask)

Method Summary

Modifier and Type	Method	Description
ViewportSelectRowGroupCommand	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	getOriginRowPosition()
int	getRowSpan()
boolean	isWithControlMask()
boolean	isWithShiftMask()

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractRowCommand

getLayer, getRowPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewportSelectRowGroupCommand

public ViewportSelectRowGroupCommand(ILayer layer,
                                     int rowPosition,
                                     int originRowPosition,
                                     int rowSpan,
                                     boolean withShiftMask,
                                     boolean withControlMask)

Parameters:

layer - The ILayer for the row position reference.

rowPosition - The row position of the first row in a group according to the given layer.

originRowPosition - The origin row position which is the starting position of the row group that is selected.

rowSpan - The spanning of the row group needed for region selection.

withShiftMask - true if the selection should be processed as if the shift modifier is active.

withControlMask - true if the selection should be processed as if the control modifier is active.

ViewportSelectRowGroupCommand

protected ViewportSelectRowGroupCommand(ViewportSelectRowGroupCommand command)

Clone constructor.

Parameters:

command - The command to clone.

Method Detail

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 AbstractRowCommand

Parameters:

targetLayer - the target layer

Returns:

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

getOriginRowPosition

public int getOriginRowPosition()

Returns:

The origin row position which is the starting position of the row group that is selected.

getRowSpan

public int getRowSpan()

Returns:

The spanning of the row group needed for region selection.

isWithShiftMask

public boolean isWithShiftMask()

Returns:

whether the shift modifier is active.

isWithControlMask

public boolean isWithControlMask()

Returns:

whether the control modifier is active.

cloneCommand

public ViewportSelectRowGroupCommand 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.

Returns:

a cloned instance of the command

See Also:

GridLayer.doCommand(ILayerCommand)