Box class

Inheritance
Available extensions

Constructors

Box({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Box is something between a Container and a SizedBox. Unlike a Container it can be made const, so it's good for creating colored boxes, with or without padding:
const
Box.b({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .b to the box will make it blue. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.g({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .g to the box will make it green. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.gap(double gap)
Creates a square box with gap by gap pixels. This may be used for small gaps between widgets. For example:
const
Box.r({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .r to the box will make it red. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.rand({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Use the Box.rand constructor to see when the widget rebuilds. It will change its color to a random one, whenever its build method is called. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.y({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .y to the box will make it yellow. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const

Properties

alignment → AlignmentGeometry?
final
child → Widget?
final
color → Color?
final
decoration → Decoration?
final
decorationPosition → DecorationPosition
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
padding → EdgeInsetsGeometry?
final
removePaddingWhenNoChild → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
show → bool
final
size → Size
Return the width/height of the box, if set. Note this is not the real size of the box, since it ignores the child and the layout.
no setter
width → double?
final

Methods

add({double? width, double? height}) → Box
Returns a box with its width or height increased by width or height (or decreased if the given width or height are negative, clamped to zero).
addMaterialWidget() → Material

Available on Widget, provided by the GenericExtensions extension

addTooltipWidget(String toolTip) → Tooltip

Available on Widget, provided by the GenericExtensions extension

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
borderRadius([BorderRadiusGeometry? borderRadius]) → Widget

Available on Widget, provided by the GenericExtensions extension

boxDecoration([BoxDecoration? boxDecoration]) → Widget

Available on Widget, provided by the GenericExtensions extension

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

set parent widget in center
copyWith({Key? key, bool? show, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, bool? random, Decoration? decoration, DecorationPosition? decorationPosition, Widget? child}) → Box
Creates a copy of this Box but with the given fields replaced with the new values.
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
subtract({double? width, double? height}) → Box
Returns a box with its width or height decreased by width or height (clamped to zero).
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? obj) → Box
You can create boxes by adding a Box to one these types: bool, Color, EdgeInsetsGeometry, AlignmentGeometry, or Widget.
operator ==(Object other) → bool
The equality operator.
inherited