AutoFormatter class
Widget that automatically applies TextAttributes to a DocumentController based on FormatRules.
The auto formatter is only a widget for convenience. It can be anywhere in the widget tree.
Attributes applied with the auto formatter are wrapped in an AutoFormatTextAttribute. When serializing, make sure to delete or transform these attributes, or provide a serializer for them.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AutoFormatter
Constructors
-
AutoFormatter({Key? key, required DocumentController controller, required List<
FormatRule> rules, required Widget child}) - Create an auto formatter.
- AutoFormatter.ruleset({Key? key, required DocumentController controller, required FormatRuleset ruleset, required Widget child})
-
Create an auto formatter.
const
Properties
- child → Widget
-
Child of this widget.
final
- controller → DocumentController
-
Document controller to apply formatting to.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- ruleset → FormatRuleset
-
Rules for formatting.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _AutoFormatterState -
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.
override
-
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}) → 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