CustomFormWrapper class

A custom form wrapper widget that listens to keyboard input (Enter key) and optionally triggers a callback when Enter is pressed.

This widget:

  • Wraps a Form with a FocusTraversalGroup for custom keyboard traversal policy.
  • Automatically requests focus after the first frame.
  • Listens to key events, especially the Enter key.

Can be useful for submitting forms using keyboard input.

Inheritance

Constructors

CustomFormWrapper({Key? key, required GlobalKey<FormState> formKey, FocusTraversalPolicy? policy, void onPressEnter()?, required Widget child})
const

Properties

child → Widget
The form content (usually containing form fields).
final
formKey → GlobalKey<FormState>
The form key used to validate and manage form state.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onPressEnter → void Function()?
Optional callback triggered when the Enter key is pressed.
final
policy → FocusTraversalPolicy?
Optional keyboard focus traversal policy (e.g., tab order).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CustomFormWrapper>
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
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