FindInteractionController class

This class represents the controller used by the WebView to add text-finding capabilities, such as the "Find on page" feature.

Constructors

FindInteractionController({void onFindResultReceived(PlatformFindInteractionController controller, int activeMatchOrdinal, int numberOfMatches, bool isDoneCounting)?})
This class represents the controller used by the WebView to add text-finding capabilities, such as the "Find on page" feature.
FindInteractionController.fromPlatform({required PlatformFindInteractionController platform})
Constructs a FindInteractionController from a specific platform implementation.
FindInteractionController.fromPlatformCreationParams({required PlatformFindInteractionControllerCreationParams params})
Constructs a FindInteractionController.

Properties

hashCode int
The hash code for this object.
no setterinherited
onFindResultReceived → void Function(PlatformFindInteractionController controller, int activeMatchOrdinal, int numberOfMatches, bool isDoneCounting)?
no setter
platform PlatformFindInteractionController
Implementation of PlatformFindInteractionController for the current platform.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

clearMatches() Future<void>
Clears the highlighting surrounding text matches created by findAll.
dismissFindNavigator() Future<void>
Dismisses the find panel, if present.
dispose({bool isKeepAlive = false}) → void
Disposes the controller.
findAll({String? find}) Future<void>
Finds all instances of find on the page and highlights them. Notifies PlatformFindInteractionController.onFindResultReceived listener.
findNext({bool forward = true}) Future<void>
Highlights and scrolls to the next match found by findAll. Notifies PlatformFindInteractionController.onFindResultReceived listener.
getActiveFindSession() Future<FindSession?>
If there's a currently active find session, returns the active find session.
getSearchText() Future<String?>
Get the search text used.
isFindNavigatorVisible() Future<bool?>
A Boolean value that indicates when the find panel displays onscreen.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
presentFindNavigator() Future<void>
Begins a search, displaying the find panel.
setSearchText(String? searchText) Future<void>
Pre-populate the search text to be used.
toString() String
A string representation of this object.
inherited
updateResultCount() Future<void>
Updates the results the interface displays for the active search.

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

isClassSupported({TargetPlatform? platform}) bool
Check if the current class is supported by the defaultTargetPlatform or a specific platform.
isMethodSupported(PlatformFindInteractionControllerMethod method, {TargetPlatform? platform}) bool
Check if the given method is supported by the defaultTargetPlatform or a specific platform.
isPropertySupported(PlatformFindInteractionControllerCreationParamsProperty property, {TargetPlatform? platform}) bool