The current state of an Overlay.

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

Inheritance
Mixes-in
  • TickerProviderStateMixin

Constructors

OverlayState()

Properties

config Overlay

The current configuration.

read-only, inherited
context BuildContext

The location in the tree where this widget builds.

read-only, inherited
hashCode int

Get a 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

Operators

operator ==(other) bool

The equality operator.

inherited

Methods

build(BuildContext context) Widget

Describes the part of the user interface represented by this widget.

debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

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.

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.

inherited
dependenciesChanged() → void

Called when a dependency of this State object changes.

inherited
didUpdateConfig(Overlay oldConfig) → void

Called whenever the configuration changes.

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.

inherited
setState(VoidCallback fn) → void

Notify the framework that the internal state of this object has changed.

inherited
toString() String

Returns a string representation of this object.

inherited