CreamyEditingController class
A controller for an editable text field.
Similar to TextEditingController but with properties to get several more details about a text like:
- Total number of lines
- Line number of caret
- Shows column number of cursor
Also supports syntax highlighting, and syntax highlight theme type.
- Inheritance
-
- Object
- ChangeNotifier
- ValueNotifier<
TextEditingValue> - CreamyEditingController
- Implemented types
- Available Extensions
Constructors
- CreamyEditingController({String? text, SyntaxHighlighter? syntaxHighlighter, int tabSize = 1})
- Creates a controller for an editable text field.
- CreamyEditingController.fromValue(TextEditingValue? value, {SyntaxHighlighter? syntaxHighlighter, int tabSize = 1})
- Creates a controller for an editable text field from an initial TextEditingValue.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- highlightingEnabled → bool
-
Whether the controller will highlight syntax
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selection ↔ TextSelection
-
The currently selected text.
getter/setter pairoverride
- syntaxHighlighter → SyntaxHighlighter?
-
The syntax highlighter which will parse text from Text Field
final
- tabSize → int
-
The tabSize number of spaces which will be used instead of
\t
. Defaults to 1.final - text ↔ String
-
The current string the user is editing.
getter/setter pairoverride
- value ↔ TextEditingValue
-
The current value stored in this notifier.
getter/setter pairinherited-getteroverride-setter
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
addTab(
) → void -
Appends a tab at the TextSelection.baseOffset and
moves the selection-offset at
previous offset + tab size
. -
buildTextSpan(
{required BuildContext context, TextStyle? style, required bool withComposing}) → TextSpan -
Builds TextSpan from current editing value.
override
-
changeSyntaxHighlighting(
SyntaxHighlighter syntaxHighlighter) → void - Use your own implementation of SyntaxHighlighter.
-
clear(
) → void -
Set the value to empty.
override
-
clearComposing(
) → void -
Set the composing region to an empty range.
override
-
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.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited