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

Class AbstractMultiColumnCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractMultiColumnCommand

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

AutoResizeColumnsCommand, MultiColumnHideCommand, MultiColumnResizeCommand

public abstract class AbstractMultiColumnCommand
extends Object
implements ILayerCommand

Abstract implementation for commands that should process multiple columns.

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<ColumnPositionCoordinate>	columnPositionCoordinates

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultiColumnCommand(AbstractMultiColumnCommand command)	Clone constructor
protected	AbstractMultiColumnCommand(ILayer layer, int... columnPositions)

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>	getColumnPositions()
int[]	getColumnPositionsArray()
protected final void	setColumnPositions(ILayer layer, int... columnPositions)

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

Field Details

columnPositionCoordinates

protected Collection<ColumnPositionCoordinate> columnPositionCoordinates

Constructor Details

AbstractMultiColumnCommand

protected AbstractMultiColumnCommand(ILayer layer,
 int... columnPositions)

Parameters:

layer - The ILayer to which the positions match.

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

AbstractMultiColumnCommand

protected AbstractMultiColumnCommand(AbstractMultiColumnCommand command)

Clone constructor

Parameters:

command - The command to clone.

Method Details

getColumnPositions

public Collection<Integer> getColumnPositions()

Returns:

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

getColumnPositionsArray

public int[] getColumnPositionsArray()

Returns:

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

Since:

2.0

setColumnPositions

protected final void setColumnPositions(ILayer layer,
 int... columnPositions)

Parameters:

layer - The ILayer to which the positions match.

columnPositions - 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.