com.jidesoft.grid
Interface GroupModelProvider

All Known Implementing Classes:

AggregateTableModel, DefaultGroupTableModel

public interface GroupModelProvider

This interface is to provide support to GroupTableHeader.

Since:

3.2.3

Method Summary

int	getGroupColumnAt(int index) Gets the corresponding column index in its actual table model for the designated group column.
int	getGroupColumnCount() Gets the count of group columns.
Object	getGroupColumnIdentifier(int groupColumnIndex) Gets the identifier of the group column index.
int	getGroupColumnOrder(int index) Gets the corresponding column order in its actual table model for the designated group column.
void	groupAndRefresh() Groups the table model and refresh.
boolean	groupColumnsFirst() Gets the flag indicating if group columns should always be displayed at the begging when displayed.
boolean	isColumnGroupable(int columnIndex) Checks if the column is groupable or not.
boolean	isDisplayGroupColumns() Gets the flag indicating if group columns should be displayed.
void	setGroupColumns(int[] columns, int[] orders) Sets the group columns.

Method Detail

getGroupColumnCount

int getGroupColumnCount()

Gets the count of group columns.

Returns:

the column count.

getGroupColumnAt

int getGroupColumnAt(int index)

Gets the corresponding column index in its actual table model for the designated group column.

Parameters:

index - the group column index

Returns:

the corresponding column index in its actual table model

getGroupColumnOrder

int getGroupColumnOrder(int index)

Gets the corresponding column order in its actual table model for the designated group column.

Parameters:

index - the group column index

Returns:

the corresponding column order in its actual table model

setGroupColumns

void setGroupColumns(int[] columns,
                     int[] orders)

Sets the group columns.

Parameters:

columns - the columns array

orders - the orders array

groupAndRefresh

void groupAndRefresh()

Groups the table model and refresh.

isColumnGroupable

boolean isColumnGroupable(int columnIndex)

Checks if the column is groupable or not.

Parameters:

columnIndex - the column index

Returns:

true if the column is groupable. Otherwise false.

isDisplayGroupColumns

boolean isDisplayGroupColumns()

Gets the flag indicating if group columns should be displayed.

Returns:

true if the group columns should be displayed in the native table header. Otherwise false.

groupColumnsFirst

boolean groupColumnsFirst()

Gets the flag indicating if group columns should always be displayed at the begging when displayed.

Returns:

true if the group columns should be displayed in the beginning in the native table header. Otherwise false.

getGroupColumnIdentifier

Object getGroupColumnIdentifier(int groupColumnIndex)

Gets the identifier of the group column index.

Parameters:

groupColumnIndex - the group column index

Returns:

the identifier.

Since:

3.3.0