Package apple.uikit.protocol

Interface UIFindInteractionDelegate

All Known Implementing Classes:

PDFView, UITextView

public interface UIFindInteractionDelegate

API-Since: 16.0

Method Summary

Modifier and Type	Method	Description
default void	findInteractionDidBeginFindSession(@NotNull UIFindInteraction interaction, @NotNull UIFindSession session)	Called when the search operation begins (and the system search UI appears).
default void	findInteractionDidEndFindSession(@NotNull UIFindInteraction interaction, @NotNull UIFindSession session)	Called when the current search session has changed or ended.
@Nullable UIFindSession	findInteractionSessionForView(@NotNull UIFindInteraction interaction, @NotNull UIView view)	Called when a find session is requested to begin by the user.

Method Detail

findInteractionDidBeginFindSession

default void findInteractionDidBeginFindSession(@NotNull
                                                @NotNull UIFindInteraction interaction,
                                                @NotNull
                                                @NotNull UIFindSession session)

Called when the search operation begins (and the system search UI appears). This would be a good time to decorate your view to indicate that a search operation is about to occur. System text elements will apply a dimming view around all non-highlighted search results, for instance.

findInteractionDidEndFindSession

default void findInteractionDidEndFindSession(@NotNull
                                              @NotNull UIFindInteraction interaction,
                                              @NotNull
                                              @NotNull UIFindSession session)

Called when the current search session has changed or ended. This would be a good time to remove all decorations applied to found search results, and any decorations added when the search operation began (such as a dimming view).

findInteractionSessionForView

@Nullable
@Nullable UIFindSession findInteractionSessionForView(@NotNull
                                                      @NotNull UIFindInteraction interaction,
                                                      @NotNull
                                                      @NotNull UIView view)

Called when a find session is requested to begin by the user. Return an instance of a UIFindSession implementation to allow the find session to begin, otherwise return nil to prevent the system find panel from appearing.