pspdfkit/com.pspdfkit.annotations.appearance/AppearanceStreamGenerator

AppearanceStreamGenerator

interface AppearanceStreamGenerator

Interface for custom annotation appearance stream generators.

Instances can be set on Annotation via setAppearanceStreamGenerator to replace default PSPDFKit provided appearance stream.

The annotation will use the first page of the PDF opened from DataProvider returned by getDataProviderForAnnotation as its appearance and this content will be embedded into the PDF.

Inheritors

Types

Link copied to clipboard
enum AppearanceStreamGenerationOptions
Options for appearance stream generation.

Functions

Link copied to clipboard
@Nullable
abstract fun getDataProviderForAnnotation(@NonNull annotation: Annotation, @NonNull options: EnumSet<AppearanceStreamGenerator.AppearanceStreamGenerationOptions>): DataProvider
Called when the appearance stream data for the given annotation is needed.
Link copied to clipboard
abstract fun shouldUseGeneratorForAnnotation(@NonNull annotation: Annotation): Boolean
Asks the generator whether it should be used to generate the appearance stream for annotation.