PageAware class
A widget that is aware of navigation events such as appearing and disappearing.
It uses RouteAware to listen to navigation changes and triggers the provided callbacks accordingly.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- PageAware
Constructors
- PageAware({required Widget child, Key? key, VoidCallback? onAppear, VoidCallback? onDisappear, VoidCallback? onInit, VoidCallback? onDispose, VoidCallback? onAfterFirstFrame, bool? waitForTransition, VoidCallback? onDidPush, VoidCallback? onDidPop})
-
const
Properties
- child → Widget
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onAfterFirstFrame → VoidCallback?
-
Called after the first frame is rendered.
final
- onAppear → VoidCallback?
-
Called when the Next Route has been popped, and this route is now visible.
final
- onDidPop → VoidCallback?
-
Called when the route has been popped.
final
- onDidPush → VoidCallback?
-
Called when the route has been pushed.
final
- onDisappear → VoidCallback?
-
Called when a Next Route has been pushed, and this route is no longer visible.
final
- onDispose → VoidCallback?
-
Called when the widget is disposed.
final
- onInit → VoidCallback?
-
Called when the widget is initialized.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- waitForTransition → bool?
-
If true, wait for the route transition animation to complete
before calling onAfterFirstFrame. Defaults to false.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< PageAware> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited