fdc_ext library

Stable extension seam for FD Components add-on packages.

This library is intended for first-party and compatible extension packages that integrate with selected grid and dataset runtime hooks. Application code should normally import fdc.dart instead.

The exposed contracts cover controller features, layout persistence, detail rows, range selection, menu entries, prepared search, and other host-facing integration points deliberately kept separate from the main Community API.

Classes

FdcDataSetExtensions
Dataset integration seam for extension packages.
FdcGridCellRef
Immutable identity of a grid cell used by selection and navigation logic.
FdcGridColumnLayoutSnapshot
Persisted layout state for one grid column.
FdcGridControllerExtensionApi
Extension-package access to controller layout internals.
FdcGridControllerFeature
Extension contract for attaching optional command surfaces to a grid controller.
FdcGridDetailRowContext
Immutable row identity and dataset context supplied to detail-row callbacks.
FdcGridDetailRowFeature
Detail-row configuration and rendering contract for grid rows.
FdcGridHost
Extension-facing host interface for integrating optional grid features.
FdcGridLayoutPersistenceFeature
Extension contract for loading, saving, and deleting grid layout snapshots.
FdcGridLayoutSnapshot
Serializable snapshot of user-adjustable grid layout state.
FdcGridRangeSelectionContextMenuContext
Context passed when building range-selection context-menu entries.
FdcGridRangeSelectionFeature
Extension contract for grid range-selection behavior.
FdcGridRangeSelectionHost
Read-only and command surface exposed by the Community grid to range-selection features.
FdcGridRangeSelectionOverlayBand
Horizontal viewport band used by the range-selection overlay.
FdcGridRangeSelectionOverlayColumnGeometry
Column geometry snapshot used by the range-selection overlay.
FdcGridRangeSelectionOverlayContext
Viewport layout snapshot used to render the selected range.
FdcGridRangeSelectionSession
Mutable runtime state contract for range selection attached to one grid instance.
FdcMenuAction
A selectable menu entry that invokes an action callback.
FdcMenuEntry
Shared internal menu entry model used by FDC controls.
FdcPreparedDataSetSearch
Precomputed search matcher optimized for repeated record evaluation.

Enums

FdcDataSetState
Current lifecycle/editing state of an FdcDataSet.

Functions

prepareDataSetSearch({required FdcDataSetSearchState search, required List<FdcFieldDef> fields, required Map<String, int> fieldIndexByName, required FdcFormatSettings formatSettings}) FdcPreparedDataSetSearch?
Prepares normalized search state for efficient local dataset evaluation.

Typedefs

FdcGridRangeSelectionBounds = ({List<int> columnIndexes, int firstColumn, int firstRow, int lastColumn, int lastRow})
Normalized rectangular selection bounds in grid row and source-column space.
FdcGridRangeSelectionCellEditablePredicate = bool Function(int rowIndex, int columnIndex)
Reports whether one grid cell may receive a range-paste update.
FdcGridRangeSelectionCellTextParser = ({String? errorText, Object? value}) Function(int rowIndex, int columnIndex, String text)
Parses clipboard text into a value suitable for one destination grid cell.
FdcGridRangeSelectionCellTextReader = String Function(int rowIndex, int columnIndex)
Reads display text for one grid cell during range-copy serialization.
FdcGridRangeSelectionContextMenuBuilder = List<FdcMenuEntry> Function(BuildContext context, FdcGridRangeSelectionContextMenuContext menuContext)
Builds menu entries for the current range-selection context.
FdcGridRangeSelectionOverlayBuilder = Widget Function(BuildContext context, FdcGridRangeSelectionOverlayContext overlayContext)
Builds the visual overlay for an attached range-selection session.
FdcGridRangeSelectionPastePlan = ({String? errorText, List<FdcGridRangeSelectionPasteUpdate> updates})
Result of validating clipboard content against the current selected range.
FdcGridRangeSelectionPasteUpdate = ({int columnIndex, int rowIndex, Object? value})
One validated cell assignment produced by a range-paste operation.
FdcGridRangeSelectionRowTopResolver = double Function(int rowIndex)
Resolves the top edge of a data row in vertical grid content coordinates.