OverlayWidgetState class
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
-
- Object
- State<
OverlayBuilder> - OverlayWidgetState
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.
no getterinherited
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isShowing → bool
-
isShowing is used to known when the overlay is showing.
no setterinherited
- 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
- widget → OverlayBuilder
-
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
-
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 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 nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
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.
inherited
-
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