PdfPageStamp

Overview

PdfPageStamp is a class in Aspose.Pdf FOSS for Java. Inherits from: Stamp.

A stamp consisting of an entire PDF page, overlaid onto another page.

Properties

NameTypeAccessDescription
sourcePagePageReadReturns the source page.
originXdoubleReadReturns the horizontal position of the stamp origin.
originYdoubleReadReturns the vertical position of the stamp origin.
rotationfloatReadReturns the rotation angle in degrees.
backgroundbooleanReadReturns whether this stamp is rendered behind the page content.
pageNumberintReadReturns the page number this stamp should be applied to.
stampIdintReadReturns the stamp identifier.
formattedTextFormattedTextReadReturns the bound {@link FormattedText}, or {@code null} if none has been set.
imageFileStringReadReturns the bound image file path, or {@code null}.
imageStreamInputStreamReadReturns the bound image stream, or {@code null}.
pdfFileStringReadReturns the bound PDF file path, or {@code null}.
pdfDocumentDocumentReadReturns the bound PDF document, or {@code null}.
pdfPageNumberintReadReturns the 1-based source PDF page number.

Methods

SignatureDescription
PdfPageStamp(page: Page)Creates a PdfPageStamp from the given source page.
getSourcePage()PageReturns the source page.
setSourcePage(page: Page)Sets the source page.
put(page: Page)Applies this page stamp to the given page.
Stamp()Creates a new empty {@code Stamp} instance.
bindLogo(formattedText: FormattedText)Binds a {@link FormattedText} as the text content (logo) of this stamp.
bindImage(imageFile: String)Binds an image file as the stamp source.
bindPdf(pdfFile: String, pageNumber: int)Binds a PDF page as the stamp source.
setOrigin(x: double, y: double)Sets the origin (position) of the stamp on the page.
getOriginX()doubleReturns the horizontal position of the stamp origin.
getOriginY()doubleReturns the vertical position of the stamp origin.
getRotation()floatReturns the rotation angle in degrees.
setRotation(rotation: float)Sets the rotation angle in degrees.
isBackground()booleanReturns whether this stamp is rendered behind the page content.
setBackground(background: boolean)Sets whether this stamp is rendered behind the page content.
getPageNumber()intReturns the page number this stamp should be applied to.
setPageNumber(pageNumber: int)Sets the page number this stamp should be applied to.
getStampId()intReturns the stamp identifier.
setStampId(stampId: int)Sets the stamp identifier.
getFormattedText()FormattedTextReturns the bound {@link FormattedText}, or {@code null} if none has been set.
getImageFile()StringReturns the bound image file path, or {@code null}.
getImageStream()InputStreamReturns the bound image stream, or {@code null}.
getPdfFile()StringReturns the bound PDF file path, or {@code null}.
getPdfDocument()DocumentReturns the bound PDF document, or {@code null}.
getPdfPageNumber()intReturns the 1-based source PDF page number.

See Also