ReportDesignBuilder class

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

This widget constructs a highly interactive, bidirectional scrolling data grid. It supports sticky headers, a sticky left column, resizable columns, and integrates with a backend for premium export features (Excel, PDF, Word).

Inheritance

Constructors

ReportDesignBuilder({Key? key, required List<double> columnWidths, required double cellWidth, required double leftColumnWidth, required double bodyCellHeight, required double headerHeight, required double textSize, required double headerTextSize, required List<HeaderCell> headers, required List<SubHeaderCell> subHeaders, required List<ReportCell> leftColumn, required List<List<ReportCell>> tableData, required String stickyHeaderLabel, required Color stickyHeaderBackgroundColor, required Color stickyHeaderForegroundColor, required bool enableDownload, required bool showDownloadFloatingButton, required String? packageName, required String? apiKey, required String? reportName, required DownloadSuccessCallback? onDownloadCompleted, ReportController? controller})
Creates a ReportDesignBuilder to render the report data grid.
const

Properties

apiKey → String?
The API key required to authenticate with the export server.
final
bodyCellHeight → double
The standard height applied to all body data cells.
final
cellWidth → double
The default width fallback for individual cells.
final
columnWidths → List<double>
The initial widths for each dynamically resizable column.
final
controller → ReportController?
An optional controller to programmatically extract the grid's data or trigger exports.
final
enableDownload → bool
Master switch to enable or disable the premium download/export features.
final
hashCode → int
The hash code for this object.
no setterinherited
headerHeight → double
The standard height applied to header and sub-header rows.
final
headers → List<HeaderCell>
The list of top-level headers, supporting column spans.
final
headerTextSize → double
The default font size for header text.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leftColumn → List<ReportCell>
The list of cells rendered in the sticky left column.
final
leftColumnWidth → double
The fixed width of the sticky left-hand column.
final
onDownloadCompleted → DownloadSuccessCallback?
Callback fired when the report is successfully downloaded and saved to bytes.
final
packageName → String?
The registered Android/iOS package name required for API authentication.
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
stickyHeaderBackgroundColor → Color
The background color for the sticky left header and main export FAB.
final
stickyHeaderForegroundColor → Color
The text and icon color for the sticky left header and main export FAB.
final
stickyHeaderLabel → String
The text displayed in the top-left intersection cell (sticky header).
final
subHeaders → List<SubHeaderCell>
The list of sub-headers displayed directly underneath the main headers.
final
tableData → List<List<ReportCell>>
The 2D matrix of report data cells representing the main body.
final
textSize → double
The default font size for body data text.
final

Methods

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