Package org.eclipse.nebula.widgets.nattable.groupby

Class GroupByCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.groupby.GroupByCommand

All Implemented Interfaces:

ILayerCommand

public class GroupByCommand
extends Object
implements ILayerCommand

Command to trigger a groupBy action.

Since:

2.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GroupByCommand.GroupByAction

Constructor Summary

Constructors

Constructor	Description
GroupByCommand(GroupByCommand.GroupByAction action, int... indexes)	Performs the specified groupBy action for the given indexes.

Method Summary

Modifier and Type	Method	Description
GroupByCommand	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.
GroupByCommand.GroupByAction	getAction()
int[]	getIndexes()

Methods inherited from class java.lang.Object

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

Constructor Details

GroupByCommand

public GroupByCommand(GroupByCommand.GroupByAction action,
 int... indexes)

Performs the specified groupBy action for the given indexes.

Parameters:

action - The groupBy action to perform

• GroupByCommand.GroupByAction.ADD - Add the given indexes to the existing grouping.
• GroupByCommand.GroupByAction.CLEAR - Clears the existing grouping. Given indexes will be ignored.
• GroupByCommand.GroupByAction.REMOVE - Removes the given indexes from the existing grouping.
• GroupByCommand.GroupByAction.SET - Set the given indexes which overrides the existing grouping.

indexes - The indexes of the columns/rows that should be grouped.

Method Details

getAction

public GroupByCommand.GroupByAction getAction()

Returns:

The groupBy action to perform.

getIndexes

public int[] getIndexes()

Returns:

The indexes of the columns/rows that should be grouped.

cloneCommand

public GroupByCommand 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)

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.