FModalBarrier class
A widget that prevents the user from interacting with widgets behind itself.
The modal barrier is the scrim that is rendered behind each route, which generally prevents the user from interacting with the route below the current route, and normally partially obscures such routes.
For example, when a dialog is on the screen, the page below the dialog is usually darkened by the modal barrier.
See also:
- FAnimatedModalBarrier, which is similar but takes an additional Animation.
Implementation details:
This class is a copy of ModalBarrier from Flutter 3.32.1 with the following enhancements:
- support for ImageFilters instead of just solid colors.
- merge ModalBarrier.dismissible and ModalBarrier.onDismiss.
- inlined
_ModalBarrierGestureDetector.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- FModalBarrier
Constructors
-
FModalBarrier.new({required ImageFilter? filter, required VoidCallback? onDismiss, String? semanticsLabel, bool? barrierSemanticsDismissible = true, ValueNotifier<
EdgeInsets> ? clipDetailsNotifier, String? semanticsOnTapHint, Key? key}) -
Creates a widget that blocks user interaction.
const
Properties
- barrierSemanticsDismissible → bool?
-
Whether the modal barrier semantics are included in the semantics tree.
final
-
clipDetailsNotifier
→ ValueNotifier<
EdgeInsets> ? -
Contains a value of type EdgeInsets that specifies how the
SemanticsNode.rect of the widget should be clipped.
final
- filter → ImageFilter?
-
If non-null, applies the given ImageFilter to the barrier.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onDismiss → VoidCallback?
-
Called when the barrier is being dismissed. Defaults to popping the current route from the ambient Navigator.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticsLabel → String?
-
Semantics label used for the barrier if it is dismissible.
final
- semanticsOnTapHint → String?
-
The semantic hint text that informs users what will happen if they tap on the widget. Announced in the format of
'Double tap to ...'.
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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.
override
-
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