AppState<T extends AppStatefulWidgetMVC> class

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

Inheritance
Implementers
Available Extensions

Constructors

AppState({Key? key, Widget? home, AppController? con, List<ControllerMVC>? controllers, Object? object, GlobalKey<NavigatorState>? navigatorKey, RouteInformationProvider? routeInformationProvider, RouteInformationParser<Object>? routeInformationParser, RouterDelegate<Object>? routerDelegate, 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, String? restorationScopeId, ScrollBehavior? scrollBehavior, bool? useInheritedMediaQuery, bool? debugShowWidgetInspector, bool? debugPaintSizeEnabled, bool? debugPaintBaselinesEnabled, bool? debugPaintPointersEnabled, bool? debugPaintLayerBordersEnabled, bool? debugRepaintRainbowEnabled, FlutterExceptionHandler? errorHandler, ErrorWidgetBuilder? errorScreen, ReportErrorHandler? errorReport, Widget inHome()?, RouteInformationProvider inRouteInformationProvider()?, RouteInformationParser<Object> inRouteInformationParser()?, RouterDelegate<Object> inRouterDelegate()?, 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 ↔ App?
Reference to the 'app' object.
getter/setter pair
backButtonDispatcher ↔ BackButtonDispatcher?
getter/setter pairinherited
builder ↔ TransitionBuilder?
getter/setter pairinherited
checkerboardOffscreenLayers ↔ bool?
getter/setter pairinherited
checkerboardRasterCacheImages ↔ bool?
getter/setter pairinherited
color ↔ Color?
getter/setter pairinherited
con → AppController?
finalinherited
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
controller → ControllerMVC?
Provide the 'main' controller to this 'State View.' If _controller == null, get the 'first assigned' controller if any.
no setterinherited
cupertinoKey ↔ GlobalKey<State<StatefulWidget>>
Key for the CupertinoApp
getter/setter pair
currentErrorFunc → FlutterExceptionHandler?
Save the current Error Handler.
finalinherited
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
Readily determine if the State object is possibly to be disposed of.
no setterinherited
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
debugShowCheckedModeBanner ↔ bool?
getter/setter pairinherited
debugShowMaterialGrid ↔ bool?
getter/setter pairinherited
debugShowWidgetInspector ↔ bool?
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
home → Widget?
The App's 'home screen'
final
inActions → (Map<Type, Action<Intent>> Function()?)
Returns Map of 'Intent Actions' if any.
final
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
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
inDebugger → 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
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
inheritedStatefulWidget → InheritedStatefulWidget<InheritedWidget>
Provide access to the 'InheritedWidget' StatefulWidget
no setterinherited
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
inInitialRoute → (String Function()?)
Returns the initial Route if any.
final
iniOSTheme → (CupertinoThemeData Function()?)
Returns the App's CupertinoThemeData if any.
final
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
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?
finalinherited
isCupertino → bool?
Is using the Cupertino Design UI.
no setter
isMaterial → bool?
Is using the Material Design UI.
no setter
key → Key?
The 'App State Objects' Key
final
keyId → String
The unique key identifier for this State object.
no setterinherited
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
map → Map<String, ControllerMVC>
Returns a Map containing all the 'Controllers' associated with this StateMVC object each with their unique 'key' identifier.
no setterinherited
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
onGenerateRoute ↔ RouteFactory?
getter/setter pairinherited
onGenerateTitle ↔ GenerateAppTitle?
getter/setter pairinherited
onUnknownRoute ↔ RouteFactory?
getter/setter pairinherited
parentState ↔ State<StatefulWidget>?
Reference the 'parent' State object
getter/setter pair
restorationScopeId ↔ String?
getter/setter pairinherited
rootCon → ControllerMVC?
Returns 'the first' Controller associated with this StateMVC object. Returns null if empty.
no setterinherited
rootState → AppStateMVC<AppStatefulWidgetMVC>?
Returns the 'first' StateMVC object in the App
no setterinherited
routeInformationParser ↔ RouteInformationParser<Object>?
getter/setter pairinherited
routeInformationProvider ↔ RouteInformationProvider?
getter/setter pairinherited
routerDelegate ↔ RouterDelegate<Object>?
getter/setter pairinherited
routes ↔ Map<String, WidgetBuilder>?
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
supportedLocales ↔ List<Locale>?
getter/setter pairinherited
switchUI ↔ bool?
Use Cupertino UI in Android and vice versa.
getter/setter pair
theme → ThemeData?
finalinherited
themeMode ↔ ThemeMode?
getter/setter pairinherited
title ↔ String?
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
widget → T
You need to be able access the widget.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
add(ControllerMVC? controller) → String
Add a specific Controller to this View. Returns the Controller's unique String identifier.
inherited
addAfterListener(StateListener listener) → bool
Add a listener fired 'after' the main controller runs.
inherited
addBeforeListener(StateListener listener) → bool
Add a listener fired 'before' the main controller runs.
inherited
addConId(ControllerMVC con) → String
Adds a 'Controller' to be associated with this StateMVC object and returns Controller's the unique 'key' identifier assigned to it.
inherited
addList(List<ControllerMVC>? list) → List<String>
Add a list of 'Controllers' to be associated with this StatMVC object.
inherited
addListener(StateListener listener) → bool
Add a listener fired 'after' the main controller runs.
inherited
afterContains(StateListener listener) → bool
Returns true of the listener specified is already added.
inherited
afterList(List<String> keys) → List<StateListener>
Returns the list of 'after' listeners by matching key identifiers.
inherited
afterListener(String key) → StateListener?
Returns the specified 'after' listener.
inherited
beforeContains(StateListener listener) → bool
Returns true of the listener specified is already added.
inherited
beforeList(List<String> keys) → List<StateListener>
Returns a List of 'before' listeners by matching key identifiers.
inherited
beforeListener(String key) → StateListener?
Returns the specified 'before' listener.
inherited
build(BuildContext context) → Widget
Override build to avoid the built-in Future Builder. It's been run.
override
buildChild(BuildContext context) → Widget
Override to impose your own WidgetsApp (like CupertinoApp or MaterialApp)
override
buildInherited() → void
Rebuild the InheritedWidget and its dependencies.
inherited
buildWidget(BuildContext context) → Widget
Use this build instead if you don't want to use the built-in InheritedWidget
inherited
catchError(Exception? ex) → void
Catch and explicitly handle the error.
inherited
changeUI(String? ui) → void
Explicitly change to a particular interface.
contains(ControllerMVC con) → bool
Returns true if the specified 'Controller' is associated with this StateMVC object.
inherited
controllerById(String? keyId) → ControllerMVC?
Retrieve a Controller by its a unique String identifier.
inherited
controllerByType<U extends ControllerMVC>() → U?
Retrieve a Controller in the MVC framework by type.
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
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() funciton is called it's dependencies' build() function are also called but not before their didChangeDependencies() function. Subclasses rarely use this method.
inherited
didChangeLocale(Locale locale) → 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
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
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
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.
getState(String keyId) → StateMVC<StatefulWidget>?
Returns a StateView object using a unique String identifier.
inherited
getStates(List<String> keys) → Map<String, StateMVC<StatefulWidget>>
Returns a Map of StateView objects using unique String identifiers.
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>
Asynchronous operations must complete successfully.
inherited
initInheritedState<U extends InheritedWidget>(U inheritedWidgetBuilder(Widget child)) → void
Traditionally called in the initState() function
inherited
initState() → void
Supply a GlobalKey to the CupertinoApp and the MaterialApp
override
listControllers(List<String> keys) → List<ControllerMVC?>
Returns the list of 'Controllers' associated with this StateMVC object.
inherited
listStates(List<String> keys) → List<StateMVC<StatefulWidget>>
Returns a List of StateView objects using unique String identifiers.
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) → bool
Supply an 'error handler' routine if something goes wrong in the corresponding initAsync() 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.
override
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() → LocaleListResolutionCallback?
Returns 'Locale Resolutions' routine if any.
onLocaleResolutionCallback() → LocaleResolutionCallback?
Returns 'Local Resolution' routine if any. Turn to the I10n class to provide the locale.
onLocalizationsDelegates() → Iterable<LocalizationsDelegate>
Returns the 'Localization Delegates' if any. @mustCallSuper
onNavigatorKey() → GlobalKey<NavigatorState>
Returns the App's Navigator's 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.
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
reassemble() → void
During development, if a hot reload occurs, the reassemble method is called.
override
refresh() → void
Refresh the most 'recent' app. This is to address the possibility an App has called another App.
override
reload() → void
Reload the whole App
remove(String keyId) → bool
Remove a specific associated 'Controller' from this StateMVC object by using its unique 'key' identifier.
inherited
removeListener(StateListener listener) → bool
Removes the specified listener.
inherited
resumedLifecycleState() → void
The application is visible and responding to user input.
inherited
setState(VoidCallback fn) → void
Calls the State object's setState() function if not (see class SetState below).
inherited
setSuperState(VoidCallback fn) → void
Provide a means to rebuild this State object anyway.
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

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