RTextFieldViewModel
Logoheadless

RTextFieldViewModel final#

final class RTextFieldViewModel

Constructors#

RTextFieldViewModel() const#

const RTextFieldViewModel({ required String? placeholder, required String? label, required String? helperText, required String? errorText, required dynamic variant, required bool obscureText, required bool enabled, required bool readOnly, required bool autofocus, required dynamic keyboardType, required dynamic textInputAction, required dynamic textCapitalization, required bool autocorrect, required bool enableSuggestions, required dynamic smartDashesType, required dynamic smartQuotesType, required int? maxLines, required int? minLines, required int? maxLength, required dynamic maxLengthEnforcement, required bool? showCursor, required dynamic keyboardAppearance, required dynamic scrollPadding, required dynamic dragStartBehavior, required bool? enableInteractiveSelection, required List<dynamic>? inputFormatters, required dynamic clearButtonMode, required dynamic prefixMode, required dynamic suffixMode, required RTextFieldStyle? style, required dynamic slots, required dynamic overrides, required dynamic onEditingComplete, required dynamic onTapOutside, })
Implementation
const RTextFieldViewModel({
  required this.placeholder,
  required this.label,
  required this.helperText,
  required this.errorText,
  required this.variant,
  required this.obscureText,
  required this.enabled,
  required this.readOnly,
  required this.autofocus,
  required this.keyboardType,
  required this.textInputAction,
  required this.textCapitalization,
  required this.autocorrect,
  required this.enableSuggestions,
  required this.smartDashesType,
  required this.smartQuotesType,
  required this.maxLines,
  required this.minLines,
  required this.maxLength,
  required this.maxLengthEnforcement,
  required this.showCursor,
  required this.keyboardAppearance,
  required this.scrollPadding,
  required this.dragStartBehavior,
  required this.enableInteractiveSelection,
  required this.inputFormatters,
  required this.clearButtonMode,
  required this.prefixMode,
  required this.suffixMode,
  required this.style,
  required this.slots,
  required this.overrides,
  required this.onEditingComplete,
  required this.onTapOutside,
});

RTextFieldViewModel.fromWidget() factory#

factory RTextFieldViewModel.fromWidget(RTextField widget)
Implementation
factory RTextFieldViewModel.fromWidget(RTextField widget) {
  return RTextFieldViewModel(
    placeholder: widget.placeholder,
    label: widget.label,
    helperText: widget.helperText,
    errorText: widget.errorText,
    variant: widget.variant,
    obscureText: widget.obscureText,
    enabled: widget.enabled,
    readOnly: widget.readOnly,
    autofocus: widget.autofocus,
    keyboardType: widget.keyboardType,
    textInputAction: widget.textInputAction,
    textCapitalization: widget.textCapitalization,
    autocorrect: widget.autocorrect,
    enableSuggestions: widget.enableSuggestions,
    smartDashesType: widget.smartDashesType,
    smartQuotesType: widget.smartQuotesType,
    maxLines: widget.maxLines,
    minLines: widget.minLines,
    maxLength: widget.maxLength,
    maxLengthEnforcement: widget.maxLengthEnforcement,
    showCursor: widget.showCursor,
    keyboardAppearance: widget.keyboardAppearance,
    scrollPadding: widget.scrollPadding,
    dragStartBehavior: widget.dragStartBehavior,
    enableInteractiveSelection: widget.enableInteractiveSelection,
    inputFormatters: widget.inputFormatters,
    clearButtonMode: widget.clearButtonMode,
    prefixMode: widget.prefixMode,
    suffixMode: widget.suffixMode,
    style: widget.style,
    slots: widget.slots,
    overrides: widget.overrides,
    onEditingComplete: widget.onEditingComplete,
    onTapOutside: widget.onTapOutside,
  );
}

Properties#

autocorrect final#

final bool autocorrect
Implementation
final bool autocorrect;

autofocus final#

final bool autofocus
Implementation
final bool autofocus;

clearButtonMode final#

final dynamic clearButtonMode
Implementation
final RTextFieldOverlayVisibilityMode clearButtonMode;

dragStartBehavior final#

final dynamic dragStartBehavior
Implementation
final DragStartBehavior dragStartBehavior;

enabled final#

final bool enabled
Implementation
final bool enabled;

enableInteractiveSelection final#

final bool? enableInteractiveSelection
Implementation
final bool? enableInteractiveSelection;

enableSuggestions final#

final bool enableSuggestions
Implementation
final bool enableSuggestions;

errorText final#

final String? errorText
Implementation
final String? errorText;

hasError no setter#

bool get hasError
Implementation
bool get hasError => errorText != null;

hashCode no setter inherited#

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation
external int get hashCode;

helperText final#

final String? helperText
Implementation
final String? helperText;

inputFormatters final#

final List<dynamic>? inputFormatters
Implementation
final List<TextInputFormatter>? inputFormatters;

isMultiline no setter#

bool get isMultiline
Implementation
bool get isMultiline => maxLines == null || maxLines! > 1;

keyboardAppearance final#

final dynamic keyboardAppearance
Implementation
final Brightness? keyboardAppearance;

keyboardType final#

final dynamic keyboardType
Implementation
final TextInputType? keyboardType;

label final#

final String? label
Implementation
final String? label;

maxLength final#

final int? maxLength
Implementation
final int? maxLength;

maxLengthEnforcement final#

final dynamic maxLengthEnforcement
Implementation
final MaxLengthEnforcement? maxLengthEnforcement;

maxLines final#

final int? maxLines
Implementation
final int? maxLines;

minLines final#

final int? minLines
Implementation
final int? minLines;

obscureText final#

final bool obscureText
Implementation
final bool obscureText;

onEditingComplete final#

final dynamic onEditingComplete
Implementation
final VoidCallback? onEditingComplete;

onTapOutside final#

final dynamic onTapOutside
Implementation
final TapRegionCallback? onTapOutside;

overrides final#

final dynamic overrides
Implementation
final RenderOverrides? overrides;

placeholder final#

final String? placeholder
Implementation
final String? placeholder;

prefixMode final#

final dynamic prefixMode
Implementation
final RTextFieldOverlayVisibilityMode prefixMode;

readOnly final#

final bool readOnly
Implementation
final bool readOnly;

runtimeType no setter inherited#

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
external Type get runtimeType;

scrollPadding final#

final dynamic scrollPadding
Implementation
final EdgeInsets scrollPadding;

showCursor final#

final bool? showCursor
Implementation
final bool? showCursor;

slots final#

final dynamic slots
Implementation
final RTextFieldSlots? slots;

smartDashesType final#

final dynamic smartDashesType
Implementation
final SmartDashesType? smartDashesType;

smartQuotesType final#

final dynamic smartQuotesType
Implementation
final SmartQuotesType? smartQuotesType;

style final#

final RTextFieldStyle? style
Implementation
final RTextFieldStyle? style;

suffixMode final#

final dynamic suffixMode
Implementation
final RTextFieldOverlayVisibilityMode suffixMode;

textCapitalization final#

final dynamic textCapitalization
Implementation
final TextCapitalization textCapitalization;

textInputAction final#

final dynamic textInputAction
Implementation
final TextInputAction? textInputAction;

variant final#

final dynamic variant
Implementation
final RTextFieldVariant variant;

Methods#

noSuchMethod() inherited#

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation
external String toString();

Operators#

operator ==() inherited#

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation
external bool operator ==(Object other);