Class ShowColumnInViewportCommand

java.lang.Object
org.eclipse.nebula.widgets.nattable.command.AbstractColumnCommand
org.eclipse.nebula.widgets.nattable.viewport.command.ShowColumnInViewportCommand
All Implemented Interfaces:
ILayerCommand

public class ShowColumnInViewportCommand extends AbstractColumnCommand
Command to show a column position in the viewport.
  • Constructor Details

    • ShowColumnInViewportCommand

      public ShowColumnInViewportCommand(int columnPosition)
      Create a command with a fixed column position based on the underlying layer of the ViewportLayer that does not get converted while processing.
      Parameters:
      columnPosition - The column position in the underlying layer of the ViewportLayer that should be shown in the viewport.
      Since:
      1.6
    • ShowColumnInViewportCommand

      public ShowColumnInViewportCommand(ILayer layer, int columnPosition)
      Create a command with a ColumnPositionCoordinate that gets converted while processing down the layer stack.
      Parameters:
      layer - The ILayer to which the column position correlate.
      columnPosition - The column position related to the given layer for which the command should be processed.
      Since:
      2.1
    • ShowColumnInViewportCommand

      protected ShowColumnInViewportCommand(ShowColumnInViewportCommand command)
      Clone constructor.
      Parameters:
      command - The command to clone.
      Since:
      2.1
  • Method Details

    • getColumnPosition

      public int getColumnPosition()
      Overrides:
      getColumnPosition in class AbstractColumnCommand
      Returns:
      The column position in the layer below the ViewportLayer to be shown or the column position related to the ILayer that was passed at command creation.
    • 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 AbstractColumnCommand
      Parameters:
      targetLayer - the target layer
      Returns:
      true if the command is valid after conversion, false if the command is no longer valid.
    • cloneCommand

      public ILayerCommand 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.
      Returns:
      a cloned instance of the command
      See Also: