TextSelectionOverlay class

An object that manages a pair of text selection handles for a RenderEditable.

This class is a wrapper of SelectionOverlay to provide APIs specific for RenderEditables. To manage selection handles for custom widgets, use SelectionOverlay instead.

Constructors

TextSelectionOverlay({required TextEditingValue value, required BuildContext context, Widget? debugRequiredFor, required LayerLink toolbarLayerLink, required LayerLink startHandleLayerLink, required LayerLink endHandleLayerLink, required RenderEditable renderObject, TextSelectionControls? selectionControls, bool handlesVisible = false, required TextSelectionDelegate selectionDelegate, DragStartBehavior dragStartBehavior = DragStartBehavior.start, VoidCallback? onSelectionHandleTapped, ClipboardStatusNotifier? clipboardStatus, WidgetBuilder? contextMenuBuilder, required TextMagnifierConfiguration magnifierConfiguration})
Creates an object that manages overlay entries for selection handles.

Properties

context BuildContext
The context in which the selection UI should appear.
final
contextMenuBuilder WidgetBuilder?
Builds the text selection toolbar when requested by the user.
final
handlesAreVisible bool
Whether the handles are currently visible.
no setter
handlesVisible bool
Whether selection handles are visible.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
magnifierIsVisible bool
Whether the magnifier is currently visible.
no setter
renderObject RenderEditable
The editable line in which the selected text is being displayed.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectionControls TextSelectionControls?
Builds text selection handles and toolbar.
final
selectionDelegate TextSelectionDelegate
The delegate for manipulating the current selection in the owning text field.
final
spellCheckToolbarIsVisible bool
Whether the spell check menu is currently visible.
no setter
toolbarIsVisible bool
Whether the toolbar is currently visible.
no setter
value TextEditingValue
Retrieve current value.
no setter

Methods

dispose() → void
Disposes this object and release resources.
hide() → void
Hides the entire overlay including the toolbar and the handles.
hideHandles() → void
Destroys the handles by removing them from overlay.
hideMagnifier() → void
Hide the current magnifier.
hideToolbar() → void
Hides the toolbar part of the overlay.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
showHandles() → void
Builds the handles by inserting them into the context's overlay.
showMagnifier(Offset positionToShow) → void
Shows the magnifier, and hides the toolbar if it was showing when showMagnifier was called. This is safe to call on platforms not mobile, since a magnifierBuilder will not be provided, or the magnifierBuilder will return null on platforms not mobile.
showSpellCheckSuggestionsToolbar(WidgetBuilder spellCheckSuggestionsToolbarBuilder) → void
Shows toolbar with spell check suggestions of misspelled words that are available for click-and-replace.
showToolbar() → void
Shows the toolbar by inserting it into the context's overlay.
toString() String
A string representation of this object.
inherited
update(TextEditingValue newValue) → void
Updates the overlay after the selection has changed.
updateForScroll() → void
Causes the overlay to update its rendering.
updateMagnifier(Offset positionToShow) → void
Update the current magnifier with new selection data, so the magnifier can respond accordingly.

Operators

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