OverlayState class

The current state of an Overlay.

Used to insert OverlayEntrys into the overlay using the insert and insertAll functions.

Inheritance
Mixed in types

Constructors

OverlayState()

Properties

context → BuildContext
The location in the tree where this widget builds. [...]
read-only, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
mounted → bool
Whether this State object is currently in a tree. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
widget → Overlay
The current configuration. [...]
read-only, inherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget. [...]
override
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
override
debugIsVisible(OverlayEntry entry) → bool
(DEBUG ONLY) Check whether a given entry is visible (i.e., not behind an opaque entry). [...]
initState() → void
Called when this object is inserted into the tree. [...]
override
insert(OverlayEntry entry, { OverlayEntry above }) → void
Insert the given entry into the overlay. [...]
insertAll(Iterable<OverlayEntry> entries, { OverlayEntry above }) → void
Insert all the entries in the given iterable. [...]
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback. [...]
inherited
deactivate() → void
Called when this object is removed from the tree. [...]
@mustCallSuper, @protected, inherited
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
inherited
didUpdateWidget(covariant Overlay oldWidget) → void
Called whenever the widget configuration changes. [...]
@mustCallSuper, @protected, inherited
dispose() → void
Called when this object is removed from the tree permanently. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload. [...]
@mustCallSuper, @protected, inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed. [...]
@protected, inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode. [...]
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited