SubstringHighlight class Null safety

Widget that renders a string with sub-string highlighting.

Inheritance

Constructors

SubstringHighlight({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})

Properties

caseSensitive bool
By default the search terms are case insensitive. Pass false to force case sensitive matches.
final
hashCode int
The hash code for this object.
read-onlyinherited
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. If the text exceeds the given number of lines, it will be truncated according to overflow.
final
overflow TextOverflow
How visual overflow should be handled.
final
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
term String?
The sub-string that is highlighted inside {SubstringHighlight.text}. (Either term or terms must be passed. If both are passed they are combined.)
final
terms List<String>?
The array of sub-strings that are highlighted inside {SubstringHighlight.text}. (Either term or terms must be passed. If both are passed they are combined.)
final
text String
The String searched by {SubstringHighlight.term} and/or {SubstringHighlight.terms} array.
final
textAlign TextAlign
How the text should be aligned horizontally.
final
textStyle TextStyle
The {TextStyle} of the {SubstringHighlight.text} that isn't highlighted.
final
textStyleHighlight TextStyle
The {TextStyle} of the {SubstringHighlight.term}/{SubstringHighlight.ters} matched.
final
wordDelimiters String
String of characters that define word delimiters if {words} flag is true.
final
words bool
If true then match complete words only (instead of characters or substrings within words). This feature is in ALPHA... use 'words' AT YOUR OWN RISK!!!
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 non-existent 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