com.canto.cumulus.events

Class CollectionSortingChangedEventObject<_Source>

java.lang.Object

java.util.EventObject

com.canto.cumulus.events.BaseEventObject<_Source,CollectionListener<_Source>>

com.canto.cumulus.events.CollectionEventObject<_Source>

com.canto.cumulus.events.CollectionSortingChangedEventObject<_Source>

All Implemented Interfaces:

java.io.Serializable

public class CollectionSortingChangedEventObject<_Source>
extends CollectionEventObject<_Source>

The event object for the CollectionListener interface.

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectionSortingChangedEventObject(int catalogID, java.lang.String tableName, boolean isSorted, int freeSortDirection, GUID[] sortedFields, int[] sortDirections) Internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDirection() Return the current sort direction.
GUID	getFieldUID() Return the field that the collection was sorted.
java.util.List<SortFieldDescriptor>	getSortFieldDescriptors() Return the descriptors for the sorting fields that the collection was sorted by.
boolean	isSorted() Return whether the collection is sorted by a specific field.

Methods inherited from class com.canto.cumulus.events.CollectionEventObject

getCatalogID, getTableName

Methods inherited from class com.canto.cumulus.events.BaseEventObject

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionSortingChangedEventObject

public CollectionSortingChangedEventObject(int catalogID,
                                   java.lang.String tableName,
                                   boolean isSorted,
                                   int freeSortDirection,
                                   GUID[] sortedFields,
                                   int[] sortDirections)

Internal use only.

Method Detail

getDirection

public int getDirection()

Return the current sort direction.

Returns:

the sort direction.

getFieldUID

public GUID getFieldUID()

Return the field that the collection was sorted.

Returns:

the unique ID of the sorting field.

isSorted

public boolean isSorted()

Return whether the collection is sorted by a specific field.

Returns:

true if the collection is sorted by a filed, false otherwise.

getSortFieldDescriptors

public java.util.List<SortFieldDescriptor> getSortFieldDescriptors()

Return the descriptors for the sorting fields that the collection was sorted by. Each entry in the list describes the field and the sorting direction for the given field.

Returns:

descriptors for the sorting fields

Since:

8.1