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

Class AbstractColumnCommand

java.lang.Object

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

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

ClearFilterCommand, ColumnGroupExpandCollapseCommand, ColumnGroupReorderEndCommand, ColumnGroupReorderStartCommand, ColumnHideCommand, ColumnResizeCommand, ColumnShowCommand, DisplayColumnGroupRenameDialogCommand, DisplayColumnRenameDialogCommand, FreezeColumnCommand, InitializeAutoResizeColumnsCommand, RenameColumnHeaderCommand, SortColumnCommand, ViewportSelectColumnCommand, ViewportSelectColumnGroupCommand

public abstract class AbstractColumnCommand
extends Object
implements ILayerCommand

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

Constructor Summary

Constructors

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

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()
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 Detail

AbstractColumnCommand

protected AbstractColumnCommand(ILayer layer,
                                int columnPosition)

Parameters:

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

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

AbstractColumnCommand

protected AbstractColumnCommand(AbstractColumnCommand command)

Clone constructor.

Parameters:

command - The command to clone.

Method Detail

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.

getColumnPosition

public int getColumnPosition()

Returns:

The column position for which the command should be processed.

toString

public String toString()

Overrides:

toString in class Object