NavigatorPopHandler<T> class
Enables the handling of system back gestures.
Typically wraps a nested Navigator widget and allows it to handle system back gestures in the onPop callback.
The type parameter <T> indicates the type of the Route's return value,
which is passed to [onPopWithResult.
{@tool dartpad} This sample demonstrates how to use this widget to properly handle system back gestures when using nested Navigators.
** See code in examples/api/lib/widgets/navigator_pop_handler/navigator_pop_handler.0.dart ** {@end-tool}
{@tool dartpad} This sample demonstrates how to use this widget to properly handle system back gestures with a bottom navigation bar whose tabs each have their own nested Navigators.
** See code in examples/api/lib/widgets/navigator_pop_handler/navigator_pop_handler.1.dart ** {@end-tool}
See also:
- PopScope, which allows toggling the ability of a Navigator to handle pops.
- NavigationNotification, which indicates whether a Navigator in a subtree can handle pops.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- NavigatorPopHandler
- Available extensions
- Annotations
Constructors
-
Creates an instance of NavigatorPopHandler.
const
Properties
- child → Widget
-
The widget to place below this in the widget tree.
final
- enabled → bool
-
Whether this widget's ability to handle system back gestures is enabled or
disabled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- marginZero → Widget
-
Available on Widget, provided by the WidgetMarginX extension
no setter - onPop → VoidCallback?
-
Called when a handleable pop event happens.
final
-
onPopWithResult
→ PopResultCallback<
T> ? -
Called when a handleable pop event happens.
final
- paddingZero → Widget
-
Available on Widget, provided by the WidgetPaddingX extension
no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sliverBox → Widget
-
Available on Widget, provided by the WidgetSliverBoxX extension
no setter
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< NavigatorPopHandler< T> > -
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
-
marginAll(
double margin) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
marginOnly(
{double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
marginSymmetric(
{double horizontal = 0.0, double vertical = 0.0}) → Widget -
Available on Widget, provided by the WidgetMarginX extension
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paddingAll(
double padding) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
paddingOnly(
{double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
paddingSymmetric(
{double horizontal = 0.0, double vertical = 0.0}) → Widget -
Available on Widget, provided by the WidgetPaddingX extension
-
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