MaskedTextController class - masked_text_controller library

Constructors

MaskedTextController({required String mask, BeforeChangeCallback? beforeChange, AfterChangeCallback? afterChange, CursorBehaviour cursorBehavior = CursorBehaviour.unlocked, String? text, Map<String, RegExp>? translator})

Properties

afterChange ↔ AfterChangeCallback?: A function called after the text is updated
getter/setter pair
beforeChange ↔ BeforeChangeCallback?: A function called before the text is updated. Returns a boolean informing whether the text should be updated.
getter/setter pair
cursorBehavior ↔ CursorBehaviour: Configure if the cursor should be forced
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: Whether any listeners are currently registered.
no setterinherited
mask ↔ String: The current applied mask
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selection ↔ TextSelection: The currently selected range within text.
getter/setter pairinherited
text ↔ String: The current string the user is editing.
getter/setter pairinherited-getteroverride-setter
translator ↔ Map<String, RegExp>: Translator from mask characters to RegExp
getter/setter pair
unmasked → String: Retrieve current value without mask
no setter
value ↔ TextEditingValue: The current value stored in this notifier.
getter/setter pairinherited

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
moveCursorToEnd() → void: Moves cursor to the end of the text
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
unmask(String mask, String text) → String: Unmask the text given a mask
updateMask(String newMask, {bool shouldMoveCursorToEnd = true, bool shouldUpdateValue = false}) → void: Replaces mask with a newMask and moves cursor to the end if shouldMoveCursorToEnd is true shouldUpdateValue Set to true to request a following update in the text. If this method is being called in beforeChange this MUST be false, since it will call updateText as next step automatically.
updateText(String newText) → void: Updates the current text with a new one applying the mask

Operators

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

Static Methods

getDefaultTranslator() → Map<String, RegExp>: Default RegExp for each character available for the mask