PlutoColumn class
Constructors
- PlutoColumn({required String title, required String field, required PlutoColumnType type, bool readOnly = false, PlutoColumnCheckReadOnly? checkReadOnly, double width = PlutoGridSettings.columnWidth, double minWidth = PlutoGridSettings.minColumnWidth, EdgeInsets? titlePadding, EdgeInsets? filterPadding, InlineSpan? titleSpan, EdgeInsets? cellPadding, PlutoColumnTextAlign textAlign = PlutoColumnTextAlign.start, PlutoColumnTextAlign titleTextAlign = PlutoColumnTextAlign.start, PlutoColumnFrozen frozen = PlutoColumnFrozen.none, PlutoColumnSort sort = PlutoColumnSort.none, PlutoColumnValueFormatter? formatter, bool applyFormatterInEditing = false, Color? backgroundColor, PlutoColumnRenderer? renderer, bool suppressedAutoSize = false, bool enableColumnDrag = true, bool enableRowDrag = false, bool enableRowChecked = false, bool enableSorting = true, bool enableContextMenu = true, bool enableDropToResize = true, bool enableFilterMenuItem = true, bool enableHideColumnMenuItem = true, bool enableSetColumnsMenuItem = true, bool enableAutoEditing = false, bool? enableEditingMode = true, bool hide = false})
Properties
- applyFormatterInEditing ↔ bool
-
Apply the formatter in the editing state.
However, it is applied only when the cell is readonly
or the text cannot be directly modified, such as in the form of select popup.
getter/setter pair
- backgroundColor ↔ Color?
-
getter/setter pair
- cellPadding ↔ EdgeInsets?
-
Customisable cell padding.
It takes precedence over defaultCellPadding in PlutoGridConfiguration.
getter/setter pair
- defaultFilter → PlutoFilterType
-
no setter
- enableAutoEditing ↔ bool
-
getter/setter pair
- enableColumnDrag ↔ bool
-
Change the position of the column by dragging the column title.
getter/setter pair
- enableContextMenu ↔ bool
-
Displays the right icon of the column title.
getter/setter pair
- enableDropToResize ↔ bool
-
Display the right icon for drop to resize the column
getter/setter pair
- enableEditingMode ↔ bool?
-
Entering the Enter key or tapping the cell enters the Editing mode.
getter/setter pair
- enableFilterMenuItem ↔ bool
-
Displays filter-related menus in the column context menu.
Valid only when enableContextMenu is activated.
getter/setter pair
- enableHideColumnMenuItem ↔ bool
-
Displays Hide column menu in the column context menu.
Valid only when enableContextMenu is activated.
getter/setter pair
- enableRowChecked ↔ bool
-
A checkbox appears in the cell of the column.
getter/setter pair
- enableRowDrag ↔ bool
-
Change the position of the row by dragging the icon in the cell.
getter/setter pair
- enableSetColumnsMenuItem ↔ bool
-
Displays Set columns menu in the column context menu.
Valid only when enableContextMenu is activated.
getter/setter pair
- enableSorting ↔ bool
-
Sort rows by tapping on the column heading.
getter/setter pair
- field ↔ String
-
Specifies the field name of the row to be connected to the column.
getter/setter pair
- filterFocusNode → FocusNode?
-
no setter
- filterPadding ↔ EdgeInsets?
-
getter/setter pair
-
A callback that returns a widget
for expressing aggregate values at the bottom.
getter/setter pair
- formatter ↔ PlutoColumnValueFormatter?
-
Formatter for display of cell values.
getter/setter pair
- frozen ↔ PlutoColumnFrozen
-
Freeze the column to the left and right.
If the total width of the non-frozen column is 200 or less,
it is processed to be unfreeze even if the frozen column is set.
getter/setter pair
- group ↔ PlutoColumnGroup?
-
getter/setter pair
- hasCheckReadOnly → bool
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasRenderer → bool
-
no setter
- hide ↔ bool
-
Hide the column.
getter/setter pair
- isShowRightIcon → bool
-
no setter
- key → Key
-
no setter
- minWidth ↔ double
-
getter/setter pair
- readOnly ↔ bool
-
getter/setter pair
- renderer ↔ PlutoColumnRenderer?
-
Customize the widget in the default cell.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sort ↔ PlutoColumnSort
-
Set column sorting.
getter/setter pair
- startPosition ↔ double
-
startPosition is the position value for the position of the column from the left.
getter/setter pair
- suppressedAutoSize ↔ bool
-
If PlutoAutoSizeMode is enabled,
column autoscaling is ignored if suppressedAutoSize is true.
getter/setter pair
- textAlign ↔ PlutoColumnTextAlign
-
Text alignment in Cell. (Left, Right, Center)
getter/setter pair
- title ↔ String
-
A title to be displayed on the screen.
If a titleSpan value is set, the title value is not displayed.
getter/setter pair
- titlePadding ↔ EdgeInsets?
-
Customisable title padding.
It takes precedence over defaultColumnTitlePadding in PlutoGridConfiguration.
getter/setter pair
- titleSpan ↔ InlineSpan?
-
Customize the column with TextSpan or WidgetSpan instead of the column's title string.
getter/setter pair
- titleTextAlign ↔ PlutoColumnTextAlign
-
Text alignment in Title. (Left, Right, Center)
getter/setter pair
- titleWithGroup → String
-
no setter
- type ↔ PlutoColumnType
-
Set the column type.
getter/setter pair
- width ↔ double
-
getter/setter pair
Methods
-
checkReadOnly(
PlutoRow row, PlutoCell cell) → bool -
formattedValueForDisplay(
dynamic value) → String -
formattedValueForDisplayInEditing(
dynamic value) → String -
formattedValueForType(
dynamic value) → String -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setDefaultFilter(
PlutoFilterType filter) → void -
setFilterFocusNode(
FocusNode? node) → void -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited