WidgetsApp class
A convenience class that wraps a number of widgets that are commonly required for an application.
One of the primary roles that WidgetsApp provides is binding the system back button to popping the Navigator or quitting the application.
See also: CheckedModeBanner, DefaultTextStyle, MediaQuery, Localizations, Title, Navigator, Overlay, SemanticsDebugger (the widgets wrapped by this one).
- Inheritance
- Object
- Diagnosticable
- DiagnosticableTree
- Widget
- StatefulWidget
- WidgetsApp
Constructors
-
WidgetsApp({Key key, RouteFactory onGenerateRoute, RouteFactory onUnknownRoute, String initialRoute, PageRouteFactory pageRouteBuilder, Widget home, Map<
String, WidgetBuilder> routes: const {} , TransitionBuilder builder, String title: '', GenerateAppTitle onGenerateTitle, TextStyle textStyle, @required Color color, Locale locale, Iterable<LocalizationsDelegate> localizationsDelegates, LocaleListResolutionCallback localeListResolutionCallback, LocaleResolutionCallback localeResolutionCallback, Iterable< Locale> supportedLocales: const [Locale('en', 'US')] , bool showPerformanceOverlay: false, bool checkerboardRasterCacheImages: false, bool checkerboardOffscreenLayers: false, bool showSemanticsDebugger: false, bool debugShowWidgetInspector: false, bool debugShowCheckedModeBanner: true, InspectorSelectButtonBuilder inspectorSelectButtonBuilder }) - Creates a widget that wraps a number of widgets that are commonly required for an application. [...]
Properties
- builder → TransitionBuilder
-
A builder for inserting widgets above the Navigator but below the other
widgets created by the WidgetsApp widget, or for replacing the
Navigator entirely. [...]
final
- checkerboardOffscreenLayers → bool
-
Checkerboards layers rendered to offscreen bitmaps. [...]
final
- checkerboardRasterCacheImages → bool
-
Checkerboards raster cache images. [...]
final
- color → Color
-
The primary color to use for the application in the operating system
interface. [...]
final
- debugShowCheckedModeBanner → bool
-
Turns on a little "DEBUG" banner in checked mode to indicate
that the app is in checked mode. This is on by default (in
checked mode), to turn it off, set the constructor argument to
false. In release mode this has no effect. [...]
final
- debugShowWidgetInspector → bool
-
Turns on an overlay that enables inspecting the widget tree. [...]
final
- home → Widget
-
The widget for the default route of the app (Navigator.defaultRouteName,
which is
/
). [...]final - initialRoute → String
-
The name of the first route to show, if a Navigator is built. [...]
final
- inspectorSelectButtonBuilder → InspectorSelectButtonBuilder
-
Builds the widget the WidgetInspector uses to switch between view and
inspect modes. [...]
final
- locale → Locale
-
The initial locale for this app's Localizations widget is based
on this value. [...]
final
- localeListResolutionCallback → LocaleListResolutionCallback
-
This callback is responsible for choosing the app's locale
when the app is started, and when the user changes the
device's locale. [...]
final
- localeResolutionCallback → LocaleResolutionCallback
-
This callback is responsible for choosing the app's locale
when the app is started, and when the user changes the
device's locale. [...]
final
-
localizationsDelegates
→ Iterable<
LocalizationsDelegate> -
The delegates for this app's Localizations widget. [...]
final
-
A key to use when building the Navigator. [...]
final
-
The list of observers for the Navigator created for this app. [...]
final
- onGenerateRoute → RouteFactory
-
The route generator callback used when the app is navigated to a
named route. [...]
final
- onGenerateTitle → GenerateAppTitle
-
If non-null this callback function is called to produce the app's
title string, otherwise title is used. [...]
final
- onUnknownRoute → RouteFactory
-
Called when onGenerateRoute fails to generate a route, except for the
initialRoute. [...]
final
- pageRouteBuilder → PageRouteFactory
-
The PageRoute generator callback used when the app is navigated to a
named route. [...]
final
-
routes
→ Map<
String, WidgetBuilder> -
The application's top-level routing table. [...]
final
- showPerformanceOverlay → bool
-
Turns on a performance overlay. [...]
final
- showSemanticsDebugger → bool
-
Turns on an overlay that shows the accessibility information
reported by the framework.
final
-
supportedLocales
→ Iterable<
Locale> -
The list of locales that this app has been localized for. [...]
final
- textStyle → TextStyle
-
The default text style for Text in the application.
final
- title → String
-
A one-line description used by the device to identify the app for the user. [...]
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- key → Key
-
Controls how one widget replaces another widget in the tree. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
createState(
) → _WidgetsAppState -
Creates the mutable state for this widget at a given location in the tree. [...]
override
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children. [...]
@protected, inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toDiagnosticsNode(
{String name, DiagnosticsTreeStyle style }) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a string representation of this node and its descendants. [...]
inherited
-
toStringShallow(
{String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a one-line detailed description of the object. [...]
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited
Static Properties
- debugAllowBannerOverride ↔ bool
-
If false, prevents the debug banner from being visible. [...]
read / write
- debugShowWidgetInspectorOverride ↔ bool
-
If true, forces the widget inspector to be visible. [...]
read / write
- showPerformanceOverlayOverride ↔ bool
-
If true, forces the performance overlay to be visible in all instances. [...]
read / write