| java.lang.Object | ||
| ↳ | android.view.ViewGroup.LayoutParams | |
| ↳ | com.pspdfkit.ui.overlay.OverlayLayoutParams | |
Class Overview
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/
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | OverlayLayoutParams.LayoutPosition | Value used for defining whether to layout view around its center or from its top-left corner. | |||||||||
| enum | OverlayLayoutParams.SizingMode | Value used for defining how measuring and layouting of the view will work. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
android.view.ViewGroup.LayoutParams
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public Size | fixedScreenSize | Override for the size inside pageRect and for noZoom flag handling. |
|||||||||
| public OverlayLayoutParams.LayoutPosition | layoutPosition | Relative position on the overlay view to use as a layout anchor. | |||||||||
| public Size | minSize | Minimal size (in pixels) for the view. | |||||||||
| public boolean | noZoom | 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. |
|||||||||
| public final PageRect | pageRect | The position on the page in PDF and display coordinates. | |||||||||
| public final OverlayLayoutParams.SizingMode | sizingMode | The coordinate space used for laying out views. | |||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.view.ViewGroup.LayoutParams
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
OverlayLayoutParams(PageRect pageRect, OverlayLayoutParams.SizingMode sizingMode)
Height and width are standard LayoutParams values (i.e.
| |||||||||||
| OverlayLayoutParams(RectF pageRect, OverlayLayoutParams.SizingMode sizingMode) | |||||||||||
|
OverlayLayoutParams()
Creates params with an empty
pageRect (i.e. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.view.ViewGroup.LayoutParams
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Fields
public Size fixedScreenSize
public OverlayLayoutParams.LayoutPosition layoutPosition
Relative position on the overlay view to use as a layout anchor. This only affects views that
are resized during layout, due to being constrained to a specific screen size, i.e. only when
using fixedScreenSize, noZoom, or minSize.
public boolean noZoom
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.
public final OverlayLayoutParams.SizingMode sizingMode
Public Constructors
public OverlayLayoutParams (PageRect pageRect, OverlayLayoutParams.SizingMode sizingMode)
Height and width are standard LayoutParams values (i.e. pixels or size constants).
Parameters
| pageRect | holding the PDF and display coordinates of the view. |
|---|---|
| sizingMode | defines the coordinate space used for layouting. |
public OverlayLayoutParams (RectF pageRect, OverlayLayoutParams.SizingMode sizingMode)
Parameters
| pageRect | holding the PDF and display coordinates of the view. |
|---|---|
| sizingMode | defines the coordinate space used for layouting. |
public OverlayLayoutParams ()
Creates params with an empty pageRect (i.e. equal to [0,0-0,0]) and sizingMode set to LAYOUT.