com.klg.jclass.higrid
Class SortGrid

java.lang.Object
  |
  +--com.klg.jclass.higrid.SortGrid

All Implemented Interfaces:

Serializable

public class SortGrid

extends Object

implements Serializable

Sort the grid rows by specified columns.

See Also:

Serialized Form

Field Summary

static int	ASCENDING
static int	DESCENDING
protected com.klg.jclass.higrid.HiGrid	grid
static int	UNKNOWN
protected boolean	useDefaultSortData

Constructor Summary

SortGrid(com.klg.jclass.higrid.HiGrid grid, boolean useDefaultSortData)
Constructor

Method Summary

protected void	addRepeatHeaders(com.klg.jclass.higrid.RowTree rowTree, com.klg.jclass.higrid.RowNode parentNode, com.klg.jclass.higrid.FormatNode formatNode) Add possible repeat headers in data table.
com.klg.jclass.higrid.SortData	getDataTableSortData(com.klg.jclass.higrid.FormatNode node, com.klg.jclass.higrid.CellPosition cell) Get the sort data for a single data table based on what is on the sort list and what column is to be sorted.
Comparator	getSortable(com.klg.jclass.higrid.FormatNode node, String columnName) Returns the current Comparator for the specified column.
protected void	resetRowData(com.klg.jclass.higrid.RowTree rowTree, com.klg.jclass.higrid.RowNode parentNode, com.klg.jclass.higrid.FormatNode formatNode, Vector rowData) Given a sorted list of row data, reset the row tree.
static void	setDefaultSortData(com.klg.jclass.higrid.FormatNode node, String columnName) Set the default sort data based on what column is to be sorted.
protected void	setInternalData(com.klg.jclass.datasource.DataTableModel dataModel, com.klg.jclass.higrid.SortData sortData)
protected Vector	setupRowData(com.klg.jclass.higrid.RowTree rowTree, com.klg.jclass.higrid.RowNode parentNode, com.klg.jclass.higrid.FormatNode formatNode, String[] columns) Setup a Vector of row data for a given parent and format node.
void	sortColumn(com.klg.jclass.higrid.CellPosition cell, boolean singleTableSort) Perform the sorting for a column.
protected void	sortColumn(com.klg.jclass.higrid.FormatNode node, com.klg.jclass.higrid.RowNode rowNode) Perform the sorting for a column.
protected void	sortColumn(com.klg.jclass.higrid.FormatNode node, com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.SortData sortData) Perform the sorting for a column given the sortData.
boolean	sortDataTable(com.klg.jclass.higrid.RowTree rowTree, com.klg.jclass.higrid.RowNode parentNode, com.klg.jclass.higrid.FormatNode formatNode, String[] columns, int[] directions, Comparator sortable) Sorts a given data table by multiple columns.
boolean	sortDataTable(com.klg.jclass.higrid.RowTree rowTree, com.klg.jclass.higrid.RowNode parentNode, com.klg.jclass.higrid.FormatNode formatNode, String column, int direction, Comparator sortable) Sorts a given data table for a single column and direction.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

ASCENDING

public static final int ASCENDING

See Also:

Constant Field Values

DESCENDING

public static final int DESCENDING

See Also:

Constant Field Values

grid

protected com.klg.jclass.higrid.HiGrid grid

useDefaultSortData

protected boolean useDefaultSortData

Constructor Detail

SortGrid

public SortGrid(com.klg.jclass.higrid.HiGrid grid,
                boolean useDefaultSortData)

Constructor

Parameters:

grid - the HiGrid

useDefaultSortData - true if the default SortData is to be used

Method Detail

getSortable

public Comparator getSortable(com.klg.jclass.higrid.FormatNode node,
                              String columnName)

Returns the current Comparator for the specified column.

Parameters:

node - The format node.

columnName - The column name.

Since:

JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this field's or method's return type is based on the corresponding com.sun.java.util.collections.Comparator class.

setInternalData

protected void setInternalData(com.klg.jclass.datasource.DataTableModel dataModel,
                               com.klg.jclass.higrid.SortData sortData)

sortColumn

protected void sortColumn(com.klg.jclass.higrid.FormatNode node,
                          com.klg.jclass.higrid.RowNode rowNode)

Perform the sorting for a column. Assume using a default sort data and only a single data table is sorted.

Parameters:

node - The format node.

rowNode - The row node within the data table.

sortColumn

public void sortColumn(com.klg.jclass.higrid.CellPosition cell,
                       boolean singleTableSort)

Perform the sorting for a column.

Parameters:

cell - The cell position.

singleTableSort - Indication to sort a data table only.

sortColumn

protected void sortColumn(com.klg.jclass.higrid.FormatNode node,
                          com.klg.jclass.higrid.RowNode rowNode,
                          com.klg.jclass.higrid.SortData sortData)

Perform the sorting for a column given the sortData.

Parameters:

node - The format node.

rowNode - The row node within the data table.

sortData - The sortData.

setDefaultSortData

public static void setDefaultSortData(com.klg.jclass.higrid.FormatNode node,
                                      String columnName)

Set the default sort data based on what column is to be sorted.

Parameters:

node - The format node.

columnName - The name of the selected column.

getDataTableSortData

public com.klg.jclass.higrid.SortData getDataTableSortData(com.klg.jclass.higrid.FormatNode node,
                                                           com.klg.jclass.higrid.CellPosition cell)

Get the sort data for a single data table based on what is on the sort list and what column is to be sorted.

Parameters:

node - The format node.

cell - The cell of the selected column.

Returns:

The sort data.

sortDataTable

public boolean sortDataTable(com.klg.jclass.higrid.RowTree rowTree,
                             com.klg.jclass.higrid.RowNode parentNode,
                             com.klg.jclass.higrid.FormatNode formatNode,
                             String column,
                             int direction,
                             Comparator sortable)

Sorts a given data table for a single column and direction.

Parameters:

rowTree - The row tree.

parentNode - The parent row node.

formatNode - The format node.

column - The column id.

direction - The sorting direction.

sortable - The sortable interface.

Returns:

true if sort was not cancelled

Since:

JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this method's parameter must be a com.sun.java.util.collections.Comparator.

sortDataTable

public boolean sortDataTable(com.klg.jclass.higrid.RowTree rowTree,
                             com.klg.jclass.higrid.RowNode parentNode,
                             com.klg.jclass.higrid.FormatNode formatNode,
                             String[] columns,
                             int[] directions,
                             Comparator sortable)

Sorts a given data table by multiple columns.

Parameters:

rowTree - The row tree.

parentNode - The parent row node.

formatNode - The format node.

columns - Array of column ids.

directions - Array of sorting direction.

sortable - The sortable interface.

Returns:

true if sort was not cancelled

Since:

JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this method's parameter must be a com.sun.java.util.collections.Comparator.

setupRowData

protected Vector setupRowData(com.klg.jclass.higrid.RowTree rowTree,
                              com.klg.jclass.higrid.RowNode parentNode,
                              com.klg.jclass.higrid.FormatNode formatNode,
                              String[] columns)

Setup a Vector of row data for a given parent and format node. For performance reasons, possible repeat headers are removed as well.

Parameters:

rowTree - The row tree.

parentNode - The parent row node.

formatNode - The format node.

columns - Array of column ids.

Returns:

The array of row data.

resetRowData

protected void resetRowData(com.klg.jclass.higrid.RowTree rowTree,
                            com.klg.jclass.higrid.RowNode parentNode,
                            com.klg.jclass.higrid.FormatNode formatNode,
                            Vector rowData)

Given a sorted list of row data, reset the row tree.

Parameters:

rowTree - The row tree.

parentNode - The parent row node.

formatNode - The format node.

Returns:

rowData The list of sort row data.

addRepeatHeaders

protected void addRepeatHeaders(com.klg.jclass.higrid.RowTree rowTree,
                                com.klg.jclass.higrid.RowNode parentNode,
                                com.klg.jclass.higrid.FormatNode formatNode)

Add possible repeat headers in data table.

Parameters:

rowTree - The row tree.

parentNode - The parent row node.

formatNode - The format node.