FdcDataSetSorts class
Dataset-level sort API.
The dataset owns exactly one active sorted view. This object is the
public entry point for replacing, clearing and fluently building that active
sort definition. Built fluent expressions are applied only when apply()
is called. Direct command methods such as set, clear and toggleBy
still rebuild the dataset view immediately.
Properties
- active → bool
-
True when the owning dataset has active sorts.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether no dataset sort descriptors are active.
no setter
- isNotEmpty → bool
-
Whether at least one dataset sort descriptor is active.
no setter
-
items
→ List<
FdcDataSetSort> -
Active dataset sort descriptors in priority order.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clear(
{bool notify = true}) → Future< bool> - Clears the active dataset sort and rebuilds the dataset view.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
set(
List< FdcDataSetSort> sorts, {bool notify = true}) → Future<bool> - Replaces the active dataset sort and rebuilds the dataset view.
-
sortBy(
String fieldName) → FdcSortOrderStep - Starts a fluent multi-field sort expression.
-
toggleBy(
String fieldName) → Future< bool> - Toggles single-field sorting between ascending and descending order.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited