FormBuilderSignaturePad class
Field with drawing pad on which user can doodle
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FormField<
Uint8List> - FormBuilderSignaturePad
Constructors
-
FormBuilderSignaturePad.new({Key? key, required String name, FormFieldValidator<
Uint8List> ? validator, Uint8List? initialValue, InputDecoration decoration = const InputDecoration(), ValueChanged<Uint8List?> ? onChanged, ValueTransformer<Uint8List?> ? valueTransformer, bool enabled = true, FormFieldSetter<Uint8List> ? onSaved, AutovalidateMode? autovalidateMode, VoidCallback? onReset, FocusNode? focusNode, Color backgroundColor = Colors.transparent, String? clearButtonText, double? width, double height = 200, SignatureController? controller, Border? border}) - Creates field with drawing pad on which user can doodle
Properties
- autovalidateMode → AutovalidateMode
-
Used to enable/disable this form field auto validation and update its
error text.
finalinherited
- backgroundColor → Color
-
Color of the canvas
final
- border → Border?
-
Styles the canvas border
final
-
builder
→ FormFieldBuilder<
Uint8List> -
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
- clearButtonText → String?
-
Text to be displayed on the clear button which clears user input from the canvas
final
- controller → SignatureController?
-
Controls the value of the signature pad.
final
- decoration → InputDecoration
-
finalinherited
- 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
- forceErrorText → String?
-
An optional property that forces the FormFieldState into an error state
by directly setting the FormFieldState.errorText property without
running the validator function.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double
-
Height of the canvas
final
- initialValue → Uint8List?
-
An optional value to initialize the form field to, or null otherwise.
finalinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- name → String
-
Used to reference the field within the form, or to reference form data
after the form is submitted.
finalinherited
-
onChanged
→ ValueChanged<
Uint8List?> ? -
Called when the field value is changed.
finalinherited
- onReset → VoidCallback?
-
Called when the field value is reset.
finalinherited
-
onSaved
→ FormFieldSetter<
Uint8List> ? -
An optional method to call with the final value when the form is saved via
FormState.save.
finalinherited
- 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
-
validator
→ FormFieldValidator<
Uint8List> ? -
An optional method that validates an input. Returns an error string to
display if the input is invalid, or null otherwise.
finalinherited
-
valueTransformer
→ ValueTransformer<
Uint8List?> ? -
Called just before field value is saved. Used to massage data just before
committing the value.
finalinherited
- width → double?
-
Width of the canvas
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → FormBuilderSignaturePadState - 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, 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