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

Class AbstractPositionCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractPositionCommand

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

FreezePositionCommand, HoverStylingCommand, RowPositionHideCommand, SelectCellCommand, SelectColumnCommand, UpdateDataCommand

public abstract class AbstractPositionCommand
extends Object
implements ILayerCommand

ILayerCommand that is executed for a cell position. Transports a PositionCoordinate that is transformed while transported down the layer stack.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPositionCommand(AbstractPositionCommand command)	Clone constructor.
protected	AbstractPositionCommand(ILayer layer, int columnPosition, int rowPosition)

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.
int	getColumnPosition()
ILayer	getLayer()
int	getRowPosition()
String	toString()

Methods inherited from class java.lang.Object

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

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

cloneCommand

Constructor Details

AbstractPositionCommand

protected AbstractPositionCommand(ILayer layer,
 int columnPosition,
 int rowPosition)

Parameters:

layer - The ILayer to which the column and row position correlate.

columnPosition - The column position for which the command should be processed.

rowPosition - The row position for which the command should be processed.

AbstractPositionCommand

protected AbstractPositionCommand(AbstractPositionCommand command)

Clone constructor.

Parameters:

command - The command to clone.

Method Details

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.

getLayer

public ILayer getLayer()

Returns:

The ILayer to which the column and row position correlate.

Since:

1.6

getColumnPosition

public int getColumnPosition()

Returns:

The column position for which the command should be processed.

getRowPosition

public int getRowPosition()

Returns:

The row position for which the command should be processed.

toString

public String toString()

Overrides:

toString in class Object