WxSheet<T extends WxSheetThemeData<T>> class

The sheet widget serves as the building block for many Widgetarian components, providing a base layer for customization.

Inheritance
Implementers

Constructors

WxSheet({Key? key, bool? animated, Duration? duration, Curve? curve, Axis? direction, WxSheetVariant? variant, WxSheetSize? size, Color? severity, double? width, double? height, double? minWidth, double? maxWidth, double? minHeight, double? maxHeight, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, double? spacing, bool? adaptiveSpacing, Offset? offset, double? scale, double? rotate, bool? flipX, bool? flipY, double? opacity, Alignment? alignment, Clip? clipBehavior, bool? overlay, Color? overlayColor, double? overlayOpacity, ShapeBorder? overlayShape, Size? overlayExtent, Color? elevationColor, double? elevation, CrossAxisAlignment? tileAlign, MainAxisAlignment? tileJustify, bool? tileWrap, TextStyle? textStyle, TextAlign? textAlign, double? textSpacing, Color? textColor, TextOverflow? textOverflow, bool? textSoftWrap, TextWidthBasis? textWidthBasis, bool? adaptiveForegroundColor, Color? foregroundColor, double? foregroundOpacity, int? foregroundAlpha, Color? backgroundColor, double? backgroundOpacity, int? backgroundAlpha, Color? borderColor, double? borderOpacity, int? borderAlpha, double? borderWidth, BorderRadius? borderRadius, BorderStyle? borderStyle, double? borderOffset, OutlinedBorder? border, DecorationImage? image, List<BoxShadow>? shadows, Gradient? gradient, Color? iconColor, double? iconOpacity, double? iconSize, Color? checkmarkColor, double? checkmarkSize, double? checkmarkWeight, bool? checkmarkRounded, Color? spinnerColor, Color? spinnerBackgroundColor, double? spinnerSize, double? spinnerWidth, bool? spinnerRounded, TextStyle? titleStyle, TextStyle? subtitleStyle, double? titleSize, double? subtitleSize, Color? titleColor, Color? subtitleColor, int? titleMaxLines, int? subtitleMaxLines, FontWeight? titleWeight, FontWeight? subtitleWeight, String? tooltip, bool selected = false, bool indeterminate = false, bool? disabled, bool loading = false, bool autofocus = false, FocusNode? focusNode, bool? focusable, bool? feedback, bool? inherits, MouseCursor? mouseCursor, VoidCallback? onPressed, ValueChanged<bool>? onSelected, WxSheetStyle? selectedStyle, WxSheetStyle? indeterminateStyle, WxSheetStyle? focusedStyle, WxSheetStyle? hoveredStyle, WxSheetStyle? pressedStyle, WxSheetStyle? loadingStyle, WxSheetStyle? disabledStyle, WxSheetStyle? style, WxSheetEventController? eventsController, Widget? leading, Widget? trailing, Widget? title, Widget? subtitle, Widget? child})
Create a sheet widget
const
WxSheet.block({Key? key, bool? animated, Duration? duration, Curve? curve, Axis? direction, WxSheetVariant? variant, WxSheetSize? size, Color? severity, double? height, double? minHeight, double? maxHeight, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, double? spacing, bool? adaptiveSpacing, Offset? offset, double? scale, double? rotate, bool? flipX, bool? flipY, double? opacity, Alignment? alignment, Clip? clipBehavior, bool? overlay, Color? overlayColor, double? overlayOpacity, ShapeBorder? overlayShape, Size? overlayExtent, Color? elevationColor, double? elevation, CrossAxisAlignment? tileAlign, MainAxisAlignment? tileJustify, bool? tileWrap, TextStyle? textStyle, TextAlign? textAlign, double? textSpacing, Color? textColor, TextOverflow? textOverflow, bool? textSoftWrap, TextWidthBasis? textWidthBasis, bool? adaptiveForegroundColor, Color? foregroundColor, double? foregroundOpacity, int? foregroundAlpha, Color? backgroundColor, double? backgroundOpacity, int? backgroundAlpha, Color? borderColor, double? borderOpacity, int? borderAlpha, double? borderWidth, BorderRadius? borderRadius, BorderStyle? borderStyle, double? borderOffset, OutlinedBorder? border, DecorationImage? image, List<BoxShadow>? shadows, Gradient? gradient, Color? iconColor, double? iconOpacity, double? iconSize, Color? checkmarkColor, double? checkmarkSize, double? checkmarkWeight, bool? checkmarkRounded, Color? spinnerColor, Color? spinnerBackgroundColor, double? spinnerSize, double? spinnerWidth, bool? spinnerRounded, TextStyle? titleStyle, TextStyle? subtitleStyle, double? titleSize, double? subtitleSize, Color? titleColor, Color? subtitleColor, int? titleMaxLines, int? subtitleMaxLines, FontWeight? titleWeight, FontWeight? subtitleWeight, String? tooltip, bool selected = false, bool indeterminate = false, bool? disabled, bool loading = false, bool autofocus = false, FocusNode? focusNode, bool? focusable, bool? feedback, bool? inherits, MouseCursor? mouseCursor, VoidCallback? onPressed, ValueChanged<bool>? onSelected, WxSheetStyle? selectedStyle, WxSheetStyle? indeterminateStyle, WxSheetStyle? focusedStyle, WxSheetStyle? hoveredStyle, WxSheetStyle? pressedStyle, WxSheetStyle? loadingStyle, WxSheetStyle? disabledStyle, WxSheetStyle? style, WxSheetEventController? eventsController, Widget? leading, Widget? trailing, Widget? title, Widget? subtitle, Widget? child})
Create a sheet widget with full width
const
WxSheet.circle({Key? key, double? radius, double? minRadius, double? maxRadius, bool? animated, Duration? duration, Curve? curve, Axis? direction, WxSheetVariant? variant, WxSheetSize? size, Color? severity, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, double? spacing, bool? adaptiveSpacing, Offset? offset, double? scale, double? rotate, bool? flipX, bool? flipY, double? opacity, Alignment? alignment, Clip? clipBehavior, bool? overlay, Color? overlayColor, double? overlayOpacity, ShapeBorder? overlayShape, Size? overlayExtent, Color? elevationColor, double? elevation, CrossAxisAlignment? tileAlign, MainAxisAlignment? tileJustify, bool? tileWrap, TextStyle? textStyle, TextAlign? textAlign, double? textSpacing, Color? textColor, TextOverflow? textOverflow, bool? textSoftWrap, TextWidthBasis? textWidthBasis, bool? adaptiveForegroundColor, Color? foregroundColor, double? foregroundOpacity, int? foregroundAlpha, Color? backgroundColor, double? backgroundOpacity, int? backgroundAlpha, Color? borderColor, double? borderOpacity, int? borderAlpha, double? borderWidth, BorderRadius? borderRadius, BorderStyle? borderStyle, double? borderOffset, DecorationImage? image, List<BoxShadow>? shadows, Gradient? gradient, Color? iconColor, double? iconOpacity, double? iconSize, Color? checkmarkColor, double? checkmarkSize, double? checkmarkWeight, bool? checkmarkRounded, Color? spinnerColor, Color? spinnerBackgroundColor, double? spinnerSize, double? spinnerWidth, bool? spinnerRounded, TextStyle? titleStyle, TextStyle? subtitleStyle, double? titleSize, double? subtitleSize, Color? titleColor, Color? subtitleColor, int? titleMaxLines, int? subtitleMaxLines, FontWeight? titleWeight, FontWeight? subtitleWeight, String? tooltip, bool selected = false, bool indeterminate = false, bool? disabled, bool loading = false, bool autofocus = false, FocusNode? focusNode, bool? focusable, bool? feedback, bool? inherits, MouseCursor? mouseCursor, VoidCallback? onPressed, ValueChanged<bool>? onSelected, WxSheetStyle? selectedStyle, WxSheetStyle? indeterminateStyle, WxSheetStyle? focusedStyle, WxSheetStyle? hoveredStyle, WxSheetStyle? pressedStyle, WxSheetStyle? loadingStyle, WxSheetStyle? disabledStyle, WxSheetStyle? style, WxSheetEventController? eventsController, Widget? leading, Widget? trailing, Widget? title, Widget? subtitle, Widget? child})
Create sheet widget with circle shape
const
WxSheet.stadium({Key? key, bool? animated, Duration? duration, Curve? curve, Axis? direction, WxSheetVariant? variant, WxSheetSize? size, Color? severity, double? width, double? height, double? minWidth, double? maxWidth, double? minHeight, double? maxHeight, EdgeInsetsGeometry? margin, EdgeInsetsGeometry? padding, double? spacing, bool? adaptiveSpacing, Offset? offset, double? scale, double? rotate, bool? flipX, bool? flipY, double? opacity, Alignment? alignment, Clip? clipBehavior, bool? overlay, Color? overlayColor, double? overlayOpacity, ShapeBorder? overlayShape, Size? overlayExtent, Color? elevationColor, double? elevation, CrossAxisAlignment? tileAlign, MainAxisAlignment? tileJustify, bool? tileWrap, TextStyle? textStyle, TextAlign? textAlign, double? textSpacing, Color? textColor, TextOverflow? textOverflow, bool? textSoftWrap, TextWidthBasis? textWidthBasis, bool? adaptiveForegroundColor, Color? foregroundColor, double? foregroundOpacity, int? foregroundAlpha, Color? backgroundColor, double? backgroundOpacity, int? backgroundAlpha, Color? borderColor, double? borderOpacity, int? borderAlpha, double? borderWidth, BorderStyle? borderStyle, double? borderOffset, Color? iconColor, double? iconOpacity, double? iconSize, Color? checkmarkColor, double? checkmarkSize, double? checkmarkWeight, bool? checkmarkRounded, Color? spinnerColor, Color? spinnerBackgroundColor, double? spinnerSize, double? spinnerWidth, bool? spinnerRounded, TextStyle? titleStyle, TextStyle? subtitleStyle, double? titleSize, double? subtitleSize, Color? titleColor, Color? subtitleColor, int? titleMaxLines, int? subtitleMaxLines, FontWeight? titleWeight, FontWeight? subtitleWeight, DecorationImage? image, List<BoxShadow>? shadows, Gradient? gradient, String? tooltip, bool selected = false, bool indeterminate = false, bool? disabled, bool loading = false, bool autofocus = false, FocusNode? focusNode, bool? focusable, bool? feedback, bool? inherits, MouseCursor? mouseCursor, VoidCallback? onPressed, ValueChanged<bool>? onSelected, WxSheetStyle? selectedStyle, WxSheetStyle? indeterminateStyle, WxSheetStyle? focusedStyle, WxSheetStyle? hoveredStyle, WxSheetStyle? pressedStyle, WxSheetStyle? loadingStyle, WxSheetStyle? disabledStyle, WxSheetStyle? style, WxSheetEventController? eventsController, Widget? leading, Widget? trailing, Widget? title, Widget? subtitle, Widget? child})
Create a sheet widget with stadium shape
const

Properties

adaptiveForegroundColor → bool?
Whether the foreground color is adaptive to background color.
final
adaptiveSpacing → bool?
Whether the spacing is forced to child with no leading or trailing.
final
alignment → Alignment?
Align the child within the sheet.
final
anchorBuilder → WxSheetWrapper?
A function used to wrap the sheet anchor (advanced usage).
no setter
animated → bool?
Whether to animate the sheet decoration.
final
autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
backgroundAlpha → int?
Alpha to be apply to backgroundColor.
final
backgroundColor → Color?
Color to be used for the sheet's background.
final
backgroundOpacity → double?
Opacity to be apply to backgroundColor.
final
border → OutlinedBorder?
A border to draw.
final
borderAlpha → int?
Alpha to be apply to borderColor.
final
borderColor → Color?
Color to be used for the sheet's border.
final
borderOffset → double?
The relative position of the stroke on a BorderSide in an OutlinedBorder or Border.
final
borderOpacity → double?
Opacity to be apply to borderColor.
final
borderRadius → BorderRadius?
The radii for each corner of the sheet's border.
final
borderStyle → BorderStyle?
The style of this side of the sheet's border.
final
borderWidth → double?
The width of this side of the sheet's border, in logical pixels.
final
checkmarkColor → Color?
The color of the checkmark.
final
checkmarkRounded → bool?
Whether the checkmark has rounded edges.
final
checkmarkSize → double?
The size of the checkmark. If null, the checkmark expands to fit its parent.
final
checkmarkWeight → double?
The stroke width of the checkmark.
final
child → Widget?
The widget below this widget in the tree.
final
clipBehavior → Clip?
The sheet's content will be clipped (or not) according to this option.
final
curve → Curve?
The curve to apply when animating the parameters of this widget.
final
defaultAnimated → bool
Whether the default animation is enabled for the sheet.
no setter
defaultCurve → Curve
The default animation curve for the sheet.
no setter
defaultDisabled → bool
Whether the sheet is disabled by default.
no setter
defaultDuration → Duration
The default animation duration for the sheet.
no setter
defaultFeedback → bool
Whether the default feedback is enabled for the sheet.
no setter
defaultFocusable → bool
Whether the sheet is focusable by default.
no setter
defaultInherits → bool
Whether the sheet inherits styles from its parent theme by default.
no setter
defaultLeading → Widget?
The default leading content for the sheet.
no setter
defaultMouseCursor → MouseCursor?
The default mouse cursor for the sheet.
no setter
defaultOverlay → bool
Whether the default overlay is enabled for the sheet.
no setter
defaultTrailing → Widget?
The default trailing content for the sheet.
no setter
direction → Axis?
The direction to use as the main axis.
final
disabled → bool?
Whether or not this sheet is disabled for input.
final
disabledStyle → WxSheetStyle?
The style to be applied when events includes WidgetEvent.disabled.
final
duration → Duration?
The duration over which to animate the parameters of this widget.
final
effectiveStyle → WxSheetStyle
Retrieves the effective style based on the provided properties.
no setter
elevation → double?
The sheet's z-coordinate relative to the parent at which to place this physical object.
final
elevationColor → Color?
When elevation is non zero the color to use for the sheet's shadow color.
final
eventsController → WxSheetEventController?
Used by widgets that expose their internal event for the sake of extensions that add support for additional events.
final
feedback → bool?
Whether detected gestures should disable acoustic and/or haptic feedback.
final
flipX → bool?
Controls whether the sheet widget is flipped horizontally (mirrored). Setting flipX to true will cause the sheet to be displayed as if reflected across a vertical axis.
final
flipY → bool?
Controls whether the sheet widget is flipped vertically (inverted). Setting flipY to true will cause the sheet to be displayed as if reflected across a horizontal axis.
final
focusable → bool?
If true, this widget may request the primary focus.
final
focusedStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.focused.
final
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
final
foregroundAlpha → int?
Alpha to be apply to foregroundColor.
final
foregroundColor → Color?
The color to be applied to the sheet's label, and icon
final
foregroundOpacity → double?
Opacity to be apply to foregroundColor.
final
gradient → Gradient?
A gradient to use when filling the shape.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
The vertical extent of the sheet widget.
final
hoveredStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.hovered.
final
iconColor → Color?
Color to be used for the icon's inside the sheet.
final
iconOpacity → double?
Opacity to be apply to iconColor.
final
iconSize → double?
The size of the icon's inside the sheet, in logical pixels.
final
image → DecorationImage?
An image to paint inside the shape (clipped to its outline).
final
indeterminate → bool
Whether or not this sheet is indeterminate.
final
indeterminateStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.indeterminate.
final
inherits → bool?
Whether the sheet inherits variant, severity, and size from its parent theme.
final
innerWrapper → WxSheetWrapper?
A function used to wrap the entire sheet (advanced usage).
no setter
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading → Widget?
A custom widget to display prior to the sheet's child.
final
loading → bool
Whether or not this sheet is in loading state.
final
loadingStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.loading.
final
margin → EdgeInsetsGeometry?
Empty space to surround the outside sheet.
final
maxHeight → double?
The maximum height of the sheet widget
final
maxWidth → double?
The maximum width of the sheet widget
final
minHeight → double?
The minimum height of the sheet widget
final
minWidth → double?
The minimum width of the sheet widget
final
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
offset → Offset?
Adjust the size of the sheet relative to its original size. A value of 1 maintains the original size, while values greater than 1 enlarge and values less than 1 shrink the element.
final
onPressed → VoidCallback?
Called when the user taps the sheet.
final
onSelected → ValueChanged<bool>?
Called when the sheet should change between selected and de-selected states.
final
opacity → double?
The sheet opacity when pressed, hovered over, or focused.
final
outerWrapper → WxSheetWrapper?
A function used to wrap the sheet content (advanced usage).
no setter
overlay → bool?
Whether the overlay is enabled or not
final
overlayColor → Color?
Defines the overlay colors.
final
overlayExtent → Size?
The extent of the overlay.
final
overlayOpacity → double?
Opacity to be apply to overlayColor.
final
overlayShape → ShapeBorder?
The shape (e.g., circle, rectangle) to use for the overlay drawn around this part of the anchor when pressed, hovered over, or focused.
final
padding → EdgeInsetsGeometry?
The padding between the contents of the sheet and the outside sheet.
final
pressedStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.pressed.
final
rotate → double?
Rotates sheet element by a specified number of degrees. Use a positive value for clockwise rotation or a negative value for counter-clockwise rotation.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scale → double?
Adjust the size of the sheet relative to its original size. A value of 1 maintains the original size, while values greater than 1 enlarge and values less than 1 shrink the element.
final
selected → bool
Whether or not this sheet is selected.
final
selectedStyle → WxSheetStyle?
The style to be applied when events includes WxSheetEvent.selected.
final
severity → Color?
Type of the sheet severity
final
shadows → List<BoxShadow>?
A list of shadows cast by the border.
final
size → WxSheetSize?
Type of the sheet size
final
spacing → double?
How much space to place between sheet's foreground widget in a run in the main axis.
final
spinnerBackgroundColor → Color?
Color to be used for the spinner's background inside the sheet.
final
spinnerColor → Color?
Color to be used for the spinner's inside the sheet.
final
spinnerRounded → bool?
Whether the spinner's stroke is rounded.
final
spinnerSize → double?
The size of the spinner's inside the sheet.
final
spinnerWidth → double?
The width of the spinner's stoke inside the sheet.
final
style → WxSheetStyle?
The style to be applied to the sheet.
final
styleModifier → ValueForwarder<WxSheetStyle>?
A function that modifies the WxSheetStyle before applying it to the sheet.
no setter
subtitle → Widget?
Additional content displayed below the title.
final
subtitleColor → Color?
The text color to be applied to subtitle.
final
subtitleMaxLines → int?
The text max lines to be applied to subtitle.
final
subtitleSize → double?
The font size to be applied to title.
final
subtitleStyle → TextStyle?
The text style to be applied to subtitle.
final
subtitleWeight → FontWeight?
The font weight to be applied to subtitle.
final
textAlign → TextAlign?
The align to be applied to the sheet's label. This only has an effect on widgets that respect the DefaultTextStyle, such as Text.
final
textColor → Color?
The text color to be applied to title and subtitle.
final
textOverflow → TextOverflow?
The text overflow to be applied to title and subtitle.
final
textSoftWrap → bool?
The text softWrap to be applied to title and subtitle.
final
textSpacing → double?
The gap between the title and the subtitle widgets.
final
textStyle → TextStyle?
The style to be applied to the sheet's label.
final
textWidthBasis → TextWidthBasis?
The text width basis to be applied to title and subtitle.
final
tileAlign → CrossAxisAlignment?
Cross axis alignment of the foreground widget
final
tileJustify → MainAxisAlignment?
Main axis alignment of the foreground widget
final
tileWrap → bool?
Controls how the child widget or (title and subtitle) fills its available space (expand or wrap content).
final
title → Widget?
The primary text content
final
titleColor → Color?
The text color to be applied to title.
final
titleMaxLines → int?
The text max lines to be applied to title.
final
titleSize → double?
The font size to be applied to title.
final
titleStyle → TextStyle?
The text style to be applied to title.
final
titleWeight → FontWeight?
The font weight to be applied to title.
final
tooltip → String?
Tooltip string to be used for the body area of the sheet.
final
trailing → Widget?
A custom widget to display next to the sheet's child.
final
variant → WxSheetVariant?
Type of the sheet variant
final
width → double?
The horizontal extent of the sheet widget.
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
getInheritedStyle(BuildContext context, bool inherits) → WxSheetStyle
getParentStyle(BuildContext context) → WxSheetStyle?
getParentTheme(BuildContext context) → WxSheetThemeData<WxSheetThemeParent>?
getTheme(BuildContext context) → WxSheetThemeData<T>
Retrieves the WxSheetThemeData for the given BuildContext.
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