WatchBoxBuilder class

A general-purpose widget which rebuilds itself when the box or a specific key change.

Deprecated: Use ValueListenableBuilder and box.listenable() instead

Inheritance
Available extensions
Annotations
  • @Deprecated('Use [ValueListenableBuilder] and `box.listenable()` instead')

Constructors

WatchBoxBuilder({Key? key, required Box box, required BoxWidgetBuilder builder, List<String>? watchKeys})
Creates a widget that rebuilds itself when a value in the box changes.

Properties

box → Box
The box which should be watched.
final
builder → BoxWidgetBuilder
Called every time the box changes. The builder must not return null.
final
expand → SizedBox

Available on Widget, provided by the ExtensionWidget extension

no setter
expanded → Expanded

Available on Widget, provided by the ExtensionWidget extension

no setter
flexible → Flexible

Available on Widget, provided by the ExtensionWidget extension

no setter
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shrink → SizedBox

Available on Widget, provided by the ExtensionWidget extension

no setter
toExpansionTilesRotationIconBuilder → ExpansionTilesRotationIconBuilder

Available on Widget, provided by the ExtensionExpansionTiles extension

no setter
toLoadingBuilder → LoadingBuilder

Available on Widget, provided by the ExtensionWidget extension

no setter
toRoutePageBuilder → RoutePageBuilder

Available on Widget, provided by the ExtensionWidget extension

no setter
toRouteTransitionsBuilder → RouteTransitionsBuilder

Available on Widget, provided by the ExtensionWidget extension

no setter
toSliverBox → Widget

Available on Widget, provided by the ExtensionWidget extension

no setter
toToastBuilder → ToastBuilder

Available on Widget, provided by the ExtensionWidget extension

no setter
toToggleRotateIconBuilder → ToggleRotateIconBuilder

Available on Widget, provided by the ExtensionWidgetToggleRotate extension

no setter
toWidgetBuilder → WidgetBuilder

Available on Widget, provided by the ExtensionWidget extension

no setter
watchKeys → List<String>?
Specifies which keys should be watched.
final

Methods

align({Key? key, Alignment alignment = Alignment.center, double? widthFactor, double? heightFactor}) → Align

Available on Widget, provided by the ExtensionWidget extension

aspectRatio(double aspectRatio, {Key? key}) → AspectRatio

Available on Widget, provided by the ExtensionWidget extension

backdropFilter({Key? key, ImageFilter? filter, double fuzzyDegree = 4}) → BackdropFilter

Available on Widget, provided by the ExtensionWidget extension

card({Color? color, Color? shadowColor, double? elevation, ShapeBorder? shape, bool? borderOnForeground, EdgeInsetsGeometry? margin, Clip? clipBehavior, bool? semanticContainer}) → Card

Available on Widget, provided by the ExtensionWidget extension

center({Key? key, double? widthFactor, double? heightFactor}) → Center

Available on Widget, provided by the ExtensionWidget extension

clipOval({Key? key, BorderRadius borderRadius = BorderRadius.zero, CustomClipper<Rect>? clipper, Clip clipBehavior = Clip.antiAlias}) → ClipOval

Available on Widget, provided by the ExtensionWidget extension

clipPath({Key? key, BorderRadius borderRadius = BorderRadius.zero, CustomClipper<Path>? clipper, Clip clipBehavior = Clip.antiAlias}) → ClipPath

Available on Widget, provided by the ExtensionWidget extension

clipRRect({Key? key, BorderRadius borderRadius = BorderRadius.zero, CustomClipper<RRect>? clipper, Clip clipBehavior = Clip.antiAlias}) → ClipRRect

Available on Widget, provided by the ExtensionWidget extension

color(Color color, {Key? key}) → ColoredBox

Available on Widget, provided by the ExtensionWidget extension

constrainedBox(BoxConstraints constraints, {Key? key}) → ConstrainedBox

Available on Widget, provided by the ExtensionWidget extension

container({Key? key, EdgeInsetsGeometry? padding, Decoration? foregroundDecoration, Matrix4? transform, BoxConstraints? constraints, Color? color, double? width, double? height, EdgeInsetsGeometry? margin, Decoration? decoration, Clip? clipBehavior, AlignmentGeometry? alignment}) → Container

Available on Widget, provided by the ExtensionWidget extension

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _WatchBoxBuilderState
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
decoratedBox(Decoration decoration, {Key? key, DecorationPosition position = DecorationPosition.background}) → DecoratedBox

Available on Widget, provided by the ExtensionWidget extension

fittedBox({Key? key, BoxFit fit = BoxFit.contain, AlignmentGeometry alignment = Alignment.center, Clip clipBehavior = Clip.none}) → FittedBox

Available on Widget, provided by the ExtensionWidget extension

fromSize(Size size, {Key? key}) → SizedBox

Available on Widget, provided by the ExtensionWidget extension

gestureDetector({Key? key, GestureTapDownCallback? onTapDown, GestureTapUpCallback? onTapUp, GestureTapCallback? onTap, GestureTapCancelCallback? onTapCancel, GestureTapDownCallback? onSecondaryTapDown, GestureTapUpCallback? onSecondaryTapUp, GestureTapCancelCallback? onSecondaryTapCancel, GestureTapCallback? onDoubleTap, GestureLongPressCallback? onLongPress, GestureLongPressStartCallback? onLongPressStart, GestureLongPressMoveUpdateCallback? onLongPressMoveUpdate, GestureLongPressUpCallback? onLongPressUp, GestureLongPressEndCallback? onLongPressEnd, GestureDragDownCallback? onVerticalDragDown, GestureDragStartCallback? onVerticalDragStart, GestureDragUpdateCallback? onVerticalDragUpdate, GestureDragEndCallback? onVerticalDragEnd, GestureDragCancelCallback? onVerticalDragCancel, GestureDragDownCallback? onHorizontalDragDown, GestureDragStartCallback? onHorizontalDragStart, GestureDragUpdateCallback? onHorizontalDragUpdate, GestureDragEndCallback? onHorizontalDragEnd, GestureDragCancelCallback? onHorizontalDragCancel, GestureForcePressStartCallback? onForcePressStart, GestureForcePressPeakCallback? onForcePressPeak, GestureForcePressUpdateCallback? onForcePressUpdate, GestureForcePressEndCallback? onForcePressEnd, GestureDragDownCallback? onPanDown, GestureDragStartCallback? onPanStart, GestureDragUpdateCallback? onPanUpdate, GestureDragEndCallback? onPanEnd, GestureDragCancelCallback? onPanCancel, GestureScaleStartCallback? onScaleStart, GestureScaleUpdateCallback? onScaleUpdate, GestureScaleEndCallback? onScaleEnd, HitTestBehavior? behavior, bool excludeFromSemantics = false, DragStartBehavior dragStartBehavior = DragStartBehavior.start, Set<PointerDeviceKind>? supportedDevices, bool trackpadScrollCausesScale = false, Offset trackpadScrollToScaleFactor = kDefaultTrackpadScrollToScaleFactor}) → GestureDetector

Available on Widget, provided by the ExtensionWidget extension

hero(Object tag, {Key? key, CreateRectTween? createRectTween, HeroFlightShuttleBuilder? flightShuttleBuilder, HeroPlaceholderBuilder? placeholderBuilder, bool transitionOnUserGestures = false}) → Hero

Available on Widget, provided by the ExtensionWidget extension

interceptNotificationListener<T extends Notification>({NotificationListenerCallback<T>? onNotification}) → Widget

Available on Widget, provided by the ExtensionNotificationListener extension

limitedBox({Key? key, double maxWidth = double.infinity, double maxHeight = double.infinity}) → LimitedBox

Available on Widget, provided by the ExtensionWidget extension

margin(EdgeInsetsGeometry margin, {Key? key}) → Padding

Available on Widget, provided by the ExtensionWidget extension

marginAll(double margin) → Widget

Available on Widget, provided by the ExtensionWidget 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 ExtensionWidget extension

marginSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the ExtensionWidget extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
offstage(bool offstage, {Key? key}) → Offstage

Available on Widget, provided by the ExtensionWidget extension

onDoubleTap(GestureTapCallback onDoubleTap, {Key? key}) → GestureDetector

Available on Widget, provided by the ExtensionWidget extension

onLongPress(GestureLongPressCallback onLongPress, {Key? key}) → GestureDetector

Available on Widget, provided by the ExtensionWidget extension

onTap(GestureTapCallback? onTap, {Key? key}) → GestureDetector

Available on Widget, provided by the ExtensionWidget extension

overflowBox({Key? key, Alignment alignment = Alignment.center, double? minWidth, double? maxWidth, double? minHeight, double? maxHeight}) → OverflowBox

Available on Widget, provided by the ExtensionWidget extension

padding(EdgeInsetsGeometry padding) → Padding

Available on Widget, provided by the ExtensionWidget extension

paddingAll(double padding) → Widget

Available on Widget, provided by the ExtensionWidget 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 ExtensionWidget extension

paddingSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget

Available on Widget, provided by the ExtensionWidget extension

popupBottomSheet<T>({WidgetBuilder? builder, BottomSheetOptions? options}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

showModalBottomSheet 关闭 closePopup()
popupCupertinoDialog<T>({WidgetBuilder? builder, DialogOptions? options}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

Cupertino 风格的 Dialog showCupertinoDialog
popupCupertinoModal<T>({WidgetBuilder? builder, CupertinoModalPopupOptions? options}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

全屏显示 showCupertinoModalPopup
popupDialog<T>({RoutePageBuilder? builder, DialogOptions? options}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

showGeneralDialog
popupMaterialDialog<T>({WidgetBuilder? builder, DialogOptions? options}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

Material 风格的 Dialog showDialog
positioned({Key? key, double? left, double? top, double? right, double? bottom, double? width, double? height}) → Positioned

Available on Widget, provided by the ExtensionWidget extension

push<T extends Object?>(Widget widget, {PageRouteOptions options = const PageRouteOptions.material()}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

push
pushAndRemoveUntil<T extends Object?>(Widget widget, {PageRouteOptions options = const PageRouteOptions.material(), required RoutePredicate predicate}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

pushAndRemoveUntil
pushReplacement<T extends Object?, TO extends Object?>(Widget widget, {PageRouteOptions options = const PageRouteOptions.material(), TO? result}) → Future<T?>

Available on Widget, provided by the ExtensionWidgetMethod extension

pushReplacement
rotatedBox(int quarterTurns, {Key? key}) → RotatedBox

Available on Widget, provided by the ExtensionWidget extension

setHeight(double height, {Key? key}) → SizedBox

Available on Widget, provided by the ExtensionWidget extension

setPreferredHeight(double height, {Key? key}) → PreferredSize

Available on Widget, provided by the ExtensionWidget extension

setPreferredSize(Size size, {Key? key}) → PreferredSize

Available on Widget, provided by the ExtensionWidget extension

setPreferredWidth(double width, {Key? key}) → PreferredSize

Available on Widget, provided by the ExtensionWidget extension

setSize(Size size, {Key? key}) → SizedBox

Available on Widget, provided by the ExtensionWidget extension

setWidth(double width, {Key? key}) → SizedBox

Available on Widget, provided by the ExtensionWidget extension

showOverlay({bool isCached = true}) → FlOverlayEntry?

Available on Widget, provided by the ExtensionWidgetMethod extension

FlOverlay().show()
sizedBox({Key? key, double? width, double? height}) → SizedBox

Available on Widget, provided by the ExtensionWidget extension

sizedOverflowBox(Size size, {Key? key, Alignment alignment = Alignment.center}) → SizedOverflowBox

Available on Widget, provided by the ExtensionWidget extension

statusBarStyle(SystemUiOverlayStyle style) → AnnotatedRegion<SystemUiOverlayStyle>

Available on Widget, provided by the ExtensionWidget extension

toDecoratorPendant({DecoratorPendantPosition positioned = DecoratorPendantPosition.outer, DecoratorPendantVisibilityMode mode = DecoratorPendantVisibilityMode.always, bool maintainSize = false}) → DecoratorPendant

Available on Widget, provided by the ExtensionWidgetDecoratorBox 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
unconstrainedBox({Key? key, TextDirection? textDirection, Alignment alignment = Alignment.center, Axis? constrainedAxis}) → UnconstrainedBox

Available on Widget, provided by the ExtensionWidget extension

visibility(bool visible, {Key? key}) → Visibility

Available on Widget, provided by the ExtensionWidget extension

Operators

operator ==(Object other) → bool
The equality operator.
inherited