nutrient/com.pspdfkit.document.processor/NewPage

NewPage

Settings for new page to be added to a PDF. Instances of this class are immutable and can be generated using the Builder.

Types

Builder

open class Builder

Builder for NewPage objects.

OnDrawCanvasCallback

interface OnDrawCanvasCallback

Callback passed to fromCanvas to perform the drawing on the document canvas.

Properties

backgroundColor

@ColorInt

val backgroundColor: Int

The background color of the page.

margins

@NonNull

val margins: EdgeInsets

The margins of the page content in PDF points.

PAGE_SIZE_A0

val PAGE_SIZE_A0: Size

Standard A0 841x1189mm size.

PAGE_SIZE_A4

val PAGE_SIZE_A4: Size

Standard A4 210x297mm size.

PAGE_SIZE_A5

val PAGE_SIZE_A5: Size

Standard A5 148x210mm size.

PAGE_SIZE_B4

val PAGE_SIZE_B4: Size

Standard B4 250x353mm size.

PAGE_SIZE_B5

val PAGE_SIZE_B5: Size

Standard B5 176x250mm size.

PAGE_SIZE_US_LEGAL

val PAGE_SIZE_US_LEGAL: Size

Standard US letter 8.5x11" size.

PAGE_SIZE_US_LETTER

val PAGE_SIZE_US_LETTER: Size

Standard US legal 8.5x14" size.

pageSize

@NonNull

val pageSize: Size

The size of the page in PDF points.

rotation

@IntRange(from = "-270", to = 270)

val rotation: Int

The rotation of the page in degrees.

sourceDocument

@Nullable

val sourceDocument: InternalPdfDocument

The source document when copying a page from an existing PDF.

Functions

emptyPage

@NonNull

open fun emptyPage(@NonNull pageSize: Size): NewPage.Builder

Creates a new empty page.

fromCanvas

@NonNull

open fun fromCanvas(@NonNull pageSize: Size, @NonNull callback: NewPage.OnDrawCanvasCallback): NewPage.Builder

Creates a new page from a Canvas holding all the draw calls.

fromPage

@NonNull

open fun fromPage(@NonNull sourceDocument: PdfDocument, pageIndex: Int): NewPage.Builder

Copies page from a source document.

hasPatternSource

open fun hasPatternSource(): Boolean

Used to determine whether new page was created using pattern.

hasPdfPageSource

open fun hasPdfPageSource(): Boolean

Used to determine whether new page was created using PDF document as its source.

patternPage

@NonNull

open fun patternPage(@NonNull pageSize: Size, @NonNull pattern: PagePattern): NewPage.Builder

Creates a new page with a preset pattern.

toString

open fun toString(): String

Returns a string representation of this page configuration including size, margins, rotation, and background color.