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

Class AbstractMultiRowCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractMultiRowCommand

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

AutoResizeRowsCommand, MultiRowHideCommand, MultiRowResizeCommand, RowDeleteCommand, SelectRowsCommand

public abstract class AbstractMultiRowCommand
extends Object
implements ILayerCommand

Abstract implementation for commands that should process multiple rows.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultiRowCommand(AbstractMultiRowCommand command)	Clone constructor
protected	AbstractMultiRowCommand(ILayer layer, int... rowPositions)

Method Summary

Modifier and Type	Method	Description
boolean	convertToTargetLayer(ILayer targetLayer)	Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.
Collection<Integer>	getRowPositions()
int[]	getRowPositionsArray()
protected void	setRowPositions(ILayer layer, int... rowPositions)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.command.ILayerCommand

cloneCommand

Constructor Detail

AbstractMultiRowCommand

protected AbstractMultiRowCommand(ILayer layer,
                                  int... rowPositions)

Parameters:

layer - The ILayer to which the positions match.

rowPositions - The positions that should be processed by this command.

AbstractMultiRowCommand

protected AbstractMultiRowCommand(AbstractMultiRowCommand command)

Clone constructor

Parameters:

command - The command to clone.

Method Detail

getRowPositions

public Collection<Integer> getRowPositions()

Returns:

The unique row positions that should be processed by this command.

getRowPositionsArray

public int[] getRowPositionsArray()

Returns:

The unique row positions that should be processed by this command.

Since:

2.0

setRowPositions

protected final void setRowPositions(ILayer layer,
                                     int... rowPositions)

Parameters:

layer - The ILayer to which the positions match.

rowPositions - The positions that should be processed by this command.

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.