NrbTableEngineBuilder class

The core rendering engine for the unified 2D Nexora Report Builder (NRB).

This widget constructs a highly interactive, bidirectional scrolling data grid. It supports N-frozen columns, HTML-style spanning, resizable columns, and supports local Excel/PDF/Word export and optional NRB server export.

Inheritance

Constructors

NrbTableEngineBuilder({Key? key, required List<double> columnWidths, required List<double> headerHeights, required List<double> bodyRowHeights, required int frozenColumnsCount, required List<List<NrbHeaderCell>> headers, required List<List<ReportCell>> tableData, Color primaryUiColor = Colors.blue, Color primaryUiTextColor = Colors.white, bool enableDownload = false, bool showDownloadFloatingButton = true, String? packageName, String? apiKey, String? companyName, String? companyAddress, String? companyLogoAsset, String? reportName, TableDownloadSuccessCallback? onDownloadCompleted, ReportController? controller, required bool isSortingEnable})
Creates a NrbTableEngineBuilder to render the report data grid.
const

Properties

apiKey → String?
Optional API key for NRB server exports.
final
bodyRowHeights → List<double>
The standard height applied to header rows.
final
columnWidths → List<double>
The initial widths for each dynamically resizable column.
final
companyAddress → String?
Optional company address for free users (used in native PDF export).
final
companyLogoAsset → String?
Optional company logo asset path for free users (e.g., 'assets/logo.png').
final
companyName → String?
Optional company name for free users (used in native PDF export).
final
controller → ReportController?
An optional controller to programmatically extract the grid's data or trigger exports.
final
enableDownload → bool
Master switch for both local and server-backed download/export features.
final
frozenColumnsCount → int
The number of columns locked to the left side of the screen.
final
hashCode → int
The hash code for this object.
no setterinherited
headerHeights → List<double>
The standard height applied to all body data cells.
final
headers → List<List<NrbHeaderCell>>
A 2D list defining the header structure.
final
isSortingEnable → bool
Define sorting features enable/disable
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDownloadCompleted → TableDownloadSuccessCallback?
Callback fired when the report is successfully downloaded and saved to bytes.
final
packageName → String?
Application package name used for server authentication.
final
primaryUiColor → Color
Primary color for UI overlays like the FAB.
final
primaryUiTextColor → Color
Text color for UI overlays like the FAB.
final
reportName → String?
The custom file name used when saving or sharing the exported report.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showDownloadFloatingButton → bool
Determines whether to render the interactive Floating Action Button for exports.
final
tableData → List<List<ReportCell>>
A pure 2D list of data cells.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<NrbTableEngineBuilder>
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