PlatformFindInteractionController class abstract

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

Inheritance
Implemented types
Annotations
  • @SupportedPlatforms.new(platforms: [AndroidPlatform(), IOSPlatform(), MacOSPlatform(), LinuxPlatform(), WindowsPlatform()])

Constructors

PlatformFindInteractionController(PlatformFindInteractionControllerCreationParams params)
Creates a new PlatformFindInteractionController
factory
PlatformFindInteractionController.implementation(PlatformFindInteractionControllerCreationParams params)
Used by the platform implementation to create a new PlatformFindInteractionController.
PlatformFindInteractionController.static()
Creates a new PlatformFindInteractionController
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
onFindResultReceived → void Function(PlatformFindInteractionController controller, int activeMatchOrdinal, int numberOfMatches, bool isDoneCounting)?
Event fired as find-on-page operations progress. The listener may be notified multiple times while the operation is underway, and the numberOfMatches value should not be considered final unless isDoneCounting is true.
no setter
params → PlatformFindInteractionControllerCreationParams
The parameters used to initialize the PlatformFindInteractionController.
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.
override
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.
isClassSupported({TargetPlatform? platform}) → bool
Check if the current class is supported by the defaultTargetPlatform or a specific platform.
isFindNavigatorVisible() → Future<bool?>
A Boolean value that indicates when the find panel displays onscreen.
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
Check if the given property is supported by the defaultTargetPlatform or a specific platform.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
presentFindNavigator() → Future<void>
Begins a search, displaying the find panel.
setFindOptions({FindOptions? options}) → Future<void>
Sets the options used for find-on-page operations.
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 Properties

debugLoggingSettings ↔ DebugLoggingSettings
Debug settings.
getter/setter pair