FdcGridHost class
Extension-facing host interface for integrating optional grid features.
Add-on packages use the host to attach feature behavior without exposing the grid runtime implementation as public API.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FdcGridHost
- Implementers
Constructors
-
FdcGridHost({Key? key, List<
FdcGridColumn> columns = const <FdcGridColumn<dynamic>>[], required FdcDataSet dataSet, FdcGridOptions options = const FdcGridOptions(), FdcGridHeader header = const FdcGridHeader(), FdcGridRowIndicator rowIndicator = const FdcGridRowIndicator(), FdcGridCellIndicator cellIndicator = const FdcGridCellIndicator(), FdcGridToolbar toolbar = const FdcGridToolbar(), FdcGridSummary summary = const FdcGridSummary(), FdcGridStatusBar statusBar = const FdcGridStatusBar(), FdcGridThemeData? theme, FdcGridStyle style = const FdcGridStyle(), FdcFormatSettings? formatSettings, List<FdcGridColumnGroup> columnGroups = const <FdcGridColumnGroup>[], FdcGridColumnPinning pinning = const FdcGridColumnPinning(), FdcGridCellChanged? onCellChanged, FdcGridCellPointerEvent? onCellTapDown, FdcGridCellPointerEvent? onCellDoubleTap, FdcGridRowFocusEvent? onRowExit, FdcGridRowFocusEvent? onRowEnter, FdcGridColumnFocusEvent? onColumnExit, FdcGridColumnFocusEvent? onColumnEnter, FdcGridCellFocusEvent? onCellExit, FdcGridCellFocusEvent? onCellEnter, FdcGridCanEditRow? canEditRow, FdcGridCanEditColumn? canEditColumn, FdcGridDetailRowFeature? detailRow, FdcGridControllerFeature? controller, FdcGridLayoutPersistenceFeature? layoutPersistence, FdcGridRangeSelectionFeature? rangeSelection}) -
Creates a FdcGridHost.
const
Properties
- canEditColumn → FdcGridCanEditColumn?
-
Optional runtime predicate that can veto editing for a row/column pair.
final
- canEditRow → FdcGridCanEditRow?
-
Optional runtime predicate that can veto editing for a visual row.
final
- cellIndicator → FdcGridCellIndicator
-
Active cell indicator component configuration.
final
-
columnGroups
→ List<
FdcGridColumnGroup> -
Optional visual column groups rendered as an additional header row.
final
-
columns
→ List<
FdcGridColumn> -
Ordered column definitions rendered by the grid.
final
- controller → FdcGridControllerFeature?
-
Optional grid controller integration.
final
- dataSet → FdcDataSet
-
Dataset associated with this object.
final
- detailRow → FdcGridDetailRowFeature?
-
Optional expandable detail-row integration.
final
- formatSettings → FdcFormatSettings?
-
Optional explicit format settings for this grid.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- header → FdcGridHeader
-
Header component configuration.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- layoutPersistence → FdcGridLayoutPersistenceFeature?
-
Optional grid layout persistence integration.
final
-
Default body-cell context menu builder. Column-level builders override it.
final
- onCellChanged → FdcGridCellChanged?
-
Called after a grid-originated field write has been accepted locally.
final
- onCellDoubleTap → FdcGridCellPointerEvent?
-
Called when a body cell is double-clicked or double-tapped.
final
- onCellEnter → FdcGridCellFocusEvent?
-
Called when grid focus enters a visual cell.
final
- onCellExit → FdcGridCellFocusEvent?
-
Called when grid focus leaves a visual cell.
final
- onCellTapDown → FdcGridCellPointerEvent?
-
Called when a pointer goes down on a body cell.
final
- onColumnEnter → FdcGridCellFocusEvent?
-
Called when grid focus enters a visual column.
final
- onColumnExit → FdcGridCellFocusEvent?
-
Called when grid focus leaves a visual column.
final
- onRowEnter → FdcGridCellFocusEvent?
-
Called when grid focus enters a visual row.
final
- onRowExit → FdcGridCellFocusEvent?
-
Called when grid focus leaves a visual row.
final
- options → FdcGridOptions
-
Options used by this configuration.
final
- pinning → FdcGridColumnPinning
-
Column pinning behavior and optional pinned-band group labels.
final
- rangeSelection → FdcGridRangeSelectionFeature?
-
Optional range-selection configuration.
final
- rowIndicator → FdcGridRowIndicator
-
Row indicator component configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- statusBar → FdcGridStatusBar
-
Status bar component configuration.
final
- style → FdcGridStyle
-
Grid-level visual style overrides applied on top of the resolved theme.
final
- summary → FdcGridSummary
-
Summary component configuration.
final
- theme → FdcGridThemeData?
-
Optional complete visual theme preset for this grid.
final
- toolbar → FdcGridToolbar
-
Toolbar component configuration.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< FdcGridHost> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited