FdcCustomColumn<T> class

Field-bound custom column.

FdcCustomColumn stores and serializes the underlying dataset field value, but lets application code fully customize the cell widget. Search, filters, sorting and export continue to operate on fieldName's dataset value.

Inheritance

Constructors

FdcCustomColumn({required String fieldName, required FdcCustomCellBuilder<T> cellBuilder, List<Type>? allowedFieldTypes, String? id, String? groupId, String? label, String? hint, bool visible = true, bool exportable = true, bool enabled = true, bool readOnly = false, int? focusOrder, bool tabStop = true, double? width, double minWidth = 0, double maxWidth = 0, FdcGridColumnAutoSizeMode autoSizeMode = FdcGridColumnAutoSizeMode.none, bool allowSort = true, FdcColumnFilterConfig? filterConfig, bool allowResize = true, FdcGridHorizontalAlignment? horizontalAlignment, bool showIndicator = true, FdcColumnValueChanging<T>? onValueChanging, FdcColumnValueChanged<T>? onValueChanged, FdcGridCellStyle? cellStyle, FdcGridColumnPin pin = FdcGridColumnPin.none, FdcColumnSummary summary = const FdcColumnSummary(), FdcGridMenuBuilder? menuBuilder})
Creates a field-bound custom column.
const

Properties

allowedFieldTypes → List<Type>?
Optional dataset field definition types accepted by this custom column.
final
allowResize → bool
Whether allow resize.
finalinherited
allowSort → bool
Whether allow sort.
finalinherited
autoSizeMode → FdcGridColumnAutoSizeMode
Automatic width behavior used when the grid viewport changes size.
finalinherited
cellBuilder → FdcCustomCellBuilder<T>
Builds the custom cell widget for the current row.
final
cellStyle → FdcGridCellStyle?
Optional visual overrides applied to body cells in this column.
finalinherited
customCellBuilderSignatureToken → Object?
Internal identity token for custom-cell builder callbacks.
no setter
dataType → FdcDataType
Dataset value type represented by this column.
no setteroverride
effectiveEditor → FdcEditorType
Built-in editor mode used when this column enters edit state.
no setteroverride
enabled → bool
Enables grid-managed filtering for this column.
finalinherited
exportable → bool
Whether this field-bound column participates in grid-driven exports.
finalinherited
fieldName → String
Dataset field name associated with this object.
finalinherited
filterConfig → FdcColumnFilterConfig?
Optional per-column header filter configuration.
finalinherited
filterEnabled → bool
Whether grid-managed filtering is enabled for this column.
no setterinherited
focusOrder → int?
Optional explicit keyboard focus order among focusable grid columns.
finalinherited
groupId → String?
Optional id of the visual column group this column belongs to.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hint → String?
Optional tooltip or contextual hint associated with this column.
finalinherited
horizontalAlignment → FdcGridHorizontalAlignment?
Optional horizontal alignment for the entire column.
finalinherited
id → String?
Stable developer-defined column identity.
finalinherited
isDataBound → bool
Whether this column is backed by a dataset field.
no setterinherited
isEffectivelyReadOnly → bool
True when grid editing is disabled by configuration or column semantics.
no setterinherited
isInherentlyReadOnly → bool
True when the column type itself cannot support grid editing.
no setterinherited
label → String?
Display label shown to the user.
finalinherited
lookupIcon → IconData
Icon used by the focused-cell lookup button.
finalinherited
lookupShortcut → FdcKeyboardShortcut?
Keyboard shortcut that invokes onLookup for the focused cell.
finalinherited
maxWidth → double
Maximum width allowed during layout and resize; zero means no explicit maximum.
finalinherited
Optional body-cell context menu override for this column.
finalinherited
minWidth → double
Minimum width allowed during layout and interactive resize.
finalinherited
onLookup → FdcGridLookup<T>?
Optional asynchronous lookup invoked by the focused-cell lookup button.
finalinherited
onValueChanged → FdcColumnValueChanged<T>?
Optional column-level notification invoked after a value was successfully written for this column.
finalinherited
onValueChanging → FdcColumnValueChanging<T>?
Optional column-level interceptor invoked before values are written into the dataset. Useful for cell-level validation and transformations such as barcode-to-article-code lookup.
finalinherited
pin → FdcGridColumnPin
Initial horizontal pinning mode for this column.
finalinherited
readOnly → bool
Prevents editing through this column while keeping the field visible.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showIndicator → bool
Controls whether this column renders the active-cell indicator overlay.
finalinherited
summary → FdcColumnSummary
Per-column summary row behavior and style.
finalinherited
tabStop → bool
Whether Tab navigation may stop on this column.
finalinherited
visible → bool
Whether the column participates in the current grid layout.
finalinherited
width → double?
Optional initial column width; grid defaults are used when omitted.
finalinherited

Methods

applyValueChanged({required FdcDataSet dataSet, required FdcGridRowContext row, required int rowIndex, required int? columnIndex, required String fieldName, required Object? oldValue, required Object? value}) → void
Invokes onValueChanged using this column's concrete generic value type.
inherited
applyValueChanging({required FdcDataSet dataSet, required FdcGridRowContext row, required int rowIndex, required int columnIndex, required String fieldName, required Object? oldValue, required Object? newValue}) → FdcFieldValueChangeResult<T>?
Invokes onValueChanging using this column's concrete generic value type.
inherited
buildCell({required int rowIndex, required int columnIndex, required Object? value, required FdcCellContext cell, required bool fieldExists(String fieldName), required Object? fieldValueResolver(String fieldName), required bool fieldValueWriter(String fieldName, Object? value), required FdcFieldValueFormatter fieldValueFormatter}) → Widget
Builds a cell context using this column's concrete generic value type.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
validateAdditionalBindings(FdcDataSet dataSet) → void
Validates any additional dataset fields used by a specialized custom column after the primary fieldName binding has been resolved.
validateBinding(FdcDataSet dataSet) → void
Validates this column's dataset field binding for the grid runtime.

Operators

operator ==(Object other) → bool
The equality operator.
inherited