InheritedStateMVC<T extends StatefulWidget, U extends InheritedWidget> class
abstract
A StateMVC object but inserts a InheritedWidget into the Widget tree.
- Inheritance
-
- Object
- State<
StatefulWidget> - StateMVC<
T> - InheritedStateMVC
- Implemented types
- Mixed-in types
Constructors
- InheritedStateMVC({required U inheritedBuilder(Widget child), ControllerMVC? controller})
Properties
- 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
- currentErrorFunc → FlutterExceptionHandler?
-
Save the current Error Handler.
finalinherited
- 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
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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
- inheritedBuilder → U Function(Widget child)
-
Supply a child Widget to the returning InheritedWidget's child parameter.
final
-
inheritedStatefulWidget
→ InheritedStatefulWidget<
InheritedWidget> -
Provide access to the 'InheritedWidget' StatefulWidget
no setterinherited
- inheritedType → Type
-
Return the 'type' of InheritedWidget
no setter
- keyId → String
-
The unique key identifier for this State object.
no setterinherited
- lastContext → BuildContext?
-
Returns the 'latest' context in the App.
no setterinherited
-
map
→ Map<
String, ControllerMVC> -
Returns a Map containing all the 'Controllers' associated with this
StateMVC object each with their unique 'key' identifier.
no setterinherited
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- 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
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- 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 -
Run the CircularProgressIndicator() until asynchronous operations are
completed before the app proceeds.
override
-
buildChild(
BuildContext context) → Widget -
Build the 'child' Widget passed to the InheritedWidget.
override
-
buildInherited(
) → void -
Rebuild the InheritedWidget and its dependencies.
override
-
buildWidget(
BuildContext context) → Widget -
Implement this function instead of the build() function
to utilize a built-in FutureBuilder.
override
-
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
-
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
-
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 callingdidUpdateWidget
, which means any calls tosetState
indidUpdateWidget
are redundant.inherited -
dispose(
) → void -
The framework calls this method when this
StateMVC
object will never build again and will be disposed of.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
-
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 -
The framework will call this method exactly once.
Only when the
StateMVC
object is first created.inherited -
listControllers(
List< String> keys) → List<ControllerMVC?> -
Returns the list of 'Controllers' associated with this StateMVC object.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyClients(
) → void - In harmony with Flutter's own API
-
onAsyncError(
FlutterErrorDetails details) → bool -
Supply an 'error handler' routine if something goes wrong
in the corresponding initAsync() routine.
inherited
-
onError(
FlutterErrorDetails details) → void -
Supply an 'error handler' routine to fire when an error occurs.
Allows the user to define their own with each StateMVC object.
inherited
-
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.
This provides an opportunity to reinitialize any data that was prepared
in the initState method.
inherited
-
refresh(
) → void -
Inline with 'older' frameworks
override
-
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 -
Don't rebuild this State object but the State object containing the InheritedWidget.
Rebuild all the dependencies of the _InheritedWidget widget.
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