Package apple.pdfkit.protocol

Interface PDFPageOverlayViewProvider

public interface PDFPageOverlayViewProvider

API-Since: 16.0

Method Summary

Modifier and Type	Method	Description
@Nullable UIView	pdfViewOverlayViewForPage(@NotNull PDFView view, @NotNull PDFPage page)	Asks the provider for a view to be displayed on top of the specified page.
default void	pdfViewWillDisplayOverlayViewForPage(@NotNull PDFView pdfView, @NotNull UIView overlayView, @NotNull PDFPage page)	Tells the provider that a view returned from `overlayViewForPage` has been added to the view hierarchy and constraints have been set up.
default void	pdfViewWillEndDisplayingOverlayViewForPage(@NotNull PDFView pdfView, @NotNull UIView overlayView, @NotNull PDFPage page)	Tells the provider that a view returned from `overlayViewForPage` will be removed.

Method Detail

pdfViewOverlayViewForPage

@Nullable
@Nullable UIView pdfViewOverlayViewForPage(@NotNull
                                           @NotNull PDFView view,
                                           @NotNull
                                           @NotNull PDFPage page)

Asks the provider for a view to be displayed on top of the specified page.

pdfViewWillDisplayOverlayViewForPage

default void pdfViewWillDisplayOverlayViewForPage(@NotNull
                                                  @NotNull PDFView pdfView,
                                                  @NotNull
                                                  @NotNull UIView overlayView,
                                                  @NotNull
                                                  @NotNull PDFPage page)

Tells the provider that a view returned from `overlayViewForPage` has been added to the view hierarchy and constraints have been set up. At this point, gesture failure handlers may be set up with those of `pdfView`.

pdfViewWillEndDisplayingOverlayViewForPage

default void pdfViewWillEndDisplayingOverlayViewForPage(@NotNull
                                                        @NotNull PDFView pdfView,
                                                        @NotNull
                                                        @NotNull UIView overlayView,
                                                        @NotNull
                                                        @NotNull PDFPage page)

Tells the provider that a view returned from `overlayViewForPage` will be removed. This can be used to restore whatever was done in `overlayView:wasAddedForPage`.