Class FreezeHelper

java.lang.Object
org.eclipse.nebula.widgets.nattable.freeze.FreezeHelper

public final class FreezeHelper extends Object
Helper class to deal with freeze and unfreeze of a NatTable.

This class is intended for internal use only. Consider using the appropriate commands instead of using this helper directly.

See Also:
  • Method Details

    • freeze

      public static void freeze(FreezeLayer freezeLayer, ViewportLayer viewportLayer, PositionCoordinate topLeftPosition, PositionCoordinate bottomRightPosition)
      Freezes the grid at the specified position. This method is for internal use. Consider using the appropriate commands on the NatTable instead to freeze the grid programmatically.
      Parameters:
      freezeLayer - The FreezeLayer of the grid to perform the freeze action.
      viewportLayer - The ViewportLayer of the grid to perform the freeze action.
      topLeftPosition - The top left position of the freeze area
      bottomRightPosition - The bottom right position of the freeze area
      See Also:
    • unfreeze

      public static void unfreeze(FreezeLayer freezeLayer, ViewportLayer viewportLayer)
      Unfreezes the grid at the specified position. This method is for internal use. Consider using the appropriate command on the NatTable instead to unfreeze the grid programmatically.
      Parameters:
      freezeLayer - The FreezeLayer of the grid to perform the freeze action.
      viewportLayer - The ViewportLayer of the grid to perform the freeze action.
      See Also:
    • resetViewport

      public static void resetViewport(FreezeLayer freezeLayer, ViewportLayer viewportLayer)
      Helper method to reset the origin coordinates of the viewport. Is needed to perform an unfreeze or to override a current frozen state.
      Parameters:
      freezeLayer - The FreezeLayer of the grid to perform the freeze action.
      viewportLayer - The ViewportLayer of the grid to perform the freeze action.
    • getTopLeftColumnPosition

      public static int getTopLeftColumnPosition(ViewportLayer viewportLayer)
      Helper method to retrieve the top left column position on freezing a column. Will get the column position on the underlying layer of the ViewportLayer based on the origin x coordinate. For the ResizeColumnHideShowLayer a special handling is performed to get the left most column position in case columns to the left are hidden.
      Parameters:
      viewportLayer - The ViewportLayer needed for calculating the top left column position.
      Returns:
      The column position that should be used for the top left coordinate.
      Since:
      1.6