StateX<T extends StatefulWidget> class Get started StateX class Testing

The extension of the State class.

dartdoc:

Inheritance
Implemented types

Constructors

StateX({StateXController? controller, bool? runAsync, bool? useInherited, bool? printEvents})
Default useInherited to false

Properties

appCon → StateXController?
Returns 'the first' StateXController associated with this StateX object. Returns null if empty.
no setterinherited
appState → AppStateX<StatefulWidget>?
Returns the 'first' StateX object in the App
no setter
appStateX ↔ AppStateX<StatefulWidget>?
The App's State object
getter/setter pairinherited
builderOverridden → bool
A flag. Note if builder() function was overridden or not.
no setterinherited
buildFOverridden → bool
A flag. If the buildF() function was overridden or not.
no setterinherited
buildOverridden → bool
A flag. If the build() function was overridden or not.
no setterinherited
caughtAsyncError → bool
A flag noting an Async error was caught or not
no setteroverride
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
controller → StateXController?
Provide the 'main' controller to this 'State View.'
no setteroverride
controllerList → List<StateXController>
List the controllers.
no setterinherited
dataObject ↔ Object?
This is of type Object allowing you to propagate any class object you wish down the widget tree.
getter/setter pairinherited
deactivated → bool
State object's deactivated() was called.
no setterinherited
debugPrintEvents ↔ bool
debugPrint the 'event handlers'
getter/setter pairinherited
detachedAppLifecycle → bool
State object was in 'paused' state
no setterinherited
disposed → bool
Flag indicating this State object is disposed. Will be garbage collected. property, mounted, is then set to false.
no setterinherited
firstBuild → bool
State object's first build or will be its first build
no setterinherited
firstCon → StateXController?
Returns 'the first' StateXController associated with this StateX object. Returns null if empty.
no setterinherited
firstState → StateX<StatefulWidget>?
Return the first State object
no setterinherited
hadSystemEvent → bool
State object experienced a system event
no setterinherited
hasErrorInErrorHandler → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hiddenAppLifecycle → bool
All views of an application are hidden, either because the application is about to be paused (on iOS and Android), or because it has been minimized or placed on a desktop that is no longer visible (on non-web desktop), or is running in a window or tab that is no longer visible (on the web). State object was in a 'hidden' state
no setterinherited
identifier → String
The unique identifier for this State object.
no setterinherited
inactiveAppLifecycle → bool
State object was in 'inactive' state
no setterinherited
inDebugMode → bool
Determines if running in an IDE or in production. Returns true if the App is under in the Debugger and not production.
no setterinherited
inFlutterTest → bool
Indicate if running under a 'Flutter Test' environment
no setterinherited
initAsyncCalled → bool
Flag indicating initAsync() has been called
no setterinherited
inWidgetsFlutterBinding → bool
Indicating app is running in the Flutter engine and not in the flutter_test framework with TestWidgetsFlutterBinding for example
no setterinherited
isLastState → bool
This is the 'latest' State being viewed by the App.
no setterinherited
lastCon → StateXController?
Returns 'the last' StateXController associated with this StateX object. Returns null if empty.
no setterinherited
lastContext → BuildContext?
Returns the 'latest' context in the App.
no setterinherited
lastState → StateX<StatefulWidget>?
Return the 'latest' State object
no setterinherited
logStateXError ↔ bool
Flag whether to log error details or not
getter/setter pairinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
pausedAppLifecycle → bool
The application is not currently visible to the user, not responding to user input, and running in the background. (Called only in iOS, Android) State object was in 'paused' state
no setterinherited
printEvents → bool
no setterinherited
recErrorException → Object?
The Error or Exception
no setterinherited
recErrorMsg → String
Simply display the exception.
no setterinherited
recHasError → bool
Indicate if an exception had occurred.
no setterinherited
recStackTrace → StackTrace?
The StackTrace
no setterinherited
resumedAppLifecycle → bool
State object was in 'resumed' state
no setterinherited
rootCon → StateXController?
no setterinherited
rootState → AppStateX<StatefulWidget>?
Returns the 'first' StateX object in the App
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshot → AsyncSnapshot<bool>?
Supply the AsyncSnapshot
no setterinherited
useInherited → bool
A flag determining whether the built-in InheritedWidget is used or not.
no setterinherited
usingCupertino → bool
Is the CupertinoApp being used?
no setterinherited
widget → T
Access the StatefulWidget widget.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
add(StateXController? controller) → String
Add a specific StateXController to this State object. Returns the StateXController's unique String identifier.
inherited
addAll(List<StateXController>? list) → List<String>
Add a list of 'Controllers' to be associated with this StatX object.
inherited
addList(List<StateXController>? list) → List<String>
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
buildAndroid(BuildContext context) → Widget
This is an optional function allowing you to make the distinction. Build the Android interface. By convention, this involves Material Interface
builder(BuildContext context) → Widget
This function is wrapped in a Builder widget. If you don't use it, use the buildAndroid() or buildiOS() function.
override
buildF(BuildContext context) → Widget StateX class
Called by build. Calls built-in InheritedWidget dartdoc:
inherited
buildiOS(BuildContext context) → Widget
This is an optional function allowing you to make the distinction. Build the iOS interface. By convention, this involves Cupertino Interface Defaults to the Material interface design if called yet not implemented
catchAsyncError(Object error) → Future<bool>
Catch it if the initAsync() throws an error The FutureBuilder will fail, but you can examine the error
override
contains(StateXController con) → bool
Returns true if found.
inherited
containsType<T>() → bool
Returns true if found
inherited
controllerById(String? id) → StateXController?
Retrieve a StateXController by its a unique String identifier.
override
controllerByType<U extends StateXController>() → U?
Retrieve a StateXController by type.
inherited
deactivate() → void
Called with every StateX associated with this Controller Initialize any 'time-consuming' operations at the beginning. Implement any asynchronous operations needed done at start up. initAsync() has failed and a 'error' widget instead will be displayed. This takes in the snapshot.error details. The framework calls this method whenever it removes this State object from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
dependOnInheritedWidget(BuildContext? context) → bool
Set the specified widget (through its context) as a dependent of the InheritedWidget
inherited
detachedAppLifecycleState() → void
Either be in the progress of attaching when the engine is first initializing or after the view being destroyed due to a Navigator pop. The application is still hosted on a flutter engine but is detached from any host views. Its firing will depending on the hosting operating system: https://github.com/flutter/flutter/issues/124945#issuecomment-1514159238
inherited
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
inherited
didChangeDependencies() → void
This method is also called immediately after initState. Otherwise called only if this State object's Widget is a dependency of InheritedWidget. When a InheritedWidget's build() function is called the dependent widget's build() function is also called but not before their didChangeDependencies() function. Subclasses rarely use this method.
inherited
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPop() → void
Called when this route has been popped off.
inherited
didPopNext() → void
The top route has been popped off, and this route shows up.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route. For example, on Android, this is called when the user presses the back button. Observers are notified in registration order until one returns true. If none return true, the application quits.
inherited
didPush() → void
Called when this route has been pushed.
inherited
didPushNext() → void
New route has been pushed, and this route is no longer visible.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the app to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
didUpdateController({StateXController? oldCon, StateXController? newCon}) → bool
Update the 'first' controller if necessary Place in the didUpdateWidget function in the special case the StatefulWidget supplies the controller: e.g. didUpdateController(oldWidget.controller, widget.controller);
inherited
didUpdateWidget(covariant T oldWidget) → void
Override this method to respond when its StatefulWidget is re-created. The framework always calls build after calling didUpdateWidget, which means any calls to setState in didUpdateWidget are redundant.
inherited
dispose() → void
The framework calls this method when this StateX object will never build again and will be disposed of with garbage collection.
inherited
forEach(void func(StateXController con), {bool? reversed}) → bool
To externally 'process' through the controllers. Invokes func on each StateXController possessed by this StateX object. With an option to process in reversed chronological order
inherited
forEachState(void func(StateX<StatefulWidget> state), {bool? reversed, StateX<StatefulWidget>? remove}) → bool
To externally 'process' through the State objects. Invokes func on each StateX possessed by this StateX object. With an option to process in reversed chronological order
inherited
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture. If an observer returns true then that observer, and only that observer, will be notified of subsequent events in this same gesture (for example handleUpdateBackGestureProgress, etc.).
inherited
handleStatusBarTap() → void
Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
hiddenAppLifecycleState() → void
All views of an application are hidden, either because the application is about to be paused (on iOS and Android), or because it has been minimized or placed on a desktop that is no longer visible (on non-web desktop), or is running in a window or tab that is no longer visible (on the web).
inherited
inactiveAppLifecycleState() → void
Apps in this state should assume that they may be pausedAppLifecycleState at any time.
inherited
initAsync() → Future<bool>
Asynchronous operations must complete successfully.
inherited
initAsyncState(covariant State<StatefulWidget> state) → Future<bool>
Called with every StateX associated with this Controller Initialize any 'time-consuming' operations at the beginning. Implement any asynchronous operations needed done at start up.
inherited
initState() → void
The framework will call this method exactly once. Only when the StateX object is first created.
inherited
listControllers(List<String?>? ids) → List<StateXController?>
Returns the list of 'Controllers' but you must know their keys.
inherited
listStates(List<String> keys) → List<StateX<StatefulWidget>>
Returns a List of StateX objects using unique String identifiers.
inherited
logErrorDetails(FlutterErrorDetails details, {bool? force}) → void
Logs 'every' error as the error count is reset. force - Forces the log despite flag setting of logStateXError
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyClients() → bool
In harmony with Flutter's own API there's also a notifyClients() function Rebuild the InheritedWidget of the 'closes' InheritedStateX object if any.
inherited
ofState<T extends StateX<StatefulWidget>>() → T?
Consistent with the equivalent in the StateXController class
inherited
onAsyncError(FlutterErrorDetails details) → void
initAsync() has failed and a 'error' widget instead will be displayed. This takes in the snapshot.error details.
inherited
onCatchAsyncError(Object error) → Future<bool>
Catch it if the initAsync() throws an error The FutureBuilder will fail, but you can examine the error
onError(FlutterErrorDetails details) → void
Offer an error handler
inherited
onSplashScreen(BuildContext context) → Widget?
Supply a 'splash screen' while the FutureBuilder is processing.
inherited
pausedAppLifecycleState() → void
The application is not currently visible to the user, not responding to user input, and running in the background.
inherited
reassemble() → void
During development, if a hot reload occurs, the reassemble method is called. This provides an opportunity to reinitialize any data that was prepared in the initState method.
inherited
recordErrorInHandler([Object? error, StackTrace? stack]) → Object?
inherited
recordException([Object? error, StackTrace? stack]) → Object?
Return the 'last' error if any.
inherited
remove(StateXController? controller) → bool
Remove a specific StateXController to this State object. Returns the StateXController's unique String identifier.
inherited
removeByKey(String? id) → bool
Remove a specific 'StateXController' by its unique 'key' identifier.
inherited
resumedAppLifecycleState() → void
The application is visible and responding to user input.
inherited
runInitAsync() → bool
Calls initAsync() all the time if returns true. Conditional calls initAsync() creating a Future with every rebuild
inherited
setBuilder(WidgetBuilder? builder) → Widget
Called when the State's InheritedWidget is called again This 'widget builder' will be called again.
inherited
setState(VoidCallback fn) → void
Allows 'external' routines to call this function.
inherited
stateById(String? id) → StateX<StatefulWidget>?
Returns a State object using a unique String identifier.
inherited
stateByType<T extends StateX<StatefulWidget>>() → T?
Retrieve the State object by type Returns null if not found
inherited
statesById(List<String> ids) → Map<String, StateX<StatefulWidget>>
Returns a Map of StateView objects using unique String identifiers.
inherited
stateSet(WidgetBuilder? builder) → Widget
inherited
statesList({bool? reversed, StateX<StatefulWidget>? remove}) → List<StateX<StatefulWidget>>
Return a List of available StateX objects
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
updateShouldNotify(covariant InheritedWidget oldWidget) → bool
Determine if its dependencies should be updated.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited