ExtendedTextSelectionOverlay class
An object that manages a pair of text selection handles.
The selection handles are displayed in the Overlay that most closely encloses the given BuildContext.
Constructors
- ExtendedTextSelectionOverlay({required TextEditingValue value, required BuildContext context, Widget? debugRequiredFor, required LayerLink toolbarLayerLink, required LayerLink startHandleLayerLink, required LayerLink endHandleLayerLink, required ExtendedTextSelectionRenderObject renderObject, TextSelectionControls? selectionControls, bool handlesVisible = false, TextSelectionDelegate? selectionDelegate, DragStartBehavior dragStartBehavior = DragStartBehavior.start, VoidCallback? onSelectionHandleTapped, ClipboardStatusNotifier? clipboardStatus})
- Creates an object that manages overly entries for selection handles.
Properties
- clipboardStatus → ClipboardStatusNotifier?
-
Maintains the status of the clipboard for determining if its contents can
be pasted or not.
final
- context → BuildContext
-
The context in which the selection handles should appear.
final
- debugRequiredFor → Widget?
-
Debugging information for explaining why the Overlay is required.
final
- dragStartBehavior → DragStartBehavior
-
Determines the way that drag start behavior is handled.
final
- endHandleLayerLink → LayerLink
-
The objects supplied to the CompositedTransformTarget that wraps the
location of end selection handle.
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
- onSelectionHandleTapped → VoidCallback?
-
A callback that's invoked when a selection handle is tapped.
final
- renderObject → ExtendedTextSelectionRenderObject
-
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
- startHandleLayerLink → LayerLink
-
The objects supplied to the CompositedTransformTarget that wraps the
location of start selection handle.
final
- toolbarIsVisible → bool
-
Whether the toolbar is currently visible.
no setter
- toolbarLayerLink → LayerLink
-
The object supplied to the CompositedTransformTarget that wraps the text
field.
final
- value → TextEditingValue
-
Retrieve current value.
no setter
Methods
-
dispose(
) → void - Final cleanup.
-
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 nonexistent 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.