IOSEditingControls class

Overlay editing controls for an iOS-style text field.

IOSEditingControls is intended to be displayed in the app's Overlay so that its controls appear on top of everything else in the app.

The given IOSEditingOverlayController controls the presentation of IOSEditingControls. Use the controller to show/hide the iOS-style toolbar, magnifier, and expanded selection handles.

Inheritance

Constructors

IOSEditingControls({Key? key, required IOSEditingOverlayController editingController, required TextScrollController textScrollController, required GlobalKey<State<StatefulWidget>> textFieldKey, required GlobalKey<ProseTextState<StatefulWidget>> textContentKey, required LayerLink textFieldLayerLink, required LayerLink textContentLayerLink, String? tapRegionGroupId, required Color handleColor, required Widget popoverToolbarBuilder(BuildContext, IOSEditingOverlayController), bool showDebugPaint = false})
const

Properties

editingController → IOSEditingOverlayController
Controller that determines whether the toolbar, magnifier, and/or selection handles are visible in this IOSEditingControls.
final
handleColor → Color
The color of the selection handles.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
popoverToolbarBuilder → Widget Function(BuildContext, IOSEditingOverlayController)
Builder that constructs the popover toolbar that's displayed above selected text.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showDebugPaint → bool
Whether to paint debug guides.
final
tapRegionGroupId → String?
A group ID for TapRegions that surround each overlay widget, e.g., drag handles.
final
textContentKey → GlobalKey<ProseTextState<StatefulWidget>>
GlobalKey that references the widget that contains the field's text.
final
LayerLink that is anchored to the (possibly scrolling) content within the text field.
final
textFieldKey → GlobalKey<State<StatefulWidget>>
GlobalKey that references the overall text field, i.e., the viewport that contains text that's (possibly) larger than the visible area.
final
LayerLink that is anchored to the text field's boundary.
final
textScrollController → TextScrollController
Controller that auto-scrolls text based on handle location.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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