ModalOverlay class

A specialized, high Z-index container that traps focus and intercepts mouse events.

Inheritance

• Object
• Widget
• Window
• ModalOverlay

Constructors

ModalOverlay({required String title, required int width, required int height, required Rect dialogBounds, required Widget child, required List<FocusNode> modalFocusNodes, void onDismiss()?, Style scrimStyle = const Style(modifiers: Modifier.dim), FocusScopeNode? focusNode, Style borderStyle = Style.empty, Style titleStyle = Style.empty, Style backgroundStyle = Style.empty, bool onKeyEvent(KeyEvent event)?})

Creates a ModalOverlay widget that traps focus within its bounds.

factory

Properties

backgroundStyle → Style

The background style of the window.

final, inherited

borderChars → List<String>

The characters used to draw the window borders.

final, inherited

borderStyle → Style

The style applied to the window borders.

final, inherited

child → Widget

The child widget displayed inside the window.

final, inherited

customOnKeyEvent → bool Function(KeyEvent event)?

An optional custom key event handler for unhandled events in the modal.

final

dialogBounds → Rect

The physical bounding box of the central dialog.

final

focusNode → FocusNode

The focus node representing this window's focus state.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ int

The height of the window.

getter/setter pair, inherited

key → Key?

The optional key for this widget.

final, inherited

modalFocusNodes → List<FocusNode>

The list of child focus nodes managed by this modal.

final

onDismiss → void Function()?

A callback invoked when the user attempts to dismiss the modal (e.g. clicking outside).

final

onKeyEvent → void Function(KeyEvent event)?

Callback triggered when a keyboard event is routed to this window.

no setter, override

onMouseEvent → void Function(MouseEvent event, int localX, int localY)?

Callback triggered when a mouse event hits this window.

no setter, override

onPan → void Function(int dx, int dy)?

Callback triggered when the window is dragged.

final, inherited

onResize → void Function(int dx, int dy)?

Callback triggered when the window is resized.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scrimStyle → Style

The styling for the dimming overlay behind the dialog.

final

showCloseButton → bool

Whether to show the close button x on the top right.

final, inherited

title → String

The title text shown in the window border.

final, inherited

titleStyle → Style

The style applied to the window title.

final, inherited

width ↔ int

The width of the window.

getter/setter pair, inherited

Methods

createElement() → Element

Creates an Element to manage this widget's location in the tree.

override

getIntrinsicHeight(int width) → int

Computes the intrinsic height of this widget under the given width constraint.

inherited

getIntrinsicWidth(int height) → int

Computes the intrinsic width of this widget under the given height constraint.

inherited

isPositionOnTitle(int localX, int localY) → bool

Returns true if the local coordinates localX and localY lie on the title text.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited