ScaffoldMessengerState class Null safety
State for a ScaffoldMessenger.
A ScaffoldMessengerState object can be used to showSnackBar or showMaterialBanner for every registered Scaffold that is a descendant of the associated ScaffoldMessenger. Scaffolds will register to receive SnackBars and MaterialBanners from their closest ScaffoldMessenger ancestor.
Typically obtained via ScaffoldMessenger.of.
- Inheritance
- Object
- State<
ScaffoldMessenger> - ScaffoldMessengerState
- Mixed in types
Constructors
Properties
- 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 → ScaffoldMessenger
-
The current configuration. [...]
read-only, inherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate. [...]
inherited
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget. [...]
override
-
clearMaterialBanners(
) → void - Removes all the materialBanners currently in queue by clearing the queue and running normal exit animation on the current materialBanner.
-
clearSnackBars(
) → void - Removes all the snackBars currently in queue by clearing the queue and running normal exit animation on the current snackBar.
-
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
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes. [...]
override
-
didUpdateWidget(
covariant ScaffoldMessenger oldWidget) → void -
Called whenever the widget configuration changes. [...]
@mustCallSuper, @protected, inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently. [...]
override
-
hideCurrentMaterialBanner(
{MaterialBannerClosedReason reason = MaterialBannerClosedReason.hide}) → void - Removes the current MaterialBanner by running its normal exit animation. [...]
-
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. [...]
@mustCallSuper, @protected, 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
-
removeCurrentMaterialBanner(
{MaterialBannerClosedReason reason = MaterialBannerClosedReason.remove}) → void - Removes the current MaterialBanner (if any) immediately from registered Scaffolds. [...]
-
removeCurrentSnackBar(
{SnackBarClosedReason reason = SnackBarClosedReason.remove}) → void - Removes the current SnackBar (if any) immediately from registered Scaffolds. [...]
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed. [...]
@protected, inherited
-
showMaterialBanner(
MaterialBanner materialBanner) → ScaffoldFeatureController< MaterialBanner, MaterialBannerClosedReason> -
Shows a
MaterialBanner
across all registered Scaffolds. [...] -
showSnackBar(
SnackBar snackBar) → ScaffoldFeatureController< SnackBar, SnackBarClosedReason> -
Shows a
SnackBar
across all registered Scaffolds. [...] -
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