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

Class ViewportSelectColumnGroupCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractColumnCommand

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

All Implemented Interfaces:

ILayerCommand

public class ViewportSelectColumnGroupCommand
extends AbstractColumnCommand

Command to trigger the selection of all columns belonging to a column group.

Since:

1.6

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewportSelectColumnGroupCommand(ViewportSelectColumnGroupCommand command)	Clone constructor.
	ViewportSelectColumnGroupCommand(ILayer layer, int columnPosition, int originColumnPosition, int columnSpan, boolean withShiftMask, boolean withControlMask)

Method Summary

Modifier and Type	Method	Description
ViewportSelectColumnGroupCommand	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	getColumnSpan()
int	getOriginColumnPosition()
boolean	isWithControlMask()
boolean	isWithShiftMask()

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

getColumnPosition, getLayer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewportSelectColumnGroupCommand

public ViewportSelectColumnGroupCommand(ILayer layer,
                                        int columnPosition,
                                        int originColumnPosition,
                                        int columnSpan,
                                        boolean withShiftMask,
                                        boolean withControlMask)

Parameters:

layer - The ILayer for the column position reference.

columnPosition - The column position of the first column in a group according to the given layer.

originColumnPosition - The origin column position which is the starting position of the column group that is selected.

columnSpan - The spanning of the column 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.

ViewportSelectColumnGroupCommand

protected ViewportSelectColumnGroupCommand(ViewportSelectColumnGroupCommand 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 AbstractColumnCommand

Parameters:

targetLayer - the target layer

Returns:

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

getOriginColumnPosition

public int getOriginColumnPosition()

Returns:

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

getColumnSpan

public int getColumnSpan()

Returns:

The spanning of the column 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 ViewportSelectColumnGroupCommand 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)