DrawerScaffoldState class
The state of DrawerScaffold, you can use openDrawer and closeDrawer to control the drawer's offset.
- Inheritance
-
- Object
- State<
DrawerScaffold> - DrawerScaffoldState
- Mixed in types
- Available Extensions
Constructors
Properties
- bucket → RestorationBucket?
-
The RestorationBucket used for the restoration data of the
RestorablePropertys registered to this mixin.
no setterinherited
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hasDrawer → bool
-
Returns true if this scaffold has a non-null drawer.
no setter
- hasEndDrawer → bool
-
Returns true if this scaffold has a non-null end drawer.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isDrawerOpen → bool
-
Returns true if the drawer exists and is opened.
no setter
- isEndDrawerOpen → bool
-
Returns true if the end drawer exists and is opened.
no setter
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- restorationId → String?
-
The restoration ID used for the RestorationBucket in which the mixin
will store the restoration data of all registered properties.
no setteroverride
- restorePending → bool
-
Whether restoreState will be called at the beginning of the next build
phase.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scaffoldState → ScaffoldState?
-
Returns the origin ScaffoldState of this widget.
no setter
- widget → DrawerScaffold
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
addOnDrawerChangedListener(
void callback(bool)) → void - Adds drawer changed listener to DrawerScaffold, which will be invoked when the DrawerScaffold.drawer is opened or closed.
-
addOnEndDrawerChangedListener(
void callback(bool)) → void - Adds end drawer changed listener to DrawerScaffold, which will be invoked when the DrawerScaffold.endDrawer is opened or closed.
-
addOnPhysicsControllerChangedListener(
void callback()) → void - Adds physics controller changed listener to DrawerScaffold, which will be invoked when something in DrawerScaffold.physicsController changed.
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
closeDrawer(
) → void - Closes the drawer manually if it exists.
-
closeEndDrawer(
) → void - Closes the end drawer manually if it exists.
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didToggleBucket(
RestorationBucket? oldBucket) → void -
Called when bucket switches between null and non-null values.
inherited
-
didUpdateRestorationId(
) → void -
Must be called when the value returned by restorationId changes.
inherited
-
didUpdateWidget(
covariant DrawerScaffold oldWidget) → void -
Called whenever the widget configuration changes.
override
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited
-
initState(
) → void -
Called when this object is inserted into the tree.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openDrawer(
) → void - Opens the drawer manually if it exists.
-
openEndDrawer(
) → void - Opens the end drawer manually if it exists.
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
registerForRestoration(
RestorableProperty< Object?> property, String restorationId) → void -
Registers a RestorableProperty for state restoration.
inherited
-
removeOnDrawerChangedListener(
void callback(bool)) → void - Removes the drawer changed listener from DrawerScaffold.
-
removeOnEndDrawerChangedListener(
void callback(bool)) → void - Removes the end drawer changed listener from DrawerScaffold.
-
removeOnPhysicsControllerChangedListener(
void callback()) → void - Removes the physics controller changed listener from DrawerScaffold.
-
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.
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
-
unregisterFromRestoration(
RestorableProperty< Object?> property) → void -
Unregisters a RestorableProperty from state restoration.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited