Struct FilteringTextInputFormatter 

pub struct FilteringTextInputFormatter {
    pub filter_pattern: FilterPattern,
    pub allow: bool,
    pub replacement_string: String,
}

A TextInputFormatter that prevents the insertion of characters matching (or not matching) a particular pattern, by replacing the characters with the given replacement_string.

Fields

filter_pattern: FilterPattern

A pattern to match or replace in incoming TextEditingValues.

allow: bool

Whether the pattern is an allow list or not.

replacement_string: String

String used to replace banned patterns.

Implementations

impl FilteringTextInputFormatter

pub fn new( filter_pattern: FilterPattern, allow: bool, ) -> FilteringTextInputFormatter

Creates a formatter that replaces banned patterns with the given replacement_string.

pub fn replacement_string(self, replacement_string: impl Into<String>) -> Self

Dart FilteringTextInputFormatter(replacementString:).

pub fn allow(filter_pattern: FilterPattern) -> FilteringTextInputFormatter

Creates a formatter that only allows characters matching a pattern.

pub fn deny(filter_pattern: FilterPattern) -> FilteringTextInputFormatter

Creates a formatter that blocks characters matching a pattern.

pub fn single_line_formatter() -> TextInputFormatterRef

A TextInputFormatter that forces input to be a single line.

pub fn digits_only() -> TextInputFormatterRef

A TextInputFormatter that takes in digits [0-9] only.

Trait Implementations

impl Clone for FilteringTextInputFormatter

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilteringTextInputFormatter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TextInputFormatter for FilteringTextInputFormatter

fn format_edit_update( &self, _old_value: &TextEditingValue, new_value: &TextEditingValue, ) -> TextEditingValue

Called when text is being typed or cut/copy/pasted in the EditableText.