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

Class SortColumnCommand

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.sort.command.SortColumnCommand

All Implemented Interfaces:

ILayerCommand

public class SortColumnCommand
extends AbstractColumnCommand

Command to trigger sorting.

See Also:

• SortHeaderLayer
• SortCommandHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
	SortColumnCommand(ILayer layer, int columnPosition)	Create a SortColumnCommand that triggers sorting for replacing an existing sort state (no accumulate) without specifying a sort direction.
	SortColumnCommand(ILayer layer, int columnPosition, boolean accumulate)	Create a SortColumnCommand that triggers sorting without specifying a sort direction.
	SortColumnCommand(ILayer layer, int columnPosition, boolean accumulate, SortDirectionEnum sortDirection)
	SortColumnCommand(ILayer layer, int columnPosition, SortDirectionEnum sortDirection)	Create a SortColumnCommand that triggers sorting for replacing an existing sort state (no accumulate).
protected	SortColumnCommand(SortColumnCommand command)	Constructor that is used to clone a command.

Method Summary

Modifier and Type	Method	Description
SortColumnCommand	cloneCommand()	Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
SortDirectionEnum	getSortDirection()
boolean	isAccumulate()

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

convertToTargetLayer, getColumnPosition, getLayer, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SortColumnCommand

public SortColumnCommand(ILayer layer,
 int columnPosition)

Create a SortColumnCommand that triggers sorting for replacing an existing sort state (no accumulate) without specifying a sort direction.

Parameters:

layer - The layer to which the column position belongs.

columnPosition - The position of the column for which the sorting should be applied.

SortColumnCommand

public SortColumnCommand(ILayer layer,
 int columnPosition,
 boolean accumulate)

Create a SortColumnCommand that triggers sorting without specifying a sort direction.

Parameters:

layer - The layer to which the column position belongs.

columnPosition - The position of the column for which the sorting should be applied.

accumulate - true if the sorting should be accumulated to an already applied sorting, false if the sorting should replace an existing sorting.

SortColumnCommand

public SortColumnCommand(ILayer layer,
 int columnPosition,
 SortDirectionEnum sortDirection)

Create a SortColumnCommand that triggers sorting for replacing an existing sort state (no accumulate).

Parameters:

layer - The layer to which the column position belongs.

columnPosition - The position of the column for which the sorting should be applied.

SortColumnCommand

public SortColumnCommand(ILayer layer,
 int columnPosition,
 boolean accumulate,
 SortDirectionEnum sortDirection)

Parameters:

layer - The layer to which the column position belongs.

columnPosition - The position of the column for which the sorting should be applied.

accumulate - true if the sorting should be accumulated to an already applied sorting, false if the sorting should replace an existing sorting.

sortDirection - The sort direction that should be used for sorting. Can be null which means that the sort direction will be used that is calculated by the ISortModel for the given column.

SortColumnCommand

protected SortColumnCommand(SortColumnCommand command)

Constructor that is used to clone a command.

Parameters:

command - The command instance that should be cloned.

Method Details

isAccumulate

public boolean isAccumulate()

Returns:

true if the sorting should be accumulated to an already applied sorting, false if the sorting should replace an existing sorting.

getSortDirection

public SortDirectionEnum getSortDirection()

Returns:

The sort direction that should be used for sorting. Can be null which means that the sort direction will be used that is calculated by the ISortModel for the given column.

cloneCommand

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