Class GroupMultiColumnReorderCommand

java.lang.Object
org.eclipse.nebula.widgets.nattable.reorder.command.MultiColumnReorderCommand
org.eclipse.nebula.widgets.nattable.group.performance.command.GroupMultiColumnReorderCommand
All Implemented Interfaces:
ILayerCommand

public class GroupMultiColumnReorderCommand extends MultiColumnReorderCommand
Specialization of the MultiColumnReorderCommand that ensures on conversion that the toPosition is between two groups.
Since:
1.6
  • Constructor Details

    • GroupMultiColumnReorderCommand

      public GroupMultiColumnReorderCommand(ILayer layer, List<Integer> fromColumnPositions, int toColumnPosition)
      Parameters:
      layer - The layer to which the column positions match.
      fromColumnPositions - The column positions to reorder.
      toColumnPosition - The target column position to reorder to.
      Since:
      2.0
    • GroupMultiColumnReorderCommand

      public GroupMultiColumnReorderCommand(ILayer layer, List<Integer> fromColumnPositions, int toColumnPosition, boolean reorderToLeftEdge)
      Parameters:
      layer - The layer to which the column positions match.
      fromColumnPositions - The column positions to reorder.
      toColumnPosition - The target column position to reorder to.
      reorderToLeftEdge - 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.
      Since:
      2.0
    • GroupMultiColumnReorderCommand

      public GroupMultiColumnReorderCommand(ILayer layer, int[] fromColumnPositions, int toColumnPosition)
      Parameters:
      layer - The layer to which the column positions match.
      fromColumnPositions - The column positions to reorder.
      toColumnPosition - The target column position to reorder to.
      Since:
      2.0
    • GroupMultiColumnReorderCommand

      public GroupMultiColumnReorderCommand(ILayer layer, int[] fromColumnPositions, int toColumnPosition, boolean reorderToLeftEdge)
      Parameters:
      layer - The layer to which the column positions match.
      fromColumnPositions - The column positions to reorder.
      toColumnPosition - The target column position to reorder to.
      reorderToLeftEdge - 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.
      Since:
      2.0
    • GroupMultiColumnReorderCommand

      protected GroupMultiColumnReorderCommand(GroupMultiColumnReorderCommand 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
      Overrides:
      convertToTargetLayer in class MultiColumnReorderCommand
      Parameters:
      targetLayer - the target layer
      Returns:
      true if the command is valid after conversion, false if the command is no longer valid.
    • setGroupToLeft

      public void setGroupToLeft(GroupModel.Group groupToLeft)
      Parameters:
      groupToLeft - The GroupModel.Group that is left of the toColumnPosition. Needed to calculate the correct position to the right edge of a group in case of hidden columns.
      Since:
      2.0
    • setGroupToRight

      public void setGroupToRight(GroupModel.Group groupToRight)
      Parameters:
      groupToRight - The GroupModel.Group that is at the toColumnPosition. Needed to calculate the correct position to the left edge of a group in case of hidden columns.
      Since:
      2.0
    • cloneCommand

      public GroupMultiColumnReorderCommand cloneCommand()
      Description copied from interface: ILayerCommand
      Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
      Specified by:
      cloneCommand in interface ILayerCommand
      Overrides:
      cloneCommand in class MultiColumnReorderCommand
      Returns:
      a cloned instance of the command
      See Also: