AppState<T extends StatefulWidget> class Get started StateX class AppState class Error handling

The View for the app. The 'look and feel' for the whole app.

dartdoc:

Inheritance
Mixed in types

Constructors

AppState({Key? key, Widget? home, AppController? controller, List<StateXController>? controllers, Object? object, MaterialApp? materialApp, CupertinoApp? cupertinoApp, RouteInformationProvider? routeInformationProvider, RouteInformationParser<Object>? routeInformationParser, RouterDelegate<Object>? routerDelegate, bool? useRouterConfig, RouterConfig<Object>? routerConfig, BackButtonDispatcher? backButtonDispatcher, GlobalKey<ScaffoldMessengerState>? scaffoldMessengerKey, Map<String, WidgetBuilder>? routes, String? initialRoute, Route? onGenerateRoute(RouteSettings settings)?, Route? onUnknownRoute(RouteSettings settings)?, bool onNavigationNotification(NavigationNotification notification)?, List<NavigatorObserver>? navigatorObservers, TransitionBuilder? builder, String? title, String onGenerateTitle(BuildContext context)?, Color? color, bool? allowChangeTheme, ThemeData? theme, CupertinoThemeData? iOSTheme, ThemeData? darkTheme, ThemeData? highContrastTheme, ThemeData? highContrastDarkTheme, ThemeMode? themeMode, Duration? themeAnimationDuration, Curve? themeAnimationCurve, bool? allowChangeLocale, Locale? locale, Iterable<LocalizationsDelegate>? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, List<Locale>? supportedLocales, bool? useMaterial, bool? useCupertino, bool? switchUI, bool? allowChangeUI, bool? debugShowMaterialGrid, bool? showPerformanceOverlay, bool? checkerboardRasterCacheImages, bool? checkerboardOffscreenLayers, bool? showSemanticsDebugger, bool? debugShowCheckedModeBanner, bool? debugShowWidgetInspector, bool? debugPaintSizeEnabled, bool? debugPaintBaselinesEnabled, bool? debugPaintPointersEnabled, bool? debugPaintLayerBordersEnabled, bool? debugRepaintRainbowEnabled, bool? debugRepaintTextRainbowEnabled, bool? debugPrintRebuildDirtyWidgets, void debugOnRebuildDirtyWidget(Element e, bool builtOnce)?, bool? debugPrintBuildScope, bool? debugPrintScheduleBuildForStacks, bool? debugPrintGlobalKeyedWidgetLifecycle, bool? debugProfileBuildsEnabled, bool? debugProfileBuildsEnabledUserWidgets, bool? debugEnhanceBuildTimelineArguments, bool? debugHighlightDeprecatedWidgets, Map<LogicalKeySet, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, String? restorationScopeId, ScrollBehavior? scrollBehavior, FlutterExceptionHandler? errorHandler, ErrorWidgetBuilder? errorScreen, ReportErrorHandler? errorReport, void inErrorHandler(FlutterErrorDetails details)?, ErrorWidgetBuilder? inErrorScreen, Future<void> inErrorReport(Object exception, StackTrace stack)?, void inError(FlutterErrorDetails details)?, void inInitState()?, Future<bool> inInitAsync()?, Widget inHome()?, RouteInformationProvider inRouteInformationProvider()?, RouteInformationParser<Object> inRouteInformationParser()?, RouterDelegate<Object> inRouterDelegate()?, RouterConfig<Object>? inRouterConfig()?, BackButtonDispatcher inBackButtonDispatcher()?, Map<String, WidgetBuilder> inRoutes()?, String inInitialRoute()?, List<NavigatorObserver> inNavigatorObservers()?, bool inUpdateShouldNotify(InheritedWidget oldWidget)?, TransitionBuilder inTransBuilder()?, String inTitle()?, GenerateAppTitle? inGenerateTitle, ThemeData? inTheme()?, CupertinoThemeData? iniOSTheme()?, ThemeData? inDarkTheme()?, ThemeData? inHighContrastTheme()?, ThemeData? inHighContrastDarkTheme()?, ThemeMode? inThemeMode()?, Duration? inThemeAnimationDuration()?, Curve? inThemeAnimationCurve()?, Color? inColor()?, Locale? inLocale()?, Iterable<LocalizationsDelegate> inLocalizationsDelegates()?, LocaleListResolutionCallback? inLocaleListResolutionCallback, LocaleResolutionCallback? inLocaleResolutionCallback, List<Locale>? inSupportedLocales()?, bool? inDebugShowMaterialGrid()?, bool? inShowPerformanceOverlay()?, bool? inCheckerboardRasterCacheImages()?, bool? inCheckerboardOffscreenLayers()?, bool? inShowSemanticsDebugger()?, bool? inDebugShowCheckedModeBanner()?, Map<LogicalKeySet, Intent>? inShortcuts()?, Map<Type, Action<Intent>>? inActions()?, String? inRestorationScopeId()?, ScrollBehavior? inScrollBehavior()?, bool? inAsyncError(FlutterErrorDetails details)?})
Provide a huge array of options and features to the 'App State object.'

Properties

actions → Map<Type, Action<Intent>>?
no setterinherited
allowChangeLocale → bool
Allow the app directly change the Locale
no setter
allowChangeTheme → bool
Allow the app to change the theme
no setter
allowChangeUI → bool
Allow the app to directly change the UI design
no setter
app ↔ AppObject?
Reference to the 'app' object.
getter/setter pair
backButtonDispatcher → BackButtonDispatcher?
no setterinherited
builderOverridden → bool
A flag. Note if builder() function was overridden or not.
no setterinherited
buildFOverridden → bool
A flag. Note if build() function was overridden or not.
no setterinherited
buildInOverridden → bool
A flag. Note if buildIn() function was overridden or not.
no setterinherited
buildOverridden → bool
A flag noting if the build() function was overridden or not.
no setterinherited
checkerboardOffscreenLayers ↔ bool
getter/setter pairinherited
checkerboardRasterCacheImages ↔ bool
getter/setter pairinherited
color → Color
no setterinherited
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
controller → StateXController?
Provide the 'main' controller to this 'State View.' If _controller == null, get the 'first assigned' controller if any.
no setterinherited
controllerList → List<StateXController>
Supply a public list of all the Controllers.
no setterinherited
cupertinoApp ↔ CupertinoApp?
getter/setter pairinherited
currentErrorFunc → FlutterExceptionHandler?
Save the current Error Handler.
finalinherited
darkTheme → ThemeData?
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.
getter/setter pairinherited
debugEnhanceBuildTimelineArguments ↔ bool
Adds debugging information to 'Timeline' events related to Widget builds.
getter/setter pairinherited
debugHighlightDeprecatedWidgets ↔ bool
Show banners for deprecated widgets.
getter/setter pairinherited
debugOnRebuildDirtyWidget ↔ (void Function(Element e, bool builtOnce)?)
Callback invoked for every dirty widget built each frame.
getter/setter pairinherited
debugPaintBaselinesEnabled ↔ bool
getter/setter pairinherited
debugPaintLayerBordersEnabled ↔ bool
getter/setter pairinherited
debugPaintPointersEnabled ↔ bool
getter/setter pairinherited
debugPaintSizeEnabled ↔ bool
Highlights UI while debugging.
getter/setter pairinherited
debugPrintBuildScope ↔ bool
Log all calls to BuildOwner.buildScope.
getter/setter pairinherited
debugPrintGlobalKeyedWidgetLifecycle ↔ bool
Log when widgets with global keys are deactivated and log when they are reactivated (retaken).
getter/setter pairinherited
debugPrintRebuildDirtyWidgets ↔ bool
Log the dirty widgets that are built each frame.
getter/setter pairinherited
debugPrintScheduleBuildForStacks ↔ bool
Log the call stacks that mark widgets as needing to be rebuilt.
getter/setter pairinherited
debugProfileBuildsEnabled ↔ bool
Adds 'Timeline' events for every Widget built.
getter/setter pairinherited
debugProfileBuildsEnabledUserWidgets ↔ bool
Adds 'Timeline' events for every user-created Widget built.
getter/setter pairinherited
debugRepaintRainbowEnabled ↔ bool
getter/setter pairinherited
debugRepaintTextRainbowEnabled ↔ bool
getter/setter pairinherited
debugShowCheckedModeBanner ↔ bool
getter/setter pairinherited
debugShowMaterialGrid ↔ bool
getter/setter pairinherited
debugShowWidgetInspector ↔ bool
getter/setter pairinherited
detached ↔ bool
State object was in 'paused' state
getter/setter pairinherited
disposed ↔ bool
Flag indicating this State object is disposed. Will be garbage collected. property, mounted, is then set to false.
getter/setter pairinherited
endState → StateX<StatefulWidget>?
Return the 'latest' State object
no setterinherited
errorHandler ↔ FlutterExceptionHandler?
getter/setter pairinherited
errorMsg → String
Simply display the exception.
no setterinherited
errorReport ↔ ReportErrorHandler?
getter/setter pairinherited
errorScreen ↔ ErrorWidgetBuilder?
getter/setter pairinherited
firstCon → StateXController?
Returns 'the first' StateXController associated with this StateX object. Returns null if empty.
no setterinherited
firstState → StateX<StatefulWidget>?
no setterinherited
hadSystemEvent → bool
State object experienced a system event
no setterinherited
hasError → bool
Indicate if an exception had occurred.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden ↔ bool
State object was in a 'hidden' state
getter/setter pairinherited
highContrastDarkTheme → ThemeData?
no setterinherited
highContrastTheme → ThemeData?
no setterinherited
home → Widget?
The App's 'home screen'
no setterinherited
identifier → String
The unique identifier for this State object.
no setterinherited
inActions → (Map<Type, Action<Intent>>? Function()?)
Returns Map of 'Intent Actions' if any.
finalinherited
inactive ↔ bool
State object was in 'inactive' state
getter/setter pairinherited
inAsyncError → (bool? Function(FlutterErrorDetails details)?)
Returns the App's 'Async Error Handler' if any.
finalinherited
inBackButtonDispatcher → (BackButtonDispatcher Function()?)
Returns the 'Back Button' routine if any.
finalinherited
inCheckerboardOffscreenLayers → (bool? Function()?)
Returns 'Off Screen Layers Checkerboard' boolean indicator if any.
finalinherited
inCheckerboardRasterCacheImages → (bool? Function()?)
Returns 'Raster Cache Checkerboard' boolean indicator if any.
finalinherited
inColor → (Color? Function()?)
Returns the App's Color if any.
finalinherited
inDarkTheme → (ThemeData? Function()?)
Returns the App's 'Dark Theme' ThemeData if any.
finalinherited
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
inDebugShowCheckedModeBanner → (bool? Function()?)
Returns 'Show Debug Banner' boolean indicator if any.
finalinherited
inDebugShowMaterialGrid → (bool? Function()?)
Returns 'Show Material Grid' boolean indicator if any.
finalinherited
inDebugShowWidgetInspector → (bool? Function()?)
Returns 'Show Debug Widget Inspector' boolean indicator if any.
finalinherited
inError → (void Function(FlutterErrorDetails details)?)
finalinherited
inErrorHandler → (void Function(FlutterErrorDetails details)?)
finalinherited
inErrorReport → (Future<void> Function(Object exception, StackTrace stack)?)
finalinherited
inErrorRoutine ↔ bool
A flag indicating we're running in the error routine.
getter/setter pairinherited
inErrorScreen → ErrorWidgetBuilder?
finalinherited
inGenerateTitle → GenerateAppTitle?
Returns the 'Generate Title' routine if any.
finalinherited
inHighContrastDarkTheme → (ThemeData? Function()?)
Returns the App's 'High Contrast Dark Theme' ThemeData if any.
finalinherited
inHighContrastTheme → (ThemeData? Function()?)
Returns the App's 'High Contrast Theme' ThemeData if any.
finalinherited
inHome → (Widget Function()?)
Returns the home screen if any.
finalinherited
inInitAsync → (Future<bool> Function()?)
Perform asynchronous operations
finalinherited
inInitialRoute → (String Function()?)
Returns the initial Route if any.
finalinherited
inInitState → (void Function()?)
Perform synchronous initialization
finalinherited
iniOSTheme → (CupertinoThemeData? Function()?)
Returns the App's CupertinoThemeData if any.
finalinherited
initialRoute → String?
no setterinherited
inLocale → (Locale? Function()?)
Returns current Locale if any.
finalinherited
inLocaleListResolutionCallback → LocaleListResolutionCallback?
Returns 'Locale Resolutions' routine if any.
finalinherited
inLocaleResolutionCallback → LocaleResolutionCallback?
Returns 'Local Resolution' routine if any.
finalinherited
inLocalizationsDelegates → (Iterable<LocalizationsDelegate> Function()?)
Returns the 'Localization Delegates' if any.
finalinherited
inNavigatorObservers → (List<NavigatorObserver> Function()?)
Returns a List of Navigation Observers if any.
finalinherited
inRestorationScopeId → (String? Function()?)
Returns the 'Restore Scope Id' routine if any.
finalinherited
inRouteInformationParser → (RouteInformationParser<Object> Function()?)
Returns the Route Parser if any.
finalinherited
inRouteInformationProvider → (RouteInformationProvider Function()?)
Returns the Route Provider if any.
finalinherited
inRouterConfig → (RouterConfig<Object>? Function()?)
Returns the Route Config if any.
finalinherited
inRouterDelegate → (RouterDelegate<Object> Function()?)
Returns the Route Delegate if any.
finalinherited
inRoutes → (Map<String, WidgetBuilder> Function()?)
Returns a Map of Routes if any.
finalinherited
inScrollBehavior → (ScrollBehavior? Function()?)
Returns the App's ScrollBehavior if any.
finalinherited
inShortcuts → (Map<LogicalKeySet, Intent>? Function()?)
Returns Map of 'LogicalKeySets' if any.
finalinherited
inShowPerformanceOverlay → (bool? Function()?)
Returns 'Show Performance Overlay' boolean indicator if any.
finalinherited
inShowSemanticsDebugger → (bool? Function()?)
Returns 'Show Semantics' boolean indicator if any.
finalinherited
inSupportedLocales → (List<Locale>? Function()?)
Returns the Locale Iteration if any.
finalinherited
inTheme → (ThemeData? Function()?)
Returns the App's ThemeData if any.
finalinherited
inThemeAnimationCurve → (Curve? Function()?)
The curve to apply when animating theme changes.
finalinherited
inThemeAnimationDuration → (Duration? Function()?)
The duration of animated theme changes.
finalinherited
inThemeMode → (ThemeMode? Function()?)
Returns the App's ThemeMode if any.
finalinherited
inTitle → (String Function()?)
Returns the App's title if any.
finalinherited
inTransBuilder → (TransitionBuilder Function()?)
Returns the 'Transition Builder' if any.
finalinherited
inUpdateShouldNotify → (bool Function(InheritedWidget oldWidget)?)
Should update the built-in InheritedWidget's dependencies
finalinherited
isEndState → bool
This is the 'latest' State being viewed by the App.
no setterinherited
key → Key
The 'App State Objects' Key
no setter
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>?
no setterinherited
locale ↔ Locale?
getter/setter pairinherited
localeListResolutionCallback → LocaleListResolutionCallback?
no setterinherited
localeResolutionCallback → LocaleResolutionCallback?
no setterinherited
localizationsDelegates → Iterable<LocalizationsDelegate>?
no setterinherited
materialApp ↔ MaterialApp?
The MaterialApp and CupertinoApp if provided.
getter/setter pairinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
no setterinherited
onGenerateRoute → RouteFactory?
no setterinherited
onGenerateTitle → GenerateAppTitle?
no setterinherited
onNavigationNotification → NotificationListenerCallback<NavigationNotification>?
no setterinherited
onUnknownRoute → RouteFactory?
no setterinherited
parentState ↔ State<StatefulWidget>?
Reference the 'parent' State object
getter/setter pair
paused ↔ bool
State object was in 'paused' state
getter/setter pairinherited
restorationScopeId → String?
no setterinherited
resumed ↔ bool
State object was in 'resumed' state
getter/setter pairinherited
rootCon → StateXController?
Returns 'the first' StateXController associated with this StateX object. Returns null if empty.
no setterinherited
rootState → AppStateX<StatefulWidget>?
Returns the 'first' StateX object in the App
no setterinherited
routeInformationParser → RouteInformationParser<Object>?
no setterinherited
routeInformationProvider → RouteInformationProvider?
All the fields found in the widgets, MaterialApp and CupertinoApp
no setterinherited
routerConfig → RouterConfig<Object>?
no setterinherited
routerDelegate → RouterDelegate<Object>?
no setterinherited
routes → Map<String, WidgetBuilder>
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldMessengerKey → GlobalKey<ScaffoldMessengerState>?
no setterinherited
scrollBehavior → ScrollBehavior?
no setterinherited
shortcuts → Map<LogicalKeySet, Intent>?
no setterinherited
showPerformanceOverlay ↔ bool
getter/setter pairinherited
showSemanticsDebugger ↔ bool
getter/setter pairinherited
snapshot → AsyncSnapshot<bool>?
Supply the AsyncSnapshot
no setterinherited
stackTrace → StackTrace?
The StackTrace
no setterinherited
startState → StateX<StatefulWidget>?
Return the first State object
no setterinherited
supportedLocales → List<Locale>
no setterinherited
switchUI → bool
Use Cupertino UI in Android and vice versa.
no setter
themeAnimationCurve → Curve
no setterinherited
themeAnimationDuration → Duration
no setterinherited
themeMode → ThemeMode
no setterinherited
title → String
no setterinherited
transitBuilder → TransitionBuilder?
no setterinherited
useCupertino → bool
Explicitly use the Cupertino theme
no setter
useInherited → bool
A flag determining whether the built-in InheritedWidget is used or not.
no setterinherited
useMaterial → bool
Explicitly use the Material theme
no setter
useRouterConfig ↔ bool?
Use RouterConfig or not
getter/setter pair
usingCupertino → bool
Is the CupertinoApp being used?
no setterinherited
widget → T
You need to be able access the widget.
no setteroverride

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
add(StateXController? con) → String
Collect a 'StateXController' Returns the StateXController's unique identifier.
inherited
addList(List<StateXController>? list) → List<String>
Collect a list of 'Controllers'.
inherited
build(BuildContext context) → Widget
Override build to avoid the built-in Future Builder.
override
buildApp(BuildContext context) → Widget?
Supply the App widget if you wish.
builder(BuildContext context) → Widget
This function is wrapped in a Builder widget. If you don't use it, use the buildAndroid() or buildiOS() function.
inherited
buildF(BuildContext context) → Widget
A separate State object containing the app's InheritedWidget and a separate State object containing the app's buildIn() function
inherited
buildIn(BuildContext context) → Widget
Override to impose your own WidgetsApp (like CupertinoApp or MaterialApp)
override
canPop() → bool
Whether the navigator can be popped.
inherited
catchError(Exception? ex, {StackTrace? stack, String? library, DiagnosticsNode? context, IterableFilter<String>? stackFilter, InformationCollector? informationCollector, bool? silent}) → void
Catch and explicitly handle the error.
inherited
changeUI(String? ui) → bool
Explicitly change to a particular interface.
contains(StateXController con) → bool
Returns true if found.
inherited
containsId(String? id) → bool
Returns true if the specified 'StateXController' is associated with this StateX object.
inherited
containsType<T>() → bool
Returns true if found
inherited
controllerById(String? id) → StateXController?
Retrieve a StateXController by its a unique String identifier.
inherited
controllerByType<U extends StateXController>() → U?
Retrieve a StateXController by type.
inherited
copy([StateX<StatefulWidget>? state]) → void
Copy particular properties from another StateX
inherited
deactivate() → void
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
detachedLifecycleState() → 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.
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
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 thedidUpdateWidget function in the special case the StatefulWidget supplies the controller: e.g. didUpdateController(oldWidget.controller, widget.controller);
inherited
didUpdateWidget(covariant StatefulWidget 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
Clean up resources before the app is finally terminated.
finalizeRoute(Route route) → void
Complete the lifecycle for a route that has been popped off the navigator.
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}) → 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.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
hiddenLifecycleState() → 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
inactiveLifecycleState() → void
Apps in this state should assume that they may be pausedLifecycleState at any time.
inherited
initAsync() → Future<bool>
Used to complete asynchronous operations
override
initState() → void
The traditional initState for the App's first State object
override
listControllers(List<String?>? keys) → 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
maybePop<T extends Object?>([T? result]) → Future<bool>
Consults the current route's Route.popDisposition method, and acts accordingly, potentially popping the route as a result; returns whether the pop request should be considered handled.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyClients() → bool
Notify the InheritedWidget's dependencies
inherited
onActions() → Map<Type, Action<Intent>>?
Returns Map of 'Intent Actions' if any.
inherited
onAsyncError(FlutterErrorDetails details) → void
Supply an 'error handler' routine if something goes wrong in the corresponding runAsync() or initAsync() routine.
inherited
onBackButtonDispatcher() → BackButtonDispatcher?
Returns the 'Back Button' routine if any.
inherited
onBuilder() → TransitionBuilder?
Returns the 'Transition Builder' if any.
inherited
onCheckerboardOffscreenLayers() → bool?
Returns 'Off Screen Layers Checkerboard' boolean indicator if any.
inherited
onCheckerboardRasterCacheImages() → bool?
Returns 'Raster Cache Checkerboard' boolean indicator if any.
inherited
onColor() → Color?
Returns the App's Color if any.
inherited
onDarkTheme() → ThemeData?
Returns the App's 'Dark Theme' ThemeData if any.
inherited
onDebugShowCheckedModeBanner() → bool?
Returns 'Show Debug Banner' boolean indicator if any.
inherited
onDebugShowMaterialGrid() → bool?
Returns 'Show Material Grid' boolean indicator if any.
inherited
onDebugShowWidgetInspector() → bool?
Returns 'Show Debug Banner' boolean indicator if any.
inherited
onError(FlutterErrorDetails details) → void
Supply an 'error handler' routine to fire when an error occurs. Override if you like to customize error handling.
inherited
onErrorHandler(FlutterErrorDetails details) → void
Override to provide an 'overall' Error Handler for your app.
inherited
onErrorReport(Object exception, StackTrace stack) → Future<void>
If there's a error reporting routine available.
inherited
onErrorScreen(FlutterErrorDetails details) → Widget
The Widget to display when an app's widget fails to display.
inherited
onHighContrastDarkTheme() → ThemeData?
Returns the App's 'High Contrast Dark Theme' ThemeData if any.
inherited
onHighContrastTheme() → ThemeData?
Returns the App's 'High Contrast Theme' ThemeData if any.
inherited
onHome() → Widget?
Returns the home screen if any.
inherited
onInitAsync() → Future<bool>
Used to complete asynchronous operations
inherited
onInitialRoute() → String?
Returns the initial Route if any.
inherited
oniOSTheme() → CupertinoThemeData?
Returns the App's CupertinoThemeData if any.
inherited
onLocale() → Locale?
Returns current Locale if any.
inherited
onLocaleListResolutionCallback(List<Locale>? locales, Iterable<Locale> supportedLocales) → Locale?
Returns 'Locale Resolutions' routine if any.
inherited
onLocaleResolutionCallback(Locale? locale, Iterable<Locale> supportedLocales) → Locale?
Returns 'Local Resolution' routine if any. Turn to the I10n class to provide the locale.
inherited
onLocalizationsDelegates() → Iterable<LocalizationsDelegate>?
Returns the 'Localization Delegates' if any.
inherited
onNavigatorKey() → GlobalKey<NavigatorState>
Returns the App's Navigator Key.
inherited
onNavigatorObservers() → List<NavigatorObserver>
Returns a List of Navigation Observers if any.
inherited
onOnGenerateRoute(RouteSettings settings) → Route?
Returns the 'Generate Routes' routine if any.
inherited
onOnNavigationNotification(NavigationNotification notification) → bool
Called when a navigation event occurs Return true if you deem this change is handled.
inherited
onOnUnknownRoute(RouteSettings settings) → Route?
Returns the 'Unknown Route' if any.
inherited
onRestorationScopeId() → String?
Returns the 'Restore Scope Id' routine if any.
inherited
onRouteInformationParser() → RouteInformationParser<Object>?
Returns the Route Parser if any.
inherited
onRouteInformationProvider() → RouteInformationProvider?
Returns the Route Provider if any.
inherited
onRouterConfig() → RouterConfig<Object>?
Returns the Route Config if any.
inherited
onRouterDelegate() → RouterDelegate<Object>?
Returns the Route Delegate if any.
inherited
onRoutes() → Map<String, WidgetBuilder>?
Returns a Map of Routes if any.
inherited
onScaffoldMessengerKey() → GlobalKey<ScaffoldMessengerState>
Returns the App's ScaffoldMessenger Key.
inherited
onScrollBehavior() → ScrollBehavior?
Returns the App's ScrollBehavior if any.
inherited
onShortcuts() → Map<LogicalKeySet, Intent>?
Returns Map of 'LogicalKeySets' if any.
inherited
onShowPerformanceOverlay() → bool?
Returns 'Show Performance Overlay' boolean indicator if any.
inherited
onShowSemanticsDebugger() → bool?
Returns 'Show Semantics' boolean indicator if any.
inherited
onSplashScreen(BuildContext context) → Widget?
Supply a 'splash screen' while the FutureBuilder is processing.
inherited
onSupportedLocales() → List<Locale>?
Returns the Locale Iteration if any.
inherited
onTheme() → ThemeData?
Returns the App's ThemeData if any.
inherited
onThemeAnimationCurve() → Curve?
Returns the App's ThemeMode if any.
inherited
onThemeAnimationDuration() → Duration?
Returns the App's ThemeMode if any.
inherited
onThemeMode() → ThemeMode?
Returns the App's ThemeMode if any.
inherited
onTitle() → String
Returns the App's title if any.
inherited
onUpdateShouldNotify(covariant InheritedWidget oldWidget) → bool
Should update the built-in InheritedWidget's dependencies
inherited
pausedLifecycleState() → void
The application is not currently visible to the user, not responding to user input, and running in the background.
inherited
pop<T extends Object?>([T? result]) → void
Pop the top-most route off the navigator.
inherited
popAndPushNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) → Future<T?>
Pop the current route off the navigator and push a named route in its place.
inherited
popUntil(RoutePredicate predicate) → void
Calls pop repeatedly until the predicate returns true.
inherited
push<T extends Object?>(Route<T> route) → Future<T?>
Push the given route onto the navigator.
inherited
pushAndRemoveUntil<T extends Object?>(Route<T> newRoute, RoutePredicate predicate) → Future<T?>
Push the given route onto the navigator, and then remove all the previous routes until the predicate returns true.
inherited
pushNamed<T extends Object?>(String routeName, {Object? arguments}) → Future<T?>
Push a named route onto the navigator.
inherited
pushNamedAndRemoveUntil<T extends Object?>(String newRouteName, RoutePredicate predicate, {Object? arguments}) → Future<T?>
Push the route with the given name onto the navigator, and then remove all the previous routes until the predicate returns true.
inherited
pushReplacement<T extends Object?, TO extends Object?>(Route<T> newRoute, {TO? result}) → Future<T?>
Replace the current route of the navigator by pushing the given route and then disposing the previous route once the new route has finished animating in.
inherited
pushReplacementNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) → Future<T?>
Replace the current route of the navigator by pushing the route named routeName and then disposing the previous route once the new route has finished animating in.
inherited
reassemble() → void
During development, if a hot reload occurs, the reassemble method is called.
override
recordException([Object? error, StackTrace? stack]) → Exception?
Return the 'last' error if any.
inherited
refresh() → void
Rebuild the 'latest/current' State object and the 'root/first' State object This is to address the possibility an App has called another App.
reload() → void
Reload the whole App
remove(StateXController? con) → bool
Remove a 'StateXController' Returns boolean if successful.
inherited
removeByKey(String? id) → bool
Remove a specific 'StateXController' by its unique 'key' identifier.
inherited
removeRoute(Route route) → void
Immediately remove route from the navigator, and Route.dispose it.
inherited
removeRouteBelow(Route anchorRoute) → void
Immediately remove a route from the navigator, and Route.dispose it. The route to be removed is the one below the given anchorRoute.
inherited
replace<T extends Object?>({required Route oldRoute, required Route<T> newRoute}) → void
Replaces a route on the navigator that most tightly encloses the given context with a new route.
inherited
replaceRouteBelow<T extends Object?>({required Route anchorRoute, required Route<T> newRoute}) → void
Replaces a route on the navigator with a new route. The route to be replaced is the one below the given anchorRoute.
inherited
restorablePopAndPushNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) → String
Pop the current route off the navigator and push a named route in its place.
inherited
restorablePush<T extends Object?>(RestorableRouteBuilder<T> routeBuilder, {Object? arguments}) → String
Push a new route onto the navigator.
inherited
restorablePushAndRemoveUntil<T extends Object?>(RestorableRouteBuilder<T> newRouteBuilder, RoutePredicate predicate, {Object? arguments}) → String
Push a new route onto the navigator, and then remove all the previous routes until the predicate returns true.
inherited
restorablePushNamed<T extends Object?>(String routeName, {Object? arguments}) → String
Push a named route onto the navigator.
inherited
restorablePushNamedAndRemoveUntil<T extends Object?>(String newRouteName, RoutePredicate predicate, {Object? arguments}) → String
Push the route with the given name onto the navigator that most tightly encloses the given context, and then remove all the previous routes until the predicate returns true.
inherited
restorablePushReplacement<T extends Object?, TO extends Object?>(RestorableRouteBuilder<T> routeBuilder, {TO? result, Object? arguments}) → String
Replace the current route of the navigator by pushing a new route and then disposing the previous route once the new route has finished animating in.
inherited
restorablePushReplacementNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) → String
Replace the current route of the navigator that most tightly encloses the given context by pushing the route named routeName and then disposing the previous route once the new route has finished animating in.
inherited
restorableReplace<T extends Object?>({required Route oldRoute, required RestorableRouteBuilder<T> newRouteBuilder, Object? arguments}) → String
Replaces a route on the navigator that most tightly encloses the given context with a new route.
inherited
restorableReplaceRouteBelow<T extends Object?>({required Route anchorRoute, required RestorableRouteBuilder<T> newRouteBuilder, Object? arguments}) → String
Replaces a route on the navigator with a new route. The route to be replaced is the one below the given anchorRoute.
inherited
resumedLifecycleState() → void
The application is visible and responding to user input.
inherited
runAsync() → Future<bool>
Run the StateX object's initAsync() function Override this function to repeatedly run initAsync()
inherited
setiOSThemeData(BuildContext context) → CupertinoThemeData?
Assigning the Cupertino theme
setRootStateX(StateX<StatefulWidget> state) → bool
Important to record the 'root' StateX object. Its an InheritedWidget!
inherited
setState(VoidCallback fn) → void
Calls the State object's setState() function if not (see class SetState).
inherited
setThemeData(BuildContext context) → ThemeData?
Assigning the Material theme
state(WidgetBuilder? widgetFunc) → Widget
Called when the State's InheritedWidget is called again This 'widget function' will be called again.
inherited
stateById(String? id) → StateX<StatefulWidget>?
Returns a StateView 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
subscribe(State<StatefulWidget> state) → bool
State object becomes a route observer.
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
unsubscribe(State<StatefulWidget> state) → bool
No longer a route observer
inherited
updateNewStateX(covariant StateX<StatefulWidget> oldState) → void
Update the 'new' StateX object from the 'old' StateX object. Returning to this app from another app will re-create the State object You 'update' the current State object using this function.
inherited
updateShouldNotify(covariant InheritedWidget oldWidget) → bool
Determine if the dependencies should be updated.
override

Operators

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