TextField constructor

TextField({
  1. Key? key,
  2. String initialText = '',
  3. String? value,
  4. int? cursorPosition,
  5. TextEditingController? controller,
  6. bool multiline = false,
  7. bool obscureText = false,
  8. String obscuringCharacter = '*',
  9. Style style = Style.empty,
  10. Style cursorStyle = const Style(modifiers: Modifier.underline),
  11. String placeholder = '',
  12. Style placeholderStyle = const Style(foreground: Color(128, 128, 128)),
  13. bool focused = true,
  14. Map<TextFieldShortcut, TextFieldAction>? customShortcuts,
  15. FocusNode? focusNode,
  16. void onFocusChange(
    1. bool hasFocus
    )?,
})

Creates a TextField.

Implementation

TextField({
  super.key,
  String initialText = '',
  String? value,
  int? cursorPosition,
  TextEditingController? controller,
  this.multiline = false,
  this.obscureText = false,
  this.obscuringCharacter = '*',
  this.style = Style.empty,
  this.cursorStyle = const Style(modifiers: Modifier.underline),
  this.placeholder = '',
  this.placeholderStyle = const Style(foreground: Color(128, 128, 128)),
  this.focused = true,
  this.customShortcuts,
  this.focusNode,
  this.onFocusChange,
}) : controller =
         controller ?? TextEditingController(text: value ?? initialText) {
  if (obscureText && multiline) {
    throw ArgumentError(
      'obscureText cannot be enabled on a multiline TextField.',
    );
  }
  _validateObscuredText(this.controller.text);
  if (obscuringCharacter.characters.length != 1) {
    throw ArgumentError(
      'obscuringCharacter must be a single grapheme cluster.',
    );
  }
  if (obscuringCharacter.contains('\n') ||
      obscuringCharacter.contains('\r')) {
    throw ArgumentError(
      'obscuringCharacter cannot be a newline or carriage return.',
    );
  }
  if (graphemeWidth(obscuringCharacter) != 1) {
    throw ArgumentError(
      'obscuringCharacter must have a terminal column display width of exactly 1.',
    );
  }
  if (cursorPosition != null && controller == null) {
    final text = value ?? initialText;
    final clampedPos = cursorPosition.clamp(0, text.characters.length);
    this.controller.value = TextEditingValue(
      text: text,
      selection: TextSelection.collapsed(
        offset: clampedPos,
        column: clampedPos,
      ),
    );
  }
}