OverlayWindow class

  • 描述: Overlay 工具类。
Inheritance

Constructors

OverlayWindow({required BuildContext context, required GlobalKey<State<StatefulWidget>> targetKey, OverlayPopDirection popDirection = OverlayPopDirection.bottom, Widget content = const SizedBox.shrink()})
const

Properties

content → Widget
要展示的内容
final
context → BuildContext
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
popDirection → OverlayPopDirection
OverlayWindow 相对于 key 的展示位置， 默认 bottom
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targetKey → GlobalKey<State<StatefulWidget>>
锚点 Widget 的 key，用于 OverlayWindow 的定位
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
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, int wrapWidth = 65}) → 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

Static Methods

showOverlayWindow(BuildContext context, GlobalKey<State<StatefulWidget>>? targetKey, {Widget? content, OverlayPopDirection popDirection = OverlayPopDirection.bottom, bool autoDismissOnTouchOutSide = true, Function? onDismiss}) → OverlayController?
OverlayWindow 工具方发，用于快速弹出 Overlay， 返回 OverlayController 用于控制 Overlaywindow 的隐藏 targetKey 锚点 Widget 的 key，用于 OverlayWindow 的定位 popDirection OverlayWindow 相对于 key 的展示位置， 默认 bottom content 要展示的内容 autoDismissOnTouchOutSide 点击 OverlayWindow 外部是否自动消失，默认为 true onDismiss OverlayWindow 消失回调