ScaffoldState class Null safety

State for a Scaffold.

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

Inheritance
Mixed in types

Constructors

ScaffoldState()

Properties

appBarMaxHeight → double?
The max height the Scaffold.appBar uses.
read-only
bucket → RestorationBucket?
The RestorationBucket used for the restoration data of the RestorablePropertys registered to this mixin.
read-onlyinherited
context → BuildContext
The location in the tree where this widget builds.
read-onlyinherited
hasAppBar → bool
Whether this scaffold has a non-null Scaffold.appBar.
read-only
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
hasFloatingActionButton → bool
Whether this scaffold has a non-null Scaffold.floatingActionButton.
read-only
hashCode → int
The hash code for this object.
read-onlyinherited
isDrawerOpen → bool
Whether the Scaffold.drawer is opened.
read-only
isEndDrawerOpen → bool
Whether the Scaffold.endDrawer is opened.
read-only
mounted → bool
Whether this State object is currently in a tree.
read-onlyinherited
restorationId → String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties.
read-onlyoverride
restorePending → bool
Whether restoreState will be called at the beginning of the next build phase.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
widget → Scaffold
The current configuration.
read-onlyinherited

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
closeDrawer() → void
Closes Scaffold.drawer if it is currently opened.
closeEndDrawer() → void
Closes Scaffold.endDrawer if it is currently opened.
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
override
didToggleBucket(RestorationBucket? oldBucket) → void
Called when bucket switches between null and non-null values.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didUpdateRestorationId() → void
Must be called when the value returned by restorationId changes.
protected">@protectedinherited
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
initState() → void
Called when this object is inserted into the tree.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
openDrawer() → void
Opens the Drawer (if any).
openEndDrawer() → void
Opens the end side Drawer (if any).
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
registerForRestoration(RestorableProperty<Object?> property, String restorationId) → void
Registers a RestorableProperty for state restoration.
protected">@protectedinherited
restoreState(RestorationBucket? oldBucket, bool initialRestore) → void
Called to initialize or restore the RestorablePropertys used by the State object.
override
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
protected">@protectedinherited
showBodyScrim(bool value, double opacity) → void
Whether to show a ModalBarrier over the body of the scaffold.
showBottomSheet<T>(WidgetBuilder builder, {Color? backgroundColor, double? elevation, ShapeBorder? shape, Clip? clipBehavior, BoxConstraints? constraints, bool? enableDrag, AnimationController? transitionAnimationController}) → PersistentBottomSheetController<T>
Shows a Material Design bottom sheet in the nearest Scaffold. To show a persistent bottom sheet, use the Scaffold.bottomSheet.
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
unregisterFromRestoration(RestorableProperty<Object?> property) → void
Unregisters a RestorableProperty from state restoration.
protected">@protectedinherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited