OverlayPortalController class
A class to show, hide and bring to top an OverlayPortal's overlay child in the target Overlay.
A OverlayPortalController can only be given to at most one OverlayPortal at a time. When an OverlayPortalController is moved from one OverlayPortal to another, its isShowing state does not carry over.
OverlayPortalController.show and OverlayPortalController.hide can be called even before the controller is assigned to any OverlayPortal, but they typically should not be called while the widget tree is being rebuilt.
Constructors
- OverlayPortalController({String? debugLabel})
-
Creates an OverlayPortalController, optionally with a String identifier
debugLabel.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isShowing → bool
-
Whether the associated OverlayPortal should build and show its overlay
child, using its
overlayChildBuilder.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
hide(
) → void - Hide the OverlayPortal's overlay child.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
show(
) → void - Show the overlay child of the OverlayPortal this controller is attached to, at the top of the target Overlay.
-
toggle(
) → void - Convenience method for toggling the current isShowing status.
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited