Route<T> class abstract

Abstract base class for routes managed by a Navigator.

A route represents a single screen or modal in the navigation stack. Each route produces one or more OverlayEntry objects that are inserted into the navigator's Overlay.

Subclasses must implement createOverlayEntries to define what overlay entries the route contributes.

Constructors

Route({RouteSettings? settings})

Creates a route with the given settings.

Properties

completer ↔ Completer<T?>?

The Completer that completes when this route is popped.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

navigator ↔ dynamic

Back-reference to the NavigatorState managing this route.

getter/setter pair

overlayEntries → List<OverlayEntry>

The overlay entries this route has created.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

settings → RouteSettings

Metadata for this route (name, arguments).

final

Methods

canPop() → bool

Whether this route can be popped.

createOverlayEntries() → Iterable<OverlayEntry>

Creates the overlay entries for this route.

dispose() → void

Disposes this route, removing all its overlay entries.

install() → void

Installs this route, creating its overlay entries.

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