PhoneNumberEditingController class

A TextEditingController which applies phone number formatting.

The property behavior allows you to control how the controller handles deleting separators or inserting non-dialable digits.

Inheritance

Constructors

PhoneNumberEditingController(PhoneNumberUtil _phoneNumberUtil, {required String regionCode, String? text, PhoneInputBehavior behavior = PhoneInputBehavior.lenient})
Creates a controller for an editable text field.
PhoneNumberEditingController.fromValue(PhoneNumberUtil _phoneNumberUtil, TextEditingValue? value, {required String regionCode, PhoneInputBehavior behavior = PhoneInputBehavior.lenient})
Creates a controller for an editable text field from an initial TextEditingValue.

Properties

behavior PhoneInputBehavior
Behavior of the controller.
final
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
regionCode String
Region code to format the string.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selection TextSelection
The currently selected text.
getter/setter pairinherited
text String
The current string the user is editing.
getter/setter pairinherited
value TextEditingValue
The current value stored in this notifier.
getter/setter pairinherited-getteroverride-setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
buildTextSpan({required BuildContext context, TextStyle? style, required bool withComposing}) TextSpan
Builds TextSpan from current editing value.
inherited
clear() → void
Set the value to empty.
inherited
clearComposing() → void
Set the composing region to an empty range.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
isSelectionWithinTextBounds(TextSelection selection) bool
Check that the selection is inside of the bounds of text.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited