FdcGridController class
Public runtime command surface for an FdcGrid.
The controller is available in the Community package because it owns neutral grid commands such as focusing columns, showing or hiding columns, clearing filters, clearing sorting, and resetting the current grid layout. Pro features can attach additional grid configuration and command extensions through the grid widget rather than through this constructor.
- Inheritance
-
- Object
- FdcGridControllerFeature
- FdcGridController
Constructors
- FdcGridController()
- Creates a FdcGridController.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAttached → bool
-
Whether this controller is currently attached to a live grid instance.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
attach(
{required FdcGridLayoutSnapshot capture(), required void restore(FdcGridLayoutSnapshot snapshot), required void reset(), required bool focusColumn(String columnId), required bool setColumnVisible(String columnId, bool visible), required Future< bool> clearFilters(), required bool showFilters(), required Future<bool> hideFilters(), required Future<bool> clearSorting(), required bool expandDetailRow({int? rowIndex}), required bool collapseDetailRow({int? rowIndex}), required bool collapseAllDetailRows(), required bool clearRangeSelection(), required Future<void> saveLayout(), required Future<bool> loadLayout(), required Future<void> deleteLayout(), required void layoutChanged()}) → void -
Connects the feature to one live grid and supplies its command delegates.
override
-
clearFilters(
) → Future< bool> - Clears all grid-managed column filters and rebuilds the dataset view.
-
clearSorting(
) → Future< bool> - Clears grid-managed sorting and rebuilds the dataset view.
-
detach(
) → void -
Disconnects the feature from its current grid attachment.
override
-
dispose(
) → void - Detaches this controller and prevents it from being attached again.
-
focusColumn(
String columnId) → bool -
Moves grid focus to the column identified by
columnId. -
hideColumn(
String columnId) → bool -
Hides the column identified by
columnId. -
hideFilters(
) → Future< bool> - Hides the header filter row, applying any required filter-state transition.
-
layoutChanged(
) → void -
Notifies the feature that the current grid layout has changed.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resetLayout(
) → Future< void> - Restores the grid to its configured default layout and deletes any persisted snapshot.
-
showColumn(
String columnId) → bool -
Makes the column identified by
columnIdvisible. -
showFilters(
) → bool - Shows the grid header filter row.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited