TextSelectionOverlay class Null safety
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})
- Creates an object that manages overlay entries for selection handles.
Properties
- handlesAreVisible → bool
-
Whether the handles are currently visible.
read-only
- handlesVisible ↔ bool
-
Whether selection handles are visible.
read / write
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- 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.
read-onlyinherited
- selectionControls → TextSelectionControls?
-
Builds text selection handles and toolbar.
final
- selectionDelegate → TextSelectionDelegate
-
The delegate for manipulating the current selection in the owning
text field.
final
- toolbarIsVisible → bool
-
Whether the toolbar is currently visible.
read-only
- value → TextEditingValue
-
Retrieve current value.
visibleForTesting">@visibleForTestingread-only
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.
-
hideToolbar(
) → void - Hides the toolbar part of the overlay.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
showHandles(
) → void -
Builds the handles by inserting them into the
context's overlay. -
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.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- fadeDuration → const Duration
-
Controls the fade-in and fade-out animations for the toolbar and handles.
Deprecated('Use `SelectionOverlay.fadeDuration` instead. ' 'This feature was deprecated after v2.12.0-4.1.pre.')">@Deprecated('Use `SelectionOverlay.fadeDuration` instead. ' 'This feature was deprecated after v2.12.0-4.1.pre.')
SelectionOverlay.fadeDuration