EditableTextState class Null safety

State for a EditableText.

Implemented types
Mixed in types




autofillId String
The unique identifier of this AutofillClient.
read-only, override
context BuildContext
The location in the tree where this widget builds.
read-only, inherited
copyEnabled bool
Whether copy is enabled, must not be null.
read-only, override
currentAutofillScope AutofillScope?
The AutofillScope this TextInputClient belongs to, if any.
read-only, override
currentTextEditingValue TextEditingValue
The current state of the TextEditingValue held by this client.
read-only, override
cursorBlinkInterval Duration
The cursor blink interval (the amount of time the cursor is in the "on" state or the "off" state). A complete cursor blink period is twice this value (half on, half off).
@visibleForTesting, read-only
cursorCurrentlyVisible bool
Whether the blinking cursor is actually visible at this precise moment (it's hidden half the time, since it blinks).
@visibleForTesting, read-only
cutEnabled bool
Whether cut is enabled, must not be null.
read-only, override
hashCode int
The hash code for this object.
read-only, inherited
mounted bool
Whether this State object is currently in a tree.
read-only, inherited
pasteEnabled bool
Whether paste is enabled, must not be null.
read-only, override
renderEditable RenderEditable
The renderer for this widget's descendant.
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selectAllEnabled bool
Whether select all is enabled, must not be null.
read-only, override
selectionOverlay TextSelectionOverlay?
The current status of the text selection handles.
@visibleForTesting, read-only
textEditingValue TextEditingValue
Gets the current text input.
read-only, override
textInputConfiguration TextInputConfiguration
The TextInputConfiguration that describes this AutofillClient.
read-only, override
wantKeepAlive bool
Whether the current instance should be kept alive.
read-only, override
widget EditableText
The current configuration.
read-only, inherited


activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
autofill(TextEditingValue value) → void
Requests this AutofillClient update its TextEditingValue to the given value.
beginBatchEdit() → void
Begins a new batch edit, within which new updates made to the text editing value will not be sent to the platform text input plugin.
bringIntoView(TextPosition position) → void
Brings the provided TextPosition into the visible area of the text input.
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
buildTextSpan() TextSpan
Builds TextSpan from current editing value.
connectionClosed() → void
Platform notified framework of closed connection.
copySelection(SelectionChangedCause cause) → void
Copy current selection to Clipboard.
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
cutSelection(SelectionChangedCause cause) → void
Cut current selection to Clipboard.
deactivate() → void
Called when this object is removed from the tree.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
didChangeDependencies() → void
Called when a dependency of this State object changes.
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
didChangePlatformBrightness() → void
Called when the platform brightness changes.
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
didHaveMemoryPressure() → void
Called when the system is running low on memory.
didPopRoute() Future<bool>
Called when the system tells the app to pop the current route. For example, on Android, this is called when the user presses the back button.
didPushRoute(String route) Future<bool>
Called when the host tells the application to push a new route onto the navigator.
didPushRouteInformation(RouteInformation routeInformation) Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
didUpdateWidget(covariant EditableText oldWidget) → void
Called whenever the widget configuration changes.
dispose() → void
Called when this object is removed from the tree permanently.
endBatchEdit() → void
Ends the current batch edit started by the last call to beginBatchEdit, and send currentTextEditingValue to the text input plugin if needed.
hideToolbar([bool hideHandles = true]) → void
Hides the text selection toolbar.
initState() → void
Called when this object is inserted into the tree.
insertTextPlaceholder(Size size) → void
Requests that the client add a text placeholder to reserve visual space in the text.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
pasteText(SelectionChangedCause cause) Future<void>
Paste text from Clipboard.
performAction(TextInputAction action) → void
Requests that this client perform the given action.
performPrivateCommand(String action, Map<String, dynamic> data) → void
Request from the input method that this client perform the given private command.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
@mustCallSuper, @protected, inherited
removeTextPlaceholder() → void
Requests that the client remove the text placeholder.
requestKeyboard() → void
Express interest in interacting with the keyboard.
selectAll(SelectionChangedCause cause) → void
Select the entire text value.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
@protected, inherited
showAutocorrectionPromptRect(int start, int end) → void
Requests that this client display a prompt rectangle for the given text range, to indicate the range of text that will be changed by a pending autocorrection.
showToolbar() bool
Shows the selection toolbar at the location of the current cursor.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toggleToolbar() → void
Toggles the visibility of the toolbar.
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
updateEditingValue(TextEditingValue value) → void
Requests that this client update its editing state to the given value.
updateFloatingCursor(RawFloatingCursorPoint point) → void
Updates the floating cursor position and state.
updateKeepAlive() → void
Ensures that any AutomaticKeepAlive ancestors are in a good state, by firing a KeepAliveNotification or triggering the KeepAliveHandle as appropriate.
@protected, inherited
userUpdateTextEditingValue(TextEditingValue value, SelectionChangedCause? cause) → void
Indicates that the user has requested the delegate to replace its current text editing state with value.


operator ==(Object other) bool
The equality operator.