com.sencha.gxt.data.shared

Class Store.StoreSortInfo<M>

java.lang.Object

com.sencha.gxt.data.shared.Store.StoreSortInfo<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

Comparator<M>

Enclosing class:

Store<M>

public static class Store.StoreSortInfo<M>
extends Object
implements Comparator<M>

Sort information for a Store to use. Constructors make it possible to easily sort based on either a property of the items in the store, or sort the items themselves. Sort direction may be changed after creation, but the comparator is fixed. A new StoreSortInfo object must be created to change the comparator.

Constructor Summary

Constructors

Constructor and Description
Store.StoreSortInfo(Comparator<? super M> itemComparator, SortDir direction) Creates a sort info object based on the given comparator to act on the item itself.
Store.StoreSortInfo(ValueProvider<? super M,V> property, Comparator<? super V> itemComparator, SortDir direction) Creates a sort info object to act on a property of the items and a custom comparator for that property's type.
Store.StoreSortInfo(ValueProvider<? super M,V> property, SortDir direction) Convenience constructor for sorting based on a Comparable property of items in the store.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(M o1, M o2)
SortDir	getDirection() Returns the current sort direction for this sort info.
String	getPath() If the sort info object is configured to act on a property of the items, returns the path that the property's ValueProvider makes available, otherwise returns empty string.
ValueProvider<? super M,?>	getValueProvider() Returns the sort property's ValueProvider.
void	setDirection(SortDir direction) Sets a new sort direction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

Store.StoreSortInfo

public Store.StoreSortInfo(Comparator<? super M> itemComparator,
                   SortDir direction)

Creates a sort info object based on the given comparator to act on the item itself. Complex comparators can easily be built in this way, instead of adding multiple StoreSortInfo objects, or using one of the other constructors.

Parameters:

itemComparator - the comparator to use to sort the items

direction - the sort direction

Store.StoreSortInfo

public Store.StoreSortInfo(ValueProvider<? super M,V> property,
                   Comparator<? super V> itemComparator,
                   SortDir direction)

Creates a sort info object to act on a property of the items and a custom comparator for that property's type.

Type Parameters:

V - the property type

Parameters:

property - the sort property

itemComparator - the comparator to use in the sort

direction - the sort direction

Store.StoreSortInfo

public Store.StoreSortInfo(ValueProvider<? super M,V> property,
                   SortDir direction)

Convenience constructor for sorting based on a Comparable property of items in the store.

Type Parameters:

V - the property type

Parameters:

property - the sort property

direction - the sort direction

Method Detail

compare

public int compare(M o1,
          M o2)

Specified by:

compare in interface Comparator<M>

getDirection

public SortDir getDirection()

Returns the current sort direction for this sort info.

Returns:

the current sort direction

getPath

public String getPath()

If the sort info object is configured to act on a property of the items, returns the path that the property's ValueProvider makes available, otherwise returns empty string.

Returns:

the path for the property value provider or empty string if no value provider is configured

getValueProvider

public ValueProvider<? super M,?> getValueProvider()

Returns the sort property's ValueProvider.

Returns:

the sort property's ValueProvider or null if one has not been configured

setDirection

public void setDirection(SortDir direction)

Sets a new sort direction. Will not take effect until Store.applySort(boolean) is called on the store containing the sort info.

Parameters:

direction - the sort direction