SSpreadsheet class - s_spreadsheet library

Constructors

SSpreadsheet({Key? key, required int rowCount, required int columnCount, required SSpreadsheetCellBuilder cellBuilder, SSpreadsheetRowHeaderBuilder? rowHeaderBuilder, SSpreadsheetColumnHeaderBuilder? columnHeaderBuilder, WidgetBuilder? cornerBuilder, double rowHeaderWidth = 100, double headerHeight = 48, SSpreadsheetRowHeightBuilder? rowHeightBuilder, SSpreadsheetColumnWidthBuilder? columnWidthBuilder, EdgeInsetsGeometry padding = EdgeInsets.zero, EdgeInsetsGeometry rowPadding = EdgeInsets.zero, IndexedScrollController? verticalIndexedController, ScrollPhysics? verticalPhysics, ScrollPhysics? horizontalPhysics, Color? backgroundColor, bool showColumnHeader = true, SSpreadsheetHorizontalMetricsChanged? onHorizontalMetricsChanged, SSpreadsheetHorizontalSyncController? horizontalSyncController, bool repaintBoundaryPerRow = false, Duration rowExtentAnimationDuration = Duration.zero, bool addAutomaticKeepAlives = false, bool enableRowAnimations = true, Key rowKeyBuilder(int rowIndex)?, Duration rowAnimationDuration = const Duration(milliseconds: 400), bool enableKeystrokes = false, bool keystrokeDebugLogs = false, Map<Type, VoidCallback>? keystrokeActionHandlers, Map<Type, String>? keystrokeActionLabels, Map<ShortcutActivator, Intent>? keystrokeShortcuts, bool includeDefaultKeystrokeShortcuts = true, void onKeystrokeEvent(KeyDownEvent)?, FocusNode? keystrokeFocusNode, bool keystrokeRequestFocusOnInit = true, bool shouldPauseKeystrokes()?, SSpreadsheetKeystrokeHudBuilder? keystrokeHudBuilder, Duration keystrokeHudDuration = const Duration(seconds: 1)}): const

Properties

addAutomaticKeepAlives → bool: Whether to keep body rows alive.
final
backgroundColor → Color?: Optional background color behind the sheet.
final
cellBuilder → SSpreadsheetCellBuilder: Builds each body cell.
final
columnCount → int: Number of body columns (horizontally scrollable columns).
final
columnHeaderBuilder → SSpreadsheetColumnHeaderBuilder?: Optional builder for the top fixed column-header cells.
final
columnWidthBuilder → SSpreadsheetColumnWidthBuilder?: Width resolver for each body column.
final
cornerBuilder → WidgetBuilder?: Optional builder for the top-left corner (intersection of row/column headers).
final
enableKeystrokes → bool: When true, wraps the spreadsheet content in a KeystrokeListener so that keyboard shortcuts are detected and dispatched to keystrokeActionHandlers. Defaults to false (backward compatible).
final
enableRowAnimations → bool: Whether to animate rows when they are inserted or removed.
final
hashCode → int: The hash code for this object.
no setterinherited
headerHeight → double: Height of the top header row.
final
horizontalPhysics → ScrollPhysics?: Horizontal row/header physics.
final
horizontalSyncController → SSpreadsheetHorizontalSyncController?: Optional external horizontal sync controller that tracks shared horizontal metrics and allows external scroll controls.
final
includeDefaultKeystrokeShortcuts → bool: Whether the built-in navigation/editing shortcuts (ESC, Ctrl+S, Ctrl+Z, etc.) should be registered. Defaults to true.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
keystrokeActionHandlers → Map<Type, VoidCallback>?: Maps an Intent type to a callback that implements the action.
final
keystrokeActionLabels → Map<Type, String>?: Maps an Intent type to a human-readable action label (e.g. "New Dept Booking"). Used together with the auto-derived shortcut label to populate the HUD overlay via keystrokeHudBuilder.
final
keystrokeDebugLogs → bool: When true and enableKeystrokes is true, every detected keystroke is printed via debugPrint. No action handlers fire in this mode.
final
keystrokeFocusNode → FocusNode?: External FocusNode for the internal KeystrokeListener. When provided, callers can call FocusNode.requestFocus externally to re-acquire keystroke focus after overlays dismiss.
final
keystrokeHudBuilder → SSpreadsheetKeystrokeHudBuilder?: Custom HUD widget builder. When provided, the HUD is shown automatically before each keystrokeActionHandlers callback runs (provided a label exists in keystrokeActionLabels).
final
keystrokeHudDuration → Duration: How long the HUD overlay remains visible before auto-dismissing. Defaults to 1 second.
final
keystrokeRequestFocusOnInit → bool: When true, the internal KeystrokeListener requests autofocus on init, giving the hidden TextField the HTML autofocus attribute on Flutter Web. Defaults to true when enableKeystrokes is true.
final
keystrokeShortcuts → Map<ShortcutActivator, Intent>?: Custom shortcut bindings scoped to this spreadsheet. Merged after the built-in default shortcuts (unless includeDefaultKeystrokeShortcuts is false). Use this with custom Intent subclasses to detect key combinations not covered by the defaults.
final
onHorizontalMetricsChanged → SSpreadsheetHorizontalMetricsChanged?: Optional callback exposing synchronized horizontal scroll metrics.
final
onKeystrokeEvent → void Function(KeyDownEvent)?: Raw KeyDownEvent callback for custom handling beyond the Intent system. Fires for every key event that reaches the internal KeystrokeListener.
final
padding → EdgeInsetsGeometry: Padding applied around the whole spreadsheet.
final
repaintBoundaryPerRow → bool: Whether to wrap each built body row in a RepaintBoundary.
final
rowAnimationDuration → Duration: Duration of the insert/remove row animation. Defaults to 400ms.
final
rowCount → int: Number of body rows.
final
rowExtentAnimationDuration → Duration: Optional animation duration for row height changes.
final
rowHeaderBuilder → SSpreadsheetColumnHeaderBuilder?: Optional builder for the left fixed row-header cells.
final
rowHeaderWidth → double: Width of the fixed left row-header column.
final
rowHeightBuilder → SSpreadsheetColumnWidthBuilder?: Height resolver for each body row.
final
rowKeyBuilder → Key Function(int rowIndex)?: Optional key builder that gives each row a stable identity across rebuilds.
final
rowPadding → EdgeInsetsGeometry: Padding applied inside each body row container.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shouldPauseKeystrokes → bool Function()?: When provided and returns true, all keystroke intent handlers are suppressed and the auto-refocus is paused. Use this when descendant text inputs need exclusive keyboard access (e.g. a search bar inside the spreadsheet).
final
showColumnHeader → bool: Whether to draw the top header row.
final
verticalIndexedController → IndexedScrollController?: Optional IndexedScrollController for vertical (row) index-based scrolling.
final
verticalPhysics → ScrollPhysics?: Vertical list physics.
final

Methods

addMaterialWidget() → Material: Available on Widget, provided by the GenericExtensions extension
addTooltipWidget(String toolTip) → Tooltip: Available on Widget, provided by the GenericExtensions extension
borderRadius([BorderRadiusGeometry? borderRadius]) → Widget: Available on Widget, provided by the GenericExtensions extension
boxDecoration([BoxDecoration? boxDecoration]) → Widget: Available on Widget, provided by the GenericExtensions extension
colorFilter([ColorFilter? colorFilter]) → Widget: Available on Widget, provided by the GenericExtensions extension
set parent widget in center
createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SSpreadsheet>: 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