Class ColumnReorderEndCommand
- java.lang.Object
-
- org.eclipse.nebula.widgets.nattable.reorder.command.ColumnReorderEndCommand
-
- All Implemented Interfaces:
ILayerCommand
- Direct Known Subclasses:
ReorderColumnGroupEndCommand
public class ColumnReorderEndCommand extends Object implements ILayerCommand
Command to finish a column reorder operation. Typically triggered via drag operations.- See Also:
ColumnReorderDragMode
,ColumnReorderStartCommand
-
-
Constructor Summary
Constructors Modifier Constructor Description ColumnReorderEndCommand(ILayer layer, int toColumnPosition)
protected
ColumnReorderEndCommand(ColumnReorderEndCommand command)
Clone constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColumnReorderEndCommand
cloneCommand()
Same semantics asObject.clone()
Used to make a copies of the command if has to passed to different layer stacks.boolean
convertToTargetLayer(ILayer targetLayer)
Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.int
getToColumnPosition()
boolean
isReorderToLeftEdge()
void
toggleCoordinateByEdge()
Toggles the coordinate from left edge to right edge and vice versa.void
updateToColumnPosition(int toPosition)
-
-
-
Constructor Detail
-
ColumnReorderEndCommand
public ColumnReorderEndCommand(ILayer layer, int toColumnPosition)
- Parameters:
layer
- The layer to which the column positions match.toColumnPosition
- The target column position to reorder to.
-
ColumnReorderEndCommand
protected ColumnReorderEndCommand(ColumnReorderEndCommand command)
Clone constructor.- Parameters:
command
- The command to clone.
-
-
Method Detail
-
getToColumnPosition
public int getToColumnPosition()
- Returns:
- The column position to which the column should be reordered to.
-
updateToColumnPosition
public void updateToColumnPosition(int toPosition)
- Parameters:
toPosition
- The new toColumnPosition.- Since:
- 1.6
-
toggleCoordinateByEdge
public void toggleCoordinateByEdge()
Toggles the coordinate from left edge to right edge and vice versa. Will not toggle if the coordinate is right edge of the last column or the left edge of the first column.- Since:
- 1.6
-
isReorderToLeftEdge
public boolean isReorderToLeftEdge()
- Returns:
true
if the reorder operation should be done on the left edge of the toColumnPosition,false
if it should be reordered to the right edge.
-
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 interfaceILayerCommand
- Parameters:
targetLayer
- the target layer- Returns:
- true if the command is valid after conversion, false if the command is no longer valid.
-
cloneCommand
public ColumnReorderEndCommand cloneCommand()
Description copied from interface:ILayerCommand
Same semantics asObject.clone()
Used to make a copies of the command if has to passed to different layer stacks.- Specified by:
cloneCommand
in interfaceILayerCommand
- Returns:
- a cloned instance of the command
- See Also:
GridLayer.doCommand(ILayerCommand)
-
-