RichFieldController class Null safety
The controller to be used as a TextEditingController for a TextField
Takes a FocusNode to keep focus on the text being edited. That is particularly useful when using a toolbar to style the selected text. If FocusNode is omitted, whenever the text is styled through a toolbar action, the TextField will loos focus.
- Inheritance
-
- Object
- ChangeNotifier
- ValueNotifier<
TextEditingValue> - TextEditingController
- RichFieldController
Constructors
- RichFieldController({FocusNode? focusNode})
Properties
- focusNode ↔ FocusNode?
-
The TextField's FocusNode
read / write
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- selection ↔ TextSelection
-
The currently selected text.
read / writeinherited
- text ↔ String
-
The current string the user is editing.
read / writeinherited
- value ↔ TextEditingValue
-
The current value stored in this notifier.
read / writeinherited-getteroverride-setter
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
buildTextSpan(
{required BuildContext context, TextStyle? style, required bool withComposing}) → TextSpan -
Traverses the current editing value, splits it based on style, and builds
TextSpans
If there are no applied spans, it builds a single span containing the editing value's text and the defaultstyle
override -
clear(
) → void -
Set the value to empty.
inherited
-
clearComposing(
) → void -
Set the composing region to an empty range.
inherited
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
isSelectionWithinTextBounds(
TextSelection selection) → bool -
Check that the
selection
is inside of the bounds of text.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateStyle(
TextStyle style) → void -
This is the core function of the rich_field_controller. I takes a required
style
and applies it to the selected text. If there is no active selection, but the focus is still on theTextFiled
, then the style is applied to the word containing the cursor.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited