HeaderColumn class
A class representing a header column
Constructors
-
HeaderColumn({required Widget widget, Widget? autoSizeWidget, ColumnAutoSize? autoSize, double? autoSizeWidth, ColumnAutoSizeWidthBuilder? autoSizeWidthBuilder, required String textVisibilityDialog, required ValueNotifier<
double?> width, double minimumWidth = 50.0, double? maximumWidth, int height = 55, required ValueNotifier<bool> visible, bool resizable = true, int? combinedColumns, required ValueNotifier<bool> pinLeft, required ValueNotifier<bool> pinRight, bool canHide = true, bool sortable = false, bool filterable = false, TreeDataTableColumnFilterType filterType = TreeDataTableColumnFilterType.text, bool reorderable = true, TreeDataTableSortComparator? sortComparator, int sourceColumnIndex = 0, int? sourceHeaderRowIndex, int? sourceHeaderColumnIndex, List<int?> ? sourceGroupColumnIndexes}) - Creates a new instance of HeaderColumn
Properties
- autoSize ↔ ColumnAutoSize?
-
Best-fit behavior for this leaf column, or
nullwhen disabled.getter/setter pair - autoSizeWidget ↔ Widget
-
Original customer widget used for safe best-fit width estimation.
getter/setter pair
- autoSizeWidth ↔ double?
-
Explicit preferred header content width for best-fit sizing.
getter/setter pair
- autoSizeWidthBuilder ↔ ColumnAutoSizeWidthBuilder?
-
Computes a preferred header content width for best-fit sizing.
getter/setter pair
- canHide ↔ bool
-
Whether this column can be hidden by the user.
getter/setter pair
- combinedColumns ↔ int?
-
The number of columns that this header column combines
into a single header column.
getter/setter pair
- filterable ↔ bool
-
Whether users can filter this leaf column.
getter/setter pair
- filterType ↔ TreeDataTableColumnFilterType
-
Filter editor to show for this column.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- height ↔ int
-
The height of the header column. Defaults to 55
getter/setter pair
- maximumWidth ↔ double?
-
The maximum width of the header and data column.
getter/setter pair
- minimumWidth ↔ double
-
The minimum width of the header and data column. Defaults
to 50.0.
getter/setter pair
-
pinLeft
→ ValueNotifier<
bool> -
All rows for this column will be pinned to the left
final
-
pinRight
→ ValueNotifier<
bool> -
All rows for this column will be pinned to the right
final
- reorderable ↔ bool
-
Whether users can drag this header column to reorder it.
getter/setter pair
- resizable ↔ bool
-
A flag indicating whether the column is resizable by the
user. Only the last header row can be resizable. For that
columns it defaults to true.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sortable ↔ bool
-
Whether users can sort this leaf column.
getter/setter pair
- sortComparator ↔ TreeDataTableSortComparator?
-
Optional comparator for the column's cell sort values.
getter/setter pair
- sourceColumnIndex ↔ int
-
Index of the original leaf column represented by this built column.
getter/setter pair
-
sourceGroupColumnIndexes
↔ List<
int?> -
Source grouped header column covering this leaf for each non-leaf row.
getter/setter pair
- sourceHeaderColumnIndex ↔ int?
-
Source header-column index for grouped header columns.
getter/setter pair
- sourceHeaderRowIndex ↔ int?
-
Source header-row index for grouped header columns.
getter/setter pair
- textVisibilityDialog ↔ String
-
The text to be displayed in the column visibility dialog.
getter/setter pair
-
visible
→ ValueNotifier<
bool> -
A flag indicating whether the header column should be visible
final
- widget ↔ Widget
-
The widget to be displayed in the header column
getter/setter pair
-
width
→ ValueNotifier<
double?> -
The width of the header and data column. Defaults to
auto width. Set null on last row for auto width.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateConfigurationFrom(
HeaderColumn other) → void - Refreshes immutable column definitions while retaining runtime state such as width, visibility, and pinning.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited