BackdropScaffoldState class

This class is used to represent the internal state of BackdropScaffold.

It provides access to the functionality for triggering backdrop. As well it offers ways to retrieve the current state of the BackdropScaffold's front- or back layers (concealed/revealed).

An instance of this class is automatically created with the use of BackdropScaffold and can be accessed using Backdrop.of(context) from within the widget tree below BackdropScaffold.

Inheritance
Mixed-in types

Constructors

BackdropScaffoldState()

Properties

animationController → AnimationController
AnimationController used for the backdrop animation.
no setter
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isBackLayerConcealed → bool
Whether the back layer is concealed or not.
no setter
isBackLayerRevealed → bool
Whether the back layer is revealed or not.
no setter
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldKey ↔ GlobalKey<ScaffoldState>
Key for accessing the underlying ScaffoldState.
getter/setter pair
widget → BackdropScaffold
The current configuration.
no setterinherited

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
concealBackLayer() → void
Animates the back layer to the "concealed" state.
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
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
didUpdateWidget(covariant BackdropScaffold oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
fling() → void
Toggles the backdrop functionality.
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
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
revealBackLayer() → void
Animates the back layer to the "revealed" state.
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

Operators

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