EditableTextState class

State for an EditableText.

Inheritance
Implemented types
Mixed-in types

Constructors

EditableTextState.new()

Properties

autofillId → String
The unique identifier of this AutofillClient.
no setteroverride
clipboardStatus → ClipboardStatusNotifier
Detects whether the clipboard can paste.
final
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
contextMenuAnchors → TextSelectionToolbarAnchors
Returns the anchor points for the default context menu.
no setter
contextMenuButtonItems → List<ContextMenuButtonItem>
Returns the ContextMenuButtonItems representing the buttons in this platform's default selection menu for EditableText.
no setter
copyEnabled → bool
Whether copy is enabled.
no setteroverride
currentAutofillScope → AutofillScope?
The AutofillScope this TextInputClient belongs to, if any.
no setteroverride
currentTextEditingValue → TextEditingValue
The current state of the TextEditingValue held by this client.
no setteroverride
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).
no setter
cursorCurrentlyVisible → bool
Whether the blinking cursor is actually visible at this precise moment (it's hidden half the time, since it blinks).
no setter
cutEnabled → bool
Whether cut is enabled.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
liveTextInputEnabled → bool
Whether Live Text input is enabled.
no setteroverride
lookUpEnabled → bool
Whether look up is enabled.
no setteroverride
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
pasteEnabled → bool
Whether paste is enabled.
no setteroverride
renderEditable → RenderEditable
The renderer for this widget's descendant.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchWebEnabled → bool
Whether search web is enabled.
no setteroverride
selectAllEnabled → bool
Whether select all is enabled.
no setteroverride
selectionOverlay → TextSelectionOverlay?
The current status of the text selection handles.
no setter
shareEnabled → bool
Whether share is enabled.
no setteroverride
spellCheckConfiguration → SpellCheckConfiguration
Configuration that determines how spell check will be performed.
no setter
spellCheckEnabled → bool
Whether or not spell check is enabled.
no setter
spellCheckResults ↔ SpellCheckResults?
The most up-to-date spell check results for text input.
getter/setter pair
textEditingValue → TextEditingValue
Gets the current text input.
no setteroverride
textInputConfiguration → TextInputConfiguration
The TextInputConfiguration that describes this AutofillClient.
no setteroverride
wantKeepAlive → bool
Whether the current instance should be kept alive.
no setteroverride
widget → EditableText
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
autofill(TextEditingValue value) → void
Requests this AutofillClient update its TextEditingValue to the given value.
override
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.
override
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
buildTextSpan() → TextSpan
Builds TextSpan from current editing value.
buttonItemsForToolbarOptions([TargetPlatform? targetPlatform]) → List<ContextMenuButtonItem>?
Returns the ContextMenuButtonItems for the given ToolbarOptions.
connectionClosed() → void
Platform notified framework of closed connection.
override
copySelection(SelectionChangedCause cause) → void
Copy current selection to Clipboard.
override
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
cutSelection(SelectionChangedCause cause) → void
Cut current selection to Clipboard.
override
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
override
didChangeInputControl(TextInputControl? oldControl, TextInputControl? newControl) → void
The framework calls this method to notify that the text input control has been changed.
override
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.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
override
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
didUpdateWidget(covariant EditableText oldWidget) → void
Called whenever the widget configuration changes.
override
dispose() → void
Called when this object is removed from the tree permanently.
override
endBatchEdit() → void
Ends the current batch edit started by the last call to beginBatchEdit, and send currentTextEditingValue to the text input plugin if needed.
findSuggestionSpanAtCursorIndex(int cursorIndex) → SuggestionSpan?
Finds specified SuggestionSpan that matches the provided index using binary search.
getGlyphHeights() → ({double endGlyphHeight, double startGlyphHeight})
Gets the line heights at the start and end of the selection for the given EditableTextState.
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
hideMagnifier() → void
Hides the magnifier.
hideToolbar([bool hideHandles = true]) → void
Hides the text selection toolbar.
override
initState() → void
Called when this object is inserted into the tree.
override
insertContent(KeyboardInsertedContent content) → void
Notify client about new content insertion from Android keyboard.
override
insertTextPlaceholder(Size size) → void
Requests that the client add a text placeholder to reserve visual space in the text.
override
lookUpSelection(SelectionChangedCause cause) → Future<void>
Look up the current selection, as in the "Look Up" edit menu button on iOS.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pasteText(SelectionChangedCause cause) → Future<void>
Paste text from Clipboard.
override
performAction(TextInputAction action) → void
Requests that this client perform the given action.
override
performPrivateCommand(String action, Map<String, dynamic> data) → void
Request from the input method that this client perform the given private command.
override
performSelector(String selectorName) → void
Performs the specified MacOS-specific selector from the NSStandardKeyBindingResponding protocol or user-specified selector from DefaultKeyBinding.Dict.
override
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
removeTextPlaceholder() → void
Requests that the client remove the text placeholder.
override
requestKeyboard() → void
Express interest in interacting with the keyboard.
searchWebForSelection(SelectionChangedCause cause) → Future<void>
Launch a web search on the current selection, as in the "Search Web" edit menu button on iOS.
selectAll(SelectionChangedCause cause) → void
Select the entire text value.
override
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
shareSelection(SelectionChangedCause cause) → Future<void>
Launch the share interface for the current selection, as in the "Share..." edit menu button on iOS.
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.
override
showMagnifier(Offset positionToShow) → void
Shows the magnifier at the position given by positionToShow, if no magnifier exists.
showSpellCheckSuggestionsToolbar() → bool
Shows toolbar with spell check suggestions of misspelled words that are available for click-and-replace.
showToolbar() → bool
Shows the selection toolbar at the location of the current cursor.
override
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toggleToolbar([bool hideHandles = true]) → void
Toggles the visibility of the toolbar.
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
updateEditingValue(TextEditingValue value) → void
Requests that this client update its editing state to the given value.
override
updateFloatingCursor(RawFloatingCursorPoint point) → void
Updates the floating cursor position and state.
override
updateKeepAlive() → void
Ensures that any AutomaticKeepAlive ancestors are in a good state, by firing a KeepAliveNotification or triggering the KeepAliveHandle as appropriate.
inherited
userUpdateTextEditingValue(TextEditingValue value, SelectionChangedCause? cause) → void
Indicates that the user has requested the delegate to replace its current text editing state with value.
override

Operators

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