SuperTextFieldGestureInteractor class

Handles all user gesture interactions for text entry.

SuperTextFieldGestureInteractor is intended to operate as a piece within a larger composition that behaves as a text field. SuperTextFieldGestureInteractor is defined on its own so that it can be replaced with a widget that handles gestures differently.

The gestures are applied to a SuperSelectableText widget that is tied to textKey.

A SuperTextFieldScrollview must sit between this SuperTextFieldGestureInteractor and the underlying SuperSelectableText. That SuperTextFieldScrollview must be tied to textScrollKey.

Inheritance

Constructors

SuperTextFieldGestureInteractor.new({Key? key, required FocusNode focusNode, required AttributedTextEditingController textController, required GlobalKey<ProseTextState<StatefulWidget>> textKey, required GlobalKey<SuperTextFieldScrollviewState> textScrollKey, required bool isMultiline, RightClickListener? onRightClick, List<SuperTextFieldTapHandler> tapHandlers = const [], required Widget child})
const

Properties

child Widget
The rest of the subtree for this text field.
final
focusNode FocusNode
FocusNode for this text field.
final
hashCode int
The hash code for this object.
no setterinherited
isMultiline bool
Whether or not this text field supports multiple lines of text.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onRightClick RightClickListener?
Callback invoked when the user right clicks on this text field.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tapHandlers List<SuperTextFieldTapHandler>
Optional list of handlers that respond to taps on content, e.g., opening a link when the user taps on text with a link attribution.
final
textController AttributedTextEditingController
TextController for the text/selection within this text field.
final
textKey GlobalKey<ProseTextState<StatefulWidget>>
GlobalKey that links this SuperTextFieldGestureInteractor to the ProseTextLayout widget that paints the text for this text field.
final
textScrollKey GlobalKey<SuperTextFieldScrollviewState>
GlobalKey that links this SuperTextFieldGestureInteractor to the SuperTextFieldScrollview that's responsible for scrolling content that exceeds the available space within this text field.
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