OverlayWidgetState class Null safety

OverlayWidgetState is used with a GlobalKey to get the current OverlayBuilder's state for showing, removing or known when it is showing an overlay widget.

Inheritance

Constructors

OverlayWidgetState()
OverlayWidgetState constructor is used to create a new state and be handled with a GlobalKey to get the current OverlayBuilder's state for showing, removing or known when it is showing an overlay widget.

Properties

constraints BoxConstraints
constraints is used internally.
@protectedwrite-onlyinherited
context BuildContext
The location in the tree where this widget builds.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
isShowing bool
isShowing is used to known when the overlay is showing.
read-onlyinherited
mounted bool
Whether this State object is currently in a tree.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
widget OverlayBuilder
The current configuration.
read-onlyinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
deactivate() → void
Called when this object is removed from the tree.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
didUpdateWidget(covariant OverlayBuilder oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
initState() → void
Called when this object is inserted into the tree.
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.
remove() → void
remove is used to remove the OverlayBuilder.overlayChild widget when it is overlaying its screen or child.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
@protectedinherited
show([dynamic _]) → void
show is used to show the OverlayBuilder.overlayChild widget overlaying its screen or child.
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
toggle() → void
toggle is used to show or remove the OverlayBuilder.overlayChild widget.
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