AppState<T extends StatefulWidget> class

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

Inheritance
Implemented types
Mixed-in types

Constructors

AppState({Key? key, Widget? home, AppController? controller, List<StateXController>? controllers, void binding()?, List<Function>? bindings, Object? object, MaterialApp? materialApp, CupertinoApp? cupertinoApp, @Deprecated('No longer available to the user.') GlobalKey<NavigatorState>? navigatorKey, RouteInformationProvider? routeInformationProvider, RouteInformationParser<Object>? routeInformationParser, RouterDelegate<Object>? routerDelegate, RouterConfig<Object>? routerConfig, BackButtonDispatcher? backButtonDispatcher, GlobalKey<ScaffoldMessengerState>? scaffoldMessengerKey, Map<String, WidgetBuilder>? routes, String? initialRoute, RouteFactory? onGenerateRoute, RouteFactory? onUnknownRoute, List<NavigatorObserver>? navigatorObservers, TransitionBuilder? builder, String? title, GenerateAppTitle? onGenerateTitle, ThemeData? theme, CupertinoThemeData? iOSTheme, ThemeData? darkTheme, ThemeMode? themeMode, Color? color, Locale? locale, Iterable<LocalizationsDelegate>? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, List<Locale>? supportedLocales, bool? useMaterial, bool? useCupertino, bool? switchUI, bool? debugShowMaterialGrid, bool? showPerformanceOverlay, bool? checkerboardRasterCacheImages, bool? checkerboardOffscreenLayers, bool? showSemanticsDebugger, bool? debugShowCheckedModeBanner, Map<LogicalKeySet, Intent>? shortcuts, Map<Type, Action<Intent>>? actions, CustomTransition? customTransition, Map<String, Map<String, String>>? translationsKeys, Translations? translations, TextDirection? textDirection, Locale? fallbackLocale, ValueChanged<Routing?>? routingCallback, Transition? defaultTransition, bool? opaqueRoute, VoidCallback? onInit, VoidCallback? onReady, VoidCallback? onDispose, bool? enableLog, LogWriterCallback? logWriterCallback, bool? popGesture, SmartManagement? smartManagement, Bindings? initialBinding, Duration? transitionDuration, bool? defaultGlobalState, List<GetPage>? getPages, bool? useRouter, GetPage? unknownRoute, ScrollBehavior? scrollBehavior, bool? useInheritedMediaQuery, bool? debugShowWidgetInspector, bool? debugPaintSizeEnabled, bool? debugPaintBaselinesEnabled, bool? debugPaintPointersEnabled, bool? debugPaintLayerBordersEnabled, bool? debugRepaintRainbowEnabled, bool? debugRepaintTextRainbowEnabled, FlutterExceptionHandler? errorHandler, ErrorWidgetBuilder? errorScreen, ReportErrorHandler? errorReport, FlutterExceptionHandler? inErrorHandler, ErrorWidgetBuilder? inErrorScreen, Future<void> inErrorReport(Object exception, StackTrace stack)?, void inInitState()?, Future<bool> inInitAsync()?, void inBinding()?, Widget inHome()?, RouteInformationProvider inRouteInformationProvider()?, RouteInformationParser<Object> inRouteInformationParser()?, RouterDelegate<Object> inRouterDelegate()?, RouterConfig<Object>? inRouterConfig()?, BackButtonDispatcher inBackButtonDispatcher()?, Map<String, WidgetBuilder> inRoutes()?, String inInitialRoute()?, RouteFactory inOnGenerateRoute()?, RouteFactory inOnUnknownRoute()?, List<NavigatorObserver> inNavigatorObservers()?, TransitionBuilder inTransBuilder()?, String inTitle()?, GenerateAppTitle? inGenerateTitle, ThemeData? inTheme()?, CupertinoThemeData? iniOSTheme()?, ThemeData? inDarkTheme()?, ThemeMode? inThemeMode()?, 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? inInheritedMediaQuery()?, void inError(FlutterErrorDetails details)?, bool? inAsyncError(FlutterErrorDetails details)?})
Provide a huge array of options and features to the 'App State object.'

Properties

actions ↔ Map<Type, Action<Intent>>?
getter/setter pairinherited
app ↔ AppObject?
Reference to the 'app' object.
getter/setter pair
backButtonDispatcher ↔ BackButtonDispatcher?
getter/setter pairinherited
binding → void Function()?
Introduce a dependency
final
bindings → List<Function>?
Provide dependencies.
final
builder ↔ TransitionBuilder?
getter/setter pairinherited
checkerboardOffscreenLayers ↔ bool?
getter/setter pairinherited
checkerboardRasterCacheImages ↔ bool?
getter/setter pairinherited
color ↔ Color?
getter/setter pairinherited
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
cupertinoApp ↔ CupertinoApp?
getter/setter pairinherited
cupertinoKey ↔ GlobalKey<State<StatefulWidget>>
Key for the CupertinoApp
getter/setter pair
currentErrorFunc → FlutterExceptionHandler?
Save the current Error Handler.
finalinherited
customTransition ↔ CustomTransition?
getter/setter pairinherited
darkTheme ↔ ThemeData?
getter/setter pairinherited
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
debugPaintBaselinesEnabled ↔ bool?
getter/setter pairinherited
debugPaintLayerBordersEnabled ↔ bool?
getter/setter pairinherited
debugPaintPointersEnabled ↔ bool?
getter/setter pairinherited
debugPaintSizeEnabled ↔ bool?
Highlights UI while debugging.
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
defaultGlobalState ↔ bool?
getter/setter pairinherited
defaultTransition ↔ Transition?
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
enableLog ↔ bool?
getter/setter pairinherited
endState → State<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
fallbackLocale ↔ Locale?
getter/setter pairinherited
getPages ↔ List<GetPage>?
getter/setter pairinherited
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
highContrastDarkTheme ↔ ThemeData?
getter/setter pairinherited
highContrastTheme ↔ ThemeData?
getter/setter pairinherited
home → Widget?
The App's 'home screen'
final
identifier → String
The unique identifier for this State object.
no setterinherited
inActions → Map<Type, Action<Intent>>? Function()?
Returns Map of 'Intent Actions' if any.
final
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.
final
inBackButtonDispatcher → BackButtonDispatcher Function()?
Returns the 'Back Button' routine if any.
final
inBinding → void Function()?
Introduce a dependency
final
inCheckerboardOffscreenLayers → bool? Function()?
Returns 'Off Screen Layers Checkerboard' boolean indicator if any.
final
inCheckerboardRasterCacheImages → bool? Function()?
Returns 'Raster Cache Checkerboard' boolean indicator if any.
final
inColor → Color? Function()?
Returns the App's Color if any.
final
inDarkTheme → ThemeData? Function()?
Returns the App's 'Dark Theme' ThemeData if any.
final
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.
final
inDebugShowMaterialGrid → bool? Function()?
Returns 'Show Material Grid' boolean indicator if any.
final
inError → void Function(FlutterErrorDetails details)?
Returns the App's 'Error Handler' if any.
final
inErrorHandler → FlutterExceptionHandler?
finalinherited
inErrorReport → Future<void> Function(Object exception, StackTrace stack)?
finalinherited
inErrorScreen → ErrorWidgetBuilder?
finalinherited
inGenerateTitle → GenerateAppTitle?
Returns the 'Generate Title' routine if any.
final
inheritedBuilder → _AppInheritedWidget Function(Widget child)
Supply a child Widget to the returning InheritedWidget's child parameter.
finalinherited
inheritedType → Type
Return the 'type' of InheritedWidget
no setterinherited
inHome → Widget Function()?
Returns the home screen if any.
final
inInheritedMediaQuery → bool? Function()?
Returns the App's 'Inherited Media Query' routine if any.
final
inInitAsync → Future<bool> Function()?
Perform asynchronous operations
final
inInitialRoute → String Function()?
Returns the initial Route if any.
final
inInitState → void Function()?
Perform synchronous initialization
final
iniOSTheme → CupertinoThemeData? Function()?
Returns the App's CupertinoThemeData if any.
final
initialBinding ↔ Bindings?
getter/setter pairinherited
initialRoute ↔ String?
getter/setter pairinherited
inLocale → Locale? Function()?
Returns current Locale if any.
final
inLocaleListResolutionCallback → LocaleListResolutionCallback?
Returns 'Locale Resolutions' routine if any.
final
inLocaleResolutionCallback → LocaleResolutionCallback?
Returns 'Local Resolution' routine if any.
final
inLocalizationsDelegates → Iterable<LocalizationsDelegate> Function()?
Returns the 'Localization Delegates' if any.
final
inNavigatorObservers → List<NavigatorObserver> Function()?
Returns a List of Navigation Observers if any.
final
inOnGenerateRoute → RouteFactory Function()?
Returns the 'Generate Routes' routine if any.
final
inOnUnknownRoute → RouteFactory Function()?
Returns the 'Unknown Route' if any.
final
inRestorationScopeId → String? Function()?
Returns the 'Restore Scope Id' routine if any.
final
inRouteInformationParser → RouteInformationParser<Object> Function()?
Returns the Route Parser if any.
final
inRouteInformationProvider → RouteInformationProvider Function()?
Returns the Route Provider if any.
final
inRouterConfig → RouterConfig<Object>? Function()?
Returns the Route Config if any.
final
inRouterDelegate → RouterDelegate<Object> Function()?
Returns the Route Delegate if any.
final
inRoutes → Map<String, WidgetBuilder> Function()?
Returns a Map of Routes if any.
final
inScrollBehavior → ScrollBehavior? Function()?
Returns the App's ScrollBehavior if any.
final
inShortcuts → Map<LogicalKeySet, Intent>? Function()?
Returns Map of 'LogicalKeySets' if any.
final
inShowPerformanceOverlay → bool? Function()?
Returns 'Show Performance Overlay' boolean indicator if any.
final
inShowSemanticsDebugger → bool? Function()?
Returns 'Show Semantics' boolean indicator if any.
final
inSupportedLocales → List<Locale>? Function()?
Returns the Locale Iteration if any.
final
inTheme → ThemeData? Function()?
Returns the App's ThemeData if any.
final
inThemeMode → ThemeMode? Function()?
Returns the App's ThemeMode if any.
final
inTitle → String Function()?
Returns the App's title if any.
final
inTransBuilder → TransitionBuilder Function()?
Returns the 'Transition Builder' if any.
final
iOSTheme ↔ CupertinoThemeData?
getter/setter pairinherited
isCupertino → bool?
Is using the Cupertino Design UI.
no setter
isEndState → bool
This is the 'latest' State being viewed by the App.
no setterinherited
isMaterial → bool?
Is using the Material Design UI.
no setter
key → Key?
The 'App State Objects' Key
final
lastContext → BuildContext?
Returns the 'latest' context in the App.
no setterinherited
locale ↔ Locale?
getter/setter pairinherited
localeListResolutionCallback ↔ LocaleListResolutionCallback?
getter/setter pairinherited
localeResolutionCallback ↔ LocaleResolutionCallback?
getter/setter pairinherited
localizationsDelegates ↔ Iterable<LocalizationsDelegate>?
getter/setter pairinherited
logWriterCallback ↔ LogWriterCallback?
getter/setter pairinherited
materialApp ↔ MaterialApp?
The MaterialApp and CupertinoApp if provided.
getter/setter pairinherited
materialKey ↔ GlobalKey<State<StatefulWidget>>
Key for the MaterialApp;
getter/setter pair
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
All the fields found in the widgets, MaterialApp and CupertinoApp
getter/setter pairinherited
getter/setter pairinherited
onDispose ↔ VoidCallback?
getter/setter pairinherited
onGenerateRoute ↔ RouteFactory?
getter/setter pairinherited
onGenerateTitle ↔ GenerateAppTitle?
getter/setter pairinherited
onInit ↔ VoidCallback?
getter/setter pairinherited
onReady ↔ VoidCallback?
getter/setter pairinherited
onUnknownRoute ↔ RouteFactory?
getter/setter pairinherited
opaqueRoute ↔ bool?
getter/setter pairinherited
parentState ↔ State<StatefulWidget>?
Reference the 'parent' State object
getter/setter pair
paused ↔ bool
State object was in 'paused' state
getter/setter pairinherited
popGesture ↔ bool?
getter/setter pairinherited
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>?
getter/setter pairinherited
routeInformationProvider ↔ RouteInformationProvider?
getter/setter pairinherited
routerConfig ↔ RouterConfig<Object>?
getter/setter pairinherited
routerDelegate ↔ RouterDelegate<Object>?
getter/setter pairinherited
routes ↔ Map<String, WidgetBuilder>?
getter/setter pairinherited
routingCallback ↔ ValueChanged<Routing?>?
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldMessengerKey ↔ GlobalKey<ScaffoldMessengerState>?
getter/setter pairinherited
scrollBehavior ↔ ScrollBehavior?
getter/setter pairinherited
shortcuts ↔ Map<LogicalKeySet, Intent>?
getter/setter pairinherited
showPerformanceOverlay ↔ bool?
getter/setter pairinherited
showSemanticsDebugger ↔ bool?
getter/setter pairinherited
smartManagement ↔ SmartManagement?
getter/setter pairinherited
stackTrace → StackTrace?
The StackTrace
no setterinherited
startState → State<StatefulWidget>?
Return the first State object
no setterinherited
supportedLocales ↔ List<Locale>?
getter/setter pairinherited
switchUI ↔ bool?
Use Cupertino UI in Android and vice versa.
getter/setter pair
textDirection ↔ TextDirection?
getter/setter pairinherited
theme ↔ ThemeData?
getter/setter pairinherited
themeMode ↔ ThemeMode?
getter/setter pairinherited
title ↔ String?
getter/setter pairinherited
transitionDuration ↔ Duration?
getter/setter pairinherited
translations ↔ Translations?
getter/setter pairinherited
translationsKeys ↔ Map<String, Map<String, String>>?
getter/setter pairinherited
unknownRoute ↔ GetPage?
getter/setter pairinherited
useCupertino ↔ bool?
Explicitly use the Cupertino theme
getter/setter pair
useInheritedMediaQuery ↔ bool?
getter/setter pairinherited
useMaterial ↔ bool?
Explicitly use the Material theme
getter/setter pair
useRouter → bool?
final
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. It's been run.
override
buildF(BuildContext context) → Widget
Use this build instead if you don't want to use the built-in InheritedWidget
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) → void
Catch and explicitly handle the error.
inherited
changeUI(String? ui) → void
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
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
dependencies() → void
override
dependOnInheritedWidget(BuildContext? context) → bool
Link a widget to a InheritedWidget of type U
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
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
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
inactiveLifecycleState() → void
Apps in this state should assume that they may be pausedLifecycleState at any time.
inherited
inheritedElement(BuildContext? context) → InheritedElement?
inherited
inheritedNeedsBuild([Object? object]) → void
Call the build() functions of all the dependencies of the _InheritedWidget widget.
inherited
initAsync() → Future<bool>
Used to complete asynchronous operations
override
initInheritedState<V extends InheritedWidget>(V inheritedWidgetBuilder(Widget child)) → InheritedStatefulWidget<InheritedWidget>
Initialize the InheritedWidget State object Create the StatefulWidget to contain the InheritedWidget
inherited
initState() → void
Supply a GlobalKey to the CupertinoApp and the MaterialApp
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.willPop 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() → void
In harmony with Flutter's own API
inherited
onActions() → Map<Type, Action<Intent>>?
Returns Map of 'Intent Actions' if any.
onAsyncError(FlutterErrorDetails details) → void
Supply an 'error handler' routine if something goes wrong in the corresponding runAsync() routine.
inherited
onBackButtonDispatcher() → BackButtonDispatcher?
Returns the 'Back Button' routine if any.
onBuilder() → TransitionBuilder?
Returns the 'Transition Builder' if any.
onCheckerboardOffscreenLayers() → bool?
Returns 'Off Screen Layers Checkerboard' boolean indicator if any.
onCheckerboardRasterCacheImages() → bool?
Returns 'Raster Cache Checkerboard' boolean indicator if any.
onColor() → Color?
Returns the App's Color if any.
onDarkTheme() → ThemeData?
Returns the App's 'Dark Theme' ThemeData if any.
onDebugShowCheckedModeBanner() → bool?
Returns 'Show Debug Banner' boolean indicator if any.
onDebugShowMaterialGrid() → bool?
Returns 'Show Material Grid' boolean indicator if any.
onError(FlutterErrorDetails details) → void
Override if you like to customize error handling.
onErrorHandler(FlutterErrorDetails details) → void
Run the provided Error Handler if any.
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
onHome() → Widget?
Returns the home screen if any.
onInheritedMediaQuery() → bool?
Returns the App's 'Inherited Media Query' routine if any.
onInitialRoute() → String?
Returns the initial Route if any.
oniOSTheme() → CupertinoThemeData?
Returns the App's CupertinoThemeData if any.
onLocale() → Locale?
Returns current Locale if any.
onLocaleListResolutionCallback(List<Locale>? locales, Iterable<Locale> supportedLocales) → Locale?
Returns 'Locale Resolutions' routine if any.
onLocaleResolutionCallback(Locale? locale, Iterable<Locale> supportedLocales) → Locale?
Returns 'Local Resolution' routine if any. Turn to the I10n class to provide the locale.
onLocalizationsDelegates() → Iterable<LocalizationsDelegate>?
Returns the 'Localization Delegates' if any.
onNavigatorKey() → GlobalKey<NavigatorState>
Returns the App's Navigator Key.
onNavigatorObservers() → List<NavigatorObserver>?
Returns a List of Navigation Observers if any.
onOnGenerateRoute() → RouteFactory?
Returns the 'Generate Routes' routine if any.
onOnGenerateTitle(BuildContext context) → GenerateAppTitle?
Returns the 'Generate Title' routine if any.
onOnUnknownRoute() → RouteFactory?
Returns the 'Unknown Route' if any.
onRestorationScopeId() → String?
Returns the 'Restore Scope Id' routine if any.
onRouteInformationParser() → RouteInformationParser<Object>?
Returns the Route Parser if any.
onRouteInformationProvider() → RouteInformationProvider?
Returns the Route Provider if any.
onRouterConfig() → RouterConfig<Object>?
Returns the Route Config if any.
onRouterDelegate() → RouterDelegate<Object>?
Returns the Route Delegate if any.
onRoutes() → Map<String, WidgetBuilder>?
Returns a Map of Routes if any.
onScaffoldMessengerKey() → GlobalKey<ScaffoldMessengerState>
Returns the App's ScaffoldMessenger Key.
onScrollBehavior() → ScrollBehavior?
Returns the App's ScrollBehavior if any.
onShortcuts() → Map<LogicalKeySet, Intent>?
Returns Map of 'LogicalKeySets' if any.
onShowPerformanceOverlay() → bool?
Returns 'Show Performance Overlay' boolean indicator if any.
onShowSemanticsDebugger() → bool?
Returns 'Show Semantics' boolean indicator if any.
onSupportedLocales() → List<Locale>?
Returns the Locale Iteration if any.
onTheme() → ThemeData?
Returns the App's ThemeData if any.
onThemeMode() → ThemeMode?
Returns the App's ThemeMode if any.
onTitle() → String
Returns the App's title if any.
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
inherited
setRootStateX(StateX<StatefulWidget> state) → void
Important to record the 'root' StateX object. Its InheritedWidget!
inherited
setState(VoidCallback fn) → void
Calls the State object's setState() function if not (see class SetState).
inherited
setSuperState(VoidCallback fn) → void
Provide a means to rebuild this State object anyway.
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.
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
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

Operators

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

Static Properties

homeKey ↔ Key
Supply to the 'home' StatefulWidget Allows you to 're-create' the home widget's state object.
getter/setter pair