FormBuilderRatingBar class

Field for selection of a numerical value using a star* rating widget

Inheritance

Constructors

FormBuilderRatingBar({Key? key, AutovalidateMode? autovalidateMode, bool enabled = true, double? initialValue, FocusNode? focusNode, FormFieldSetter<double>? onSaved, FormFieldValidator<double>? validator, InputDecoration decoration = const InputDecoration(), required String name, ValueChanged<double?>? onChanged, ValueTransformer<double?>? valueTransformer, VoidCallback? onReset, bool allowHalfRating = false, Axis direction = Axis.horizontal, bool glow = true, Color? glowColor, double glowRadius = 2, double initialRating = 0.0, int itemCount = 5, EdgeInsetsGeometry itemPadding = EdgeInsets.zero, double itemSize = 40.0, double? maxRating, double minRating = 0, RatingWidget? ratingWidget, bool tapOnlyMode = false, TextDirection? textDirection, Color? unratedColor, bool updateOnDrag = false, WrapAlignment wrapAlignment = WrapAlignment.start})

Properties

allowHalfRating bool
Default allowHalfRating = false. Setting true enables half rating support.
final
autovalidateMode AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder FormFieldBuilder<double>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
decoration InputDecoration
finalinherited
direction Axis
Direction of rating bar.
final
enabled bool
Whether the form is able to receive user input.
finalinherited
focusNode FocusNode?
An optional focus node to use as the focus node for this widget.
finalinherited
glow bool
if set to true, Rating Bar item will glow when being touched.
final
glowColor Color?
Defines color for glow.
final
glowRadius double
Defines the radius of glow.
final
hashCode int
The hash code for this object.
no setterinherited
initialRating double
Defines the initial rating to be set to the rating bar.
final
initialValue double?
An optional value to initialize the form field to, or null otherwise.
finalinherited
itemCount int
Defines total number of rating bar items.
final
itemPadding EdgeInsetsGeometry
The amount of space by which to inset each rating item.
final
itemSize double
Defines width and height of each rating item in the bar.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxRating double?
Sets maximum rating
final
minRating double
Sets minimum rating
final
name String
Used to reference the field within the form, or to reference form data after the form is submitted.
finalinherited
onChanged ValueChanged<double?>?
Called when the field value is changed.
finalinherited
onReset VoidCallback?
Called when the field value is reset.
finalinherited
onSaved FormFieldSetter<double>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
ratingWidget RatingWidget?
Defines widgets which are to used as rating bar items.
final
restorationId String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tapOnlyMode bool
if set to true will disable drag to rate feature. Note: Enabling this mode will disable half rating capability.
final
textDirection TextDirection?
The text flows from right to left if textDirection = TextDirection.rtl
final
unratedColor Color?
Defines color for the unrated portion.
final
updateOnDrag bool
Defines whether or not the onRatingUpdate updates while dragging.
final
validator FormFieldValidator<double>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited
valueTransformer → ValueTransformer<double?>?
Called just before field value is saved. Used to massage data just before committing the value.
finalinherited
wrapAlignment WrapAlignment
How the item within the RatingBar should be placed in the main axis.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() FormBuilderRatingBarState
Creates the mutable state for this widget at a given location in the tree.
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
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}) 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