SubstringHighlight class

Widget that renders a string with first occurrence sub-string highlighting. Widget that renders a string with first occurrence sub-string highlighting.

Inheritance

Constructors

SubstringHighlight({Key? key, bool caseSensitive = false, int? maxLines, TextOverflow overflow = TextOverflow.clip, String? term, List<String>? terms, required String text, TextAlign textAlign = TextAlign.left, TextStyle textStyle = const TextStyle(color: Colors.black), TextStyle textStyleHighlight = const TextStyle(color: Colors.red), String wordDelimiters = ' .,;?!<>[]~`@#\$%^&*()+-=|/_', bool words = false})
Creates a SubstringHighlight widget.
const

Properties

caseSensitive → bool
Whether the search should be case-sensitive.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxLines → int?
An optional maximum number of lines for the text to span, wrapping if necessary.
final
overflow → TextOverflow
How visual overflow should be handled.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
term → String?
A single term to search for within the text.
final
terms → List<String>?
A list of terms to search for within the text.
final
text → String
The text to be displayed and searched.
final
textAlign → TextAlign
How the text should be aligned horizontally.
final
textStyle → TextStyle
The style to use for non-highlighted text.
final
textStyleHighlight → TextStyle
The style to use for highlighted text.
final
wordDelimiters → String
The set of characters that are used as word boundaries.
final
words → bool
Whether to match only whole words.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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