ReportController class
A controller used to programmatically interact with a ReportMaker grid.
ReportController manages state extraction, programmatic exports, and powers the real-time form validation engine.
- Inheritance
-
- Object
- ChangeNotifier
- ReportController
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
attach(
{GetReportDataCallback? dataCallback, GetTableDataOnlyCallback? tableDataCallback, DownloadReportCallback? downloadCallback}) → void - Internal method used by the reporting engine to attach logic to this controller.
-
clearFormStates(
) → void - Clears all visual form states (errors and yellow override warnings) from the grid. Call this after a successful form submission to visually reset the table.
-
detach(
) → void - Detaches the controller to prevent memory leaks.
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
downloadReport(
) → Future< void> - Programmatically triggers the internal download/export logic.
-
getCellState(
int row, int col) → CellFormState? - Retrieves the current validation/override state for a specific cell coordinate.
-
getSubmitData(
) → List< List< String> > - Extracts the current data of the report grid as a 2D List of Strings.
-
getTextController(
int row, int col) → TextEditingController? - Retrieves the registered text controller for a specific cell coordinate.
-
hasValidationErrors(
) → bool - Checks if any cell in the grid currently contains a hard validation error.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
processRules(
int changedRow, int changedCol, String newValue) → void - Executes all rules associated with a specific cell upon value change.
-
registerTextController(
int row, int col, TextEditingController controller) → void - Registers a cell's text controller with the engine for programmatic overriding.
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
setFormRules(
List< ReportFormRule> rules) → void - Sets the active validation and auto-correction rules for the report grid.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited