Package org.eclipse.nebula.widgets.nattable.columnChooser

Class ColumnChooserUtils

java.lang.Object

org.eclipse.nebula.widgets.nattable.columnChooser.ColumnChooserUtils

public final class ColumnChooserUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	RENAMED_COLUMN_INDICATOR

Method Summary

Modifier and Type	Method	Description
static boolean	containsIndex(List<ColumnEntry> entries, int indexToFind)
static ColumnEntry	find(List<ColumnEntry> entries, int indexToFind)	Search the collection for the entry with the given index.
static List<Integer>	getColumnEntryIndexes(List<ColumnEntry> columnEntries)	Get ColumnEntry indexes for the ColumnEntry objects.
static List<Integer>	getColumnEntryPositions(List<ColumnEntry> columnEntries)	Get ColumnEntry positions for the ColumnEntry objects.
static String	getColumnLabel(ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer, Integer columnIndex)
static List<ColumnEntry>	getHiddenColumnEntries(ColumnHideShowLayer columnHideShowLayer, ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer)
static List<ColumnEntry>	getVisibleColumnsEntries(ColumnHideShowLayer columnHideShowLayer, ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer)	Get all visible columns and the corresponding labels in the header.
static void	hideColumnEntries(List<ColumnEntry> removedItems, ColumnHideShowLayer hideShowLayer)
static void	hideColumnPositions(List<Integer> removedPositions, ColumnHideShowLayer hideShowLayer)
static void	showColumnEntries(List<ColumnEntry> addedItems, ColumnHideShowLayer hideShowLayer)
static void	showColumnIndexes(List<Integer> addedColumnIndexes, ColumnHideShowLayer hideShowLayer)

Methods inherited from class java.lang.Object

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

Field Detail

RENAMED_COLUMN_INDICATOR

public static final String RENAMED_COLUMN_INDICATOR

See Also:

Constant Field Values

Method Detail

hideColumnEntries

public static void hideColumnEntries(List<ColumnEntry> removedItems,
                                     ColumnHideShowLayer hideShowLayer)

hideColumnPositions

public static void hideColumnPositions(List<Integer> removedPositions,
                                       ColumnHideShowLayer hideShowLayer)

showColumnEntries

public static void showColumnEntries(List<ColumnEntry> addedItems,
                                     ColumnHideShowLayer hideShowLayer)

showColumnIndexes

public static void showColumnIndexes(List<Integer> addedColumnIndexes,
                                     ColumnHideShowLayer hideShowLayer)

getHiddenColumnEntries

public static List<ColumnEntry> getHiddenColumnEntries(ColumnHideShowLayer columnHideShowLayer,
                                                       ColumnHeaderLayer columnHeaderLayer,
                                                       DataLayer columnHeaderDataLayer)

getColumnLabel

public static String getColumnLabel(ColumnHeaderLayer columnHeaderLayer,
                                    DataLayer columnHeaderDataLayer,
                                    Integer columnIndex)

Parameters:

columnHeaderLayer - The ColumnHeaderLayer to retrieve a possible renamed column header label.

columnHeaderDataLayer - The column header DataLayer to retrieve the column header label from.

columnIndex - The column index of the column whose label is requested.

Returns:

The renamed column header name for the given column index (if the column has been renamed), the original column name otherwise.

getVisibleColumnsEntries

public static List<ColumnEntry> getVisibleColumnsEntries(ColumnHideShowLayer columnHideShowLayer,
                                                         ColumnHeaderLayer columnHeaderLayer,
                                                         DataLayer columnHeaderDataLayer)

Get all visible columns and the corresponding labels in the header.

Parameters:

columnHideShowLayer - The ColumnHideShowLayer to get all visible columns.

columnHeaderLayer - The ColumnHeaderLayer to retrieve a possible renamed column header label.

columnHeaderDataLayer - The column header DataLayer to retrieve the column header label from.

Returns:

All visible columns and the corresponding labels in the header.

find

public static ColumnEntry find(List<ColumnEntry> entries,
                               int indexToFind)

Search the collection for the entry with the given index.

Parameters:

entries - The collection of ColumnEntry objects.

indexToFind - The column index to find.

Returns:

The ColumnEntry for the given column index.

getColumnEntryPositions

public static List<Integer> getColumnEntryPositions(List<ColumnEntry> columnEntries)

Get ColumnEntry positions for the ColumnEntry objects.

Parameters:

columnEntries - The ColumnEntry objects.

Returns:

The column positions of the provided ColumnEntry objects.

getColumnEntryIndexes

public static List<Integer> getColumnEntryIndexes(List<ColumnEntry> columnEntries)

Get ColumnEntry indexes for the ColumnEntry objects.

Parameters:

columnEntries - The ColumnEntry objects.

Returns:

The column indexes of the provided ColumnEntry objects.

containsIndex

public static boolean containsIndex(List<ColumnEntry> entries,
                                    int indexToFind)

Parameters:

entries - The collection of ColumnEntry objects.

indexToFind - The column index to find.

Returns:

true if the list contains an entry with the given index.