org.eclipse.nebula.widgets.nattable.freeze
Class FreezeHelper

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

public 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.

Author:

Dirk Fauth

See Also:

FreezeColumnCommand, FreezeRowCommand, FreezePositionCommand, FreezeSelectionCommand, UnFreezeGridCommand

Constructor Summary

FreezeHelper()

Method Summary

static void	freeze(FreezeLayer freezeLayer, ViewportLayer viewportLayer, PositionCoordinate topLeftPosition, PositionCoordinate bottomRightPosition) Freezes the grid at the specified position.
static void	resetViewport(FreezeLayer freezeLayer, ViewportLayer viewportLayer) Helper method to reset the origin coordinates of the viewport.
static void	unfreeze(FreezeLayer freezeLayer, ViewportLayer viewportLayer) Unfreezes the grid at the specified position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreezeHelper

public FreezeHelper()

Method Detail

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:

FreezeColumnCommand, FreezeRowCommand, FreezePositionCommand, FreezeSelectionCommand

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:

UnFreezeGridCommand

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.