OverlayRef class
A handle to manipulate an existing overlay pane.
- Implemented types
Constructors
-
OverlayRef(AsyncApplyState<
HtmlElement> _asyncApplyState, AsyncMeasureSize<HtmlElement> _asyncMeasureSize, PortalHost _delegatePortalHost, HtmlElement containerElement, HtmlElement overlayElement, Function _runOutsideAngular, {OverlayState? state})
Properties
- containerElement → HtmlElement
-
The .acx-overlay-container element where the overlay pane resides.
final
- hasAttached → bool
-
True if the host has a portal attached within.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- isVisible → bool
-
True if the overlay is not display: none.
no setter
-
onPanePressed
→ Stream<
MouseEvent> -
A stream that fires whenever the pane is pressed.
no setter
-
onVisibleChanged
→ Stream<
bool> -
An event stream that fires when the overlay's visibility changes.
no setter
- overlayElement → HtmlElement
-
The .pane element corresponding to this overlay.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → MutableOverlayState
-
The current state of the overlay.
final
- uniqueId → String?
-
A unique ID that represents the overlay pane.
no setter
Methods
-
attach(
Portal< Object?> portal) → Future<Object> -
Attaches
portal
.override -
detach(
) → Future< void> -
Detaches any active portal.
override
-
dispose(
) → void -
Disposes this disposable and any resources it has open.
override
-
measureSizeChanges(
) → Stream< Rectangle< num> > - An event stream that fires when the inner content of the overlay has a dimension or position change.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setPreventInteraction(
[bool? preventInteraction]) → void - Sets whether the overlay should capture events and prevent interaction with the underlying application.
-
setVisible(
[bool? visible]) → void - Sets whether the overlay should be visible.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited