pspdfkit/com.pspdfkit.ui.overlay/OverlayLayoutParams

OverlayLayoutParams

open class OverlayLayoutParams : ViewGroup.LayoutParams

Layout parameters for overlay views. Use these layout parameters when adding views to a PDF page using an OverlayViewProvider. To learn more about overlay views and how to use them, please refer to our online guide: https://pspdfkit.com/guides/android/current/features/overlay-views/

Constructors

Link copied to clipboard
constructor(@NonNull pageRect: PageRect, @NonNull sizingMode: OverlayLayoutParams.SizingMode)
Height and width are standard LayoutParams values (i.e.
constructor(@NonNull pageRect: RectF, sizingMode: OverlayLayoutParams.SizingMode)
constructor()
Creates params with an empty pageRect (i.e.

Types

Link copied to clipboard
enum LayoutPosition
Value used for defining whether to layout view around its center or from its top-left corner.
Link copied to clipboard
enum SizingMode
Value used for defining how measuring and layouting of the view will work.

Properties

Link copied to clipboard
@Nullable
open var fixedScreenSize: Size
Override for the size inside pageRect and for noZoom flag handling.
Link copied to clipboard
@NonNull
open var layoutPosition: OverlayLayoutParams.LayoutPosition
Relative position on the overlay view to use as a layout anchor.
Link copied to clipboard
@NonNull
open var minSize: Size
Minimal size (in pixels) for the view.
Link copied to clipboard
open var noZoom: Boolean
When set to true the measured size of the view at zoom level 1 is used at all zoom levels and positioned according to the layoutPosition inside the pageRect.
Link copied to clipboard
@NonNull
val pageRect: PageRect
The position on the page in PDF and display coordinates.
Link copied to clipboard
@NonNull
val sizingMode: OverlayLayoutParams.SizingMode
The coordinate space used for laying out views.