org.eclipse.nebula.widgets.nattable.group

Class RowGroupUtils

java.lang.Object

org.eclipse.nebula.widgets.nattable.group.RowGroupUtils

public class RowGroupUtils
extends Object

The utility methods in this class bridge the divide between the world of row indexes and positions and row objects used the model.

Author:

Stefan Bolton, Matt Biggs

Constructor Summary

Constructors

Constructor and Description
RowGroupUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> IRowGroup<T>	getOwnRowGroupForRowIndex(IRowGroupModel<T> model, int rowIndex)
static <T> IRowGroup<T>	getRowGroupForRowIndex(IRowGroupModel<T> model, int rowIndex)
static <T> String	getRowGroupNameForIndex(IRowGroupModel<T> model, int bodyRowIndex)
static <T> List<Integer>	getRowIndexesInGroup(IRowGroupModel<T> model, int rowIndex)
static <T> List<Integer>	getRowIndexesInGroup(IRowGroupModel<T> model, IRowGroup<T> group, boolean includeStatic)
static List<Integer>	getRowPositionsInGroup(IUniqueIndexLayer layer, Collection<Integer> bodyRowIndexes) Helper method to get the row positions for a specified layer If a row is currently invisible (-1) it will not be returned within the collection
static <T> IRowGroup<T>	getTopMostParentGroup(IRowGroup<T> rowGroup) Return the top-most parent group of the group specified, or the group specified if it has no parents.
static <T> boolean	isAnyParentCollapsed(IRowGroup<T> group) Returns true if any of the groups parent groups is collapsed.
static <T> boolean	isCollapsed(IRowGroupModel<T> model, IRowGroup<T> group)
static <T> boolean	isInTheSameGroup(int fromRowIndex, int toRowIndex, IRowGroupModel<T> model)
static <T> boolean	isPartOfAGroup(IRowGroupModel<T> model, int rowIndex)
static boolean	isRowIndexHiddenInUnderLyingLayer(int rowIndex, ILayer layer, IUniqueIndexLayer underlyingLayer)
static <T> boolean	isStaticRow(IRowGroupModel<T> model, int bodyRowIndex)
static <T> int	sizeOfGroup(IRowGroupModel<T> model, int bodyRowIndex) Number of rows in the Group which the bodyRowIndex belongs to.

Methods inherited from class java.lang.Object

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

Constructor Detail

RowGroupUtils

public RowGroupUtils()

Method Detail

getRowGroupForRowIndex

public static <T> IRowGroup<T> getRowGroupForRowIndex(IRowGroupModel<T> model,
                                      int rowIndex)

getOwnRowGroupForRowIndex

public static <T> IRowGroup<T> getOwnRowGroupForRowIndex(IRowGroupModel<T> model,
                                         int rowIndex)

isPartOfAGroup

public static <T> boolean isPartOfAGroup(IRowGroupModel<T> model,
                         int rowIndex)

isInTheSameGroup

public static <T> boolean isInTheSameGroup(int fromRowIndex,
                           int toRowIndex,
                           IRowGroupModel<T> model)

isCollapsed

public static <T> boolean isCollapsed(IRowGroupModel<T> model,
                      IRowGroup<T> group)

Returns:

TRUE if the row group this index belongs to is collapsed or one of it's parent groups is collapsed.

isAnyParentCollapsed

public static <T> boolean isAnyParentCollapsed(IRowGroup<T> group)

Returns true if any of the groups parent groups is collapsed.

sizeOfGroup

public static <T> int sizeOfGroup(IRowGroupModel<T> model,
                  int bodyRowIndex)

Number of rows in the Group which the bodyRowIndex belongs to.

getTopMostParentGroup

public static <T> IRowGroup<T> getTopMostParentGroup(IRowGroup<T> rowGroup)

Return the top-most parent group of the group specified, or the group specified if it has no parents.

isStaticRow

public static <T> boolean isStaticRow(IRowGroupModel<T> model,
                      int bodyRowIndex)

Returns:

TRUE if bodyRowIndex is contained in the list of static rows of the row group this index belongs to

isRowIndexHiddenInUnderLyingLayer

public static boolean isRowIndexHiddenInUnderLyingLayer(int rowIndex,
                                        ILayer layer,
                                        IUniqueIndexLayer underlyingLayer)

getRowPositionsInGroup

public static List<Integer> getRowPositionsInGroup(IUniqueIndexLayer layer,
                                   Collection<Integer> bodyRowIndexes)

Helper method to get the row positions for a specified layer If a row is currently invisible (-1) it will not be returned within the collection

Parameters:

layer -

bodyRowIndexes -

Returns:

getRowIndexesInGroup

public static <T> List<Integer> getRowIndexesInGroup(IRowGroupModel<T> model,
                                     int rowIndex)

Returns:

Unmodifiable list of row indexes and static row indexes in the same group as this index

getRowIndexesInGroup

public static <T> List<Integer> getRowIndexesInGroup(IRowGroupModel<T> model,
                                     IRowGroup<T> group,
                                     boolean includeStatic)

getRowGroupNameForIndex

public static <T> String getRowGroupNameForIndex(IRowGroupModel<T> model,
                                 int bodyRowIndex)