ScaffoldState class

State for a Scaffold.

Can display SnackBars and BottomSheets. Retrieve a ScaffoldState from the current BuildContext using Scaffold.of.

Inheritance
Mixed in types

Constructors

ScaffoldState()

Properties

hasDrawer → bool
Whether this scaffold has a non-null Scaffold.drawer.
read-only
hasEndDrawer → bool
Whether this scaffold has a non-null Scaffold.endDrawer.
read-only
isDrawerOpen → bool
Whether the Scaffold.drawer is opened. [...]
read-only
isEndDrawerOpen → bool
Whether the Scaffold.endDrawer is opened. [...]
read-only
context → BuildContext
The location in the tree where this widget builds. [...]
read-only, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
mounted → bool
Whether this State object is currently in a tree. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
widget → Scaffold
The current configuration. [...]
read-only, inherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget. [...]
override
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
override
didUpdateWidget(covariant Scaffold oldWidget) → void
Called whenever the widget configuration changes. [...]
override
dispose() → void
Called when this object is removed from the tree permanently. [...]
override
hideCurrentSnackBar({SnackBarClosedReason reason: SnackBarClosedReason.hide }) → void
Removes the current SnackBar by running its normal exit animation. [...]
initState() → void
Called when this object is inserted into the tree. [...]
override
openDrawer() → void
Opens the Drawer (if any). [...]
openEndDrawer() → void
Opens the end side Drawer (if any). [...]
removeCurrentSnackBar({SnackBarClosedReason reason: SnackBarClosedReason.remove }) → void
Removes the current SnackBar (if any) immediately. [...]
showBottomSheet<T>(WidgetBuilder builder) → PersistentBottomSheetController<T>
Shows a persistent material design bottom sheet in the nearest Scaffold. [...]
showSnackBar(SnackBar snackbar) → ScaffoldFeatureController<SnackBar, SnackBarClosedReason>
Shows a SnackBar at the bottom of the scaffold. [...]
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback. [...]
inherited
deactivate() → void
Called when this object is removed from the tree. [...]
@mustCallSuper, @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
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload. [...]
@mustCallSuper, @protected, inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed. [...]
@protected, 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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode. [...]
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited