OverlayBuilder class
OverlayBuilder is used to display an overlay widget based on its type.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- OverlayBuilder
Constructors
- OverlayBuilder({Key? key, required Widget overlayChild, required Widget child, bool initialShow = false, bool maintainState = false, bool opaque = false, OverlayType type = OverlayType.positioned, OverlayAlignment alignment = OverlayAlignment.bottomCenter, double verticalSpacing = .0, double horizontalSpacing = .0})
-
OverlayBuilder constructor is used to create a new widget to handle the
overlay widget based on its type.
const
Properties
- alignment → OverlayAlignment
-
alignment is used to align the overlayChild based on its child's
constraints when type is OverlayType.positioned. Defaults to
OverlayAlignment.bottomCenter.
final
- child → Widget
-
child is used to get the current widget that the OverlayBuilder is
wrapping and then display it in the application interface.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- horizontalSpacing → double
-
horizontalSpacing is used to add padding horizontally to its
overlayChild when type is OverlayType.positioned. Defaults to
0.0
, can be negative.final - initialShow → bool
-
initialShow when true, then it will build the overlayChild on the
first frame. Defaults to
false
.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- maintainState → bool
-
Whether this entry must be included in the tree even if there is a fully
opaque entry above it.
final
- opaque → bool
-
Whether this entry occludes the entire overlay.
final
- overlayChild → Widget
-
overlayChild is used to get the current overlay
widget. When it changes the current overlay will be updated.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → OverlayType
-
type is used to render the overlay widget based on its type. If it is
OverlayType.fullscreen then will render an overlay widget that overlays
the entire screen, else if it is OverlayType.positioned then will render
an overlay widget that overlays its child. Defaults to
OverlayType.positioned.
final
- verticalSpacing → double
-
verticalSpacing is used to add padding vertically to its overlayChild
when type is OverlayType.positioned. Defaults to
0.0
, can be negative.final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → OverlayWidgetState -
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