TextFieldBloc<ExtraData> class
A FieldBloc
used for String
type, but generally
it is also used to obtain int
and double
values
of texts thanks to the methods
valueToInt and valueToDouble.
- Inheritance
-
- Object
- SingleFieldBloc<
String, String, TextFieldBlocState< ExtraData?> , ExtraData?> - TextFieldBloc
Constructors
-
TextFieldBloc({String? name, String initialValue = '', List<
Validator< ? validators, List<String> >AsyncValidator< ? asyncValidators, Duration asyncValidatorDebounceTime = const Duration(milliseconds: 500), Suggestions<String> >String> ? suggestions, ExtraData? extraData}) - TextFieldBloc
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasInitialValue → bool
-
Indicate if this field has value from
FieldBloc.updateInitialValue
method. FieldBlocState.hasInitialValueno setterinherited - hasUpdatedValue → bool
-
Indicate if this field has value from
FieldBloc.updateValue
method. FieldBlocState.hasUpdatedValueno setterinherited - isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- isValueChanged → bool
-
Returns true when the value has been changed by
FieldBloc.changeValue
. FieldBlocState.isValueChangedno setterinherited - name → String
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectedSuggestion
→ Stream<
String> -
Returns Stream of selected
Suggestion
s.no setterinherited -
state
→ TextFieldBlocState<
ExtraData?> -
The current state.
no setterinherited
-
stream
→ Stream<
TextFieldBlocState< ExtraData?> > -
The current stream of states.
no setterinherited
- value → String
-
Returns the
value
of the current state.no setterinherited - valueToDouble → double?
-
Return the parsed
value
todouble
of the current state.no setter - valueToInt → int?
-
Return the parsed
value
toint
of the current state.no setter
Methods
-
addAsyncValidators(
List< AsyncValidator< asyncValidators, {bool forceValidation = false}) → voidString> > -
Add
asyncValidators
to the currentvalidators
for check ifvalue
of the current state has an error.inherited -
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggersonError
with an optional StackTrace.inherited -
addFieldError(
Object error, {bool isPermanent = false}) → void -
If
isPermanent
isfalse
, add an error to FieldBlocState.error.inherited -
addValidators(
List< Validator< validators, {bool forceValidation = false}) → voidString> > -
Add
validators
to the currentvalidators
for check ifvalue
of the current state has an error.inherited -
changeValue(
String value) → void -
inherited
-
clear(
) → void -
Set the
value
toinitialValue
of the current state.inherited -
close(
) → Future< void> -
Closes the instance.
This method should be called when the instance is no longer needed.
Once close is called, the instance can no longer be used.
inherited
-
emit(
TextFieldBlocState< ExtraData?> state) → void -
Updates the
state
to the providedstate
.emit
does nothing if thestate
being emitted is equal to the currentstate
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onChange(
Change< TextFieldBlocState< change) → voidExtraData?> > -
Called whenever a
change
occurs with the givenchange
. Achange
occurs when a newstate
is emitted.onChange
is called before thestate
of thecubit
is updated.onChange
is a great spot to add logging/analytics for a specificcubit
.inherited -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifiesBlocObserver.onError
.inherited -
onValueChanges<
R> ({Duration debounceTime = const Duration(), void onStart(TextFieldBlocState< ExtraData?> previous, TextFieldBlocState<ExtraData?> current)?, required Stream<R> onData(TextFieldBlocState<ExtraData?> previous, TextFieldBlocState<ExtraData?> current), void onFinish(TextFieldBlocState<ExtraData?> previous, TextFieldBlocState<ExtraData?> current, R result)?}) → StreamSubscription -
Returns a StreamSubscription<R>,
inherited
-
removeAsyncValidators(
List< AsyncValidator< asyncValidators, {bool forceValidation = false}) → voidString> > -
Add
asyncValidators
to the currentvalidators
for check ifvalue
of the current state has an error.inherited -
removeFormBloc(
FormBloc formBloc) → void -
Remove the
formBloc
to the fieldBloc See FieldBloc.removeFormBlocinherited -
removeValidators(
List< Validator< validators, {bool forceValidation = false}) → voidString> > -
Add
validators
to the currentvalidators
for check ifvalue
of the current state has an error.inherited -
resetStateIsValidated(
) → void -
inherited
-
selectSuggestion(
String suggestion) → void -
Add a
suggestion
to selectedSuggestion.inherited -
subscribeToFieldBlocs(
List< FieldBloc< fieldBlocs) → voidFieldBlocStateBase> > -
Create a subscription to the state of each
fieldBloc
inFieldBlocs
, When any state changes, thisfieldBloc
will be revalidated. This is useful when you havevalidators
that uses the state of otherfieldBloc
, for example when you want the correct behavior of validator that confirms a password with the password of otherfieldBloc
.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
updateAsyncValidators(
List< AsyncValidator< asyncValidators, {bool forceValidation = false}) → voidString> > -
Updates the current
asyncValidators
withasyncValidators
.inherited -
updateExtraData(
ExtraData? extraData) → void -
{@template form_bloc.FieldBloc.updateExtraData}
Updates the
extraData
of the current state. {@endtemplate form_bloc.FieldBloc.updateExtraData}inherited -
updateFormBloc(
FormBloc formBloc, {bool autoValidate = false}) → void -
Update the
formBloc
andautoValidate
to the fieldBloc See FieldBloc.updateFormBlocinherited -
updateInitialValue(
String value) → void -
Set
value
to thevalue
and setisInitial
totrue
of the current state.inherited -
updateStateError(
{required String value, required Object? error}) → void -
inherited
-
updateSuggestions(
Suggestions< String> ? suggestions) → void -
Updates the
suggestions
of the current state.inherited -
updateValidators(
List< Validator< validators, {bool forceValidation = false}) → voidString> > -
Updates the current
validators
withvalidators
.inherited -
updateValue(
String value) → void -
Set
value
to thevalue
of the current state.inherited -
validate(
) → Future< bool> -
Check the value of the current state in each
validator
and if have an error, theerror
of the current state will be updated.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited