Package org.jdesktop.swingx.sort

Class SortUtils

java.lang.Object

org.jdesktop.swingx.sort.SortUtils

public class SortUtils
extends Object

Collection of convenience methods.

Method Summary

Modifier and Type	Method	Description
static RowSorter.SortKey	getFirstSortingKey(List<? extends RowSorter.SortKey> keys)	Returns the first SortKey in the list which is sorted.
static RowSorter.SortKey	getFirstSortKeyForColumn(List<? extends RowSorter.SortKey> keys, int modelColumn)	Returns the first SortKey in the list for the given column, or null if the column has no SortKey.
static boolean	isAscending(SortOrder sortOrder)	Convenience to check for ascending sort order.
static boolean	isSorted(SortOrder sortOrder)
static boolean	isSorted(SortOrder sortOrder, boolean ascending)
static RowSorter.SortKey	removeFirstSortKeyForColumn(List<? extends RowSorter.SortKey> keys, int modelColumn)	Removes and returns the first SortKey in the list for the given column, or null if the column has no SortKey.

Methods inherited from class java.lang.Object

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

Method Detail

getFirstSortingKey

public static RowSorter.SortKey getFirstSortingKey(List<? extends RowSorter.SortKey> keys)

Returns the first SortKey in the list which is sorted. If none is sorted, null is returned.

Parameters:

keys - a list of SortKeys to search

Returns:

the first SortKey which is sorted or null, if no is found.

getFirstSortKeyForColumn

public static RowSorter.SortKey getFirstSortKeyForColumn(List<? extends RowSorter.SortKey> keys,
                                                         int modelColumn)

Returns the first SortKey in the list for the given column, or null if the column has no SortKey.

Parameters:

keys - a list of SortKeys to search

modelColumn - the column index in model coordinates

Returns:

the first SortKey for the given column or null if none is found.

removeFirstSortKeyForColumn

public static RowSorter.SortKey removeFirstSortKeyForColumn(List<? extends RowSorter.SortKey> keys,
                                                            int modelColumn)

Removes and returns the first SortKey in the list for the given column, or null if the column has no SortKey.

Parameters:

keys - a list of SortKeys to search

modelColumn - the column index in model coordinates

Returns:

the first SortKey for the given column or null if none is found.

isSorted

public static boolean isSorted(SortOrder sortOrder)

isAscending

public static boolean isAscending(SortOrder sortOrder)

Convenience to check for ascending sort order. PENDING: is this helpful at all?

Returns:

true if ascendingly sorted, false for unsorted/descending.

isSorted

public static boolean isSorted(SortOrder sortOrder,
                               boolean ascending)