OverlayBuilder class

Displays an overlay Widget as constructed by the given overlayBuilder.

The overlay built by the overlayBuilder can be conditionally shown and hidden by settings the showOverlay property to true or false.

The overlayBuilder is invoked every time this Widget is rebuilt.

Implementation note: the reason we rebuild the overlay every time our state changes is because there doesn't seem to be any better way to invalidate the overlay itself than to invalidate this Widget. Remember, overlay Widgets exist in OverlayEntrys which are inaccessible to outside Widgets. But if a better approach is found then feel free to use it.

Inheritance

Constructors

OverlayBuilder({Key? key, bool showOverlay = false, WidgetBuilder? overlayBuilder, Widget? child})
const

Properties

child → Widget?
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
overlayBuilder → WidgetBuilder?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showOverlay → bool
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<OverlayBuilder>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
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
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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