org.eclipse.nebula.widgets.nattable.group

Class ColumnGroupUtils

java.lang.Object

org.eclipse.nebula.widgets.nattable.group.ColumnGroupUtils

public class ColumnGroupUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ColumnGroupUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static SelectionLayer.MoveDirectionEnum	getMoveDirection(int fromColumnPosition, int toColumnPosition)
static List<Integer>	getVisibleIndexesToTheRight(int columnIndex, ILayer layer, IUniqueIndexLayer underlyingLayer, ColumnGroupModel model) Inclusive of the columnIndex passed as the parameter.
static boolean	isBetweenTwoGroups(ILayer natLayer, int startX, int endX, ColumnGroupModel model)
static boolean	isColumnIndexHiddenInUnderLyingLayer(int columnIndex, ILayer layer, IUniqueIndexLayer underlyingLayer)
static boolean	isColumnPositionHiddenInUnderLyingLayer(int columnPosition, ILayer layer, IUniqueIndexLayer underlyingLayer)
static boolean	isFirstVisibleColumnIndexInGroup(int columnIndex, ILayer layer, IUniqueIndexLayer underlyingLayer, ColumnGroupModel model)
static boolean	isInTheSameGroup(int fromColumnIndex, int toColumnIndex, ColumnGroupModel model)
static boolean	isLastVisibleColumnIndexInGroup(int columnIndex, ILayer layer, IUniqueIndexLayer underlyingLayer, ColumnGroupModel model)
static boolean	isLeftEdgeOfAColumnGroup(ILayer natLayer, int columnPosition, int columnIndex, ColumnGroupModel model) See ColumnGroupUtilsTest
static boolean	isRightEdgeOfAColumnGroup(ILayer natLayer, int columnPosition, int columnIndex, ColumnGroupModel model) See ColumnGroupUtilsTest
static boolean	isStaticOrFirstVisibleColumn(int columnIndex, ILayer layer, IUniqueIndexLayer underlyingLayer, ColumnGroupModel model) Checks whether columnIndex is either a defined static column or (if not) the first visible column in the group containing group.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnGroupUtils

public ColumnGroupUtils()

Method Detail

getMoveDirection

public static SelectionLayer.MoveDirectionEnum getMoveDirection(int fromColumnPosition,
                                                int toColumnPosition)

isInTheSameGroup

public static boolean isInTheSameGroup(int fromColumnIndex,
                       int toColumnIndex,
                       ColumnGroupModel model)

isStaticOrFirstVisibleColumn

public static boolean isStaticOrFirstVisibleColumn(int columnIndex,
                                   ILayer layer,
                                   IUniqueIndexLayer underlyingLayer,
                                   ColumnGroupModel model)

Checks whether columnIndex is either a defined static column or (if not) the first visible column in the group containing group. This method provides downward compatibility for all group definitions without static columns. When no static columns are defined the first visible column will be used.

Parameters:

columnIndex -

layer -

underlyingLayer -

model -

Returns:

TRUE if the given columnIndex is either a defined static column or (if not) the first visible column the it's group

isFirstVisibleColumnIndexInGroup

public static boolean isFirstVisibleColumnIndexInGroup(int columnIndex,
                                       ILayer layer,
                                       IUniqueIndexLayer underlyingLayer,
                                       ColumnGroupModel model)

isLastVisibleColumnIndexInGroup

public static boolean isLastVisibleColumnIndexInGroup(int columnIndex,
                                      ILayer layer,
                                      IUniqueIndexLayer underlyingLayer,
                                      ColumnGroupModel model)

getVisibleIndexesToTheRight

public static List<Integer> getVisibleIndexesToTheRight(int columnIndex,
                                        ILayer layer,
                                        IUniqueIndexLayer underlyingLayer,
                                        ColumnGroupModel model)

Inclusive of the columnIndex passed as the parameter.

isColumnIndexHiddenInUnderLyingLayer

public static boolean isColumnIndexHiddenInUnderLyingLayer(int columnIndex,
                                           ILayer layer,
                                           IUniqueIndexLayer underlyingLayer)

isColumnPositionHiddenInUnderLyingLayer

public static boolean isColumnPositionHiddenInUnderLyingLayer(int columnPosition,
                                              ILayer layer,
                                              IUniqueIndexLayer underlyingLayer)

isRightEdgeOfAColumnGroup

public static boolean isRightEdgeOfAColumnGroup(ILayer natLayer,
                                int columnPosition,
                                int columnIndex,
                                ColumnGroupModel model)

See ColumnGroupUtilsTest

Returns:

TRUE if the given column is the right most column in a group

isLeftEdgeOfAColumnGroup

public static boolean isLeftEdgeOfAColumnGroup(ILayer natLayer,
                               int columnPosition,
                               int columnIndex,
                               ColumnGroupModel model)

See ColumnGroupUtilsTest

Returns:

TRUE if the given column is the left most column in a group

isBetweenTwoGroups

public static boolean isBetweenTwoGroups(ILayer natLayer,
                         int startX,
                         int endX,
                         ColumnGroupModel model)

Returns:

TRUE if there is a column group boundary between startX and endX