Stamp
Overview
Stamp is a class in Aspose.PDF FOSS for Java.
Represents a stamp in the facades API that can be applied via {@link PdfFileStamp}.
This class provides 26 methods for working with Stamp objects in Java programs.
Available methods include: Stamp, bindImage, bindLogo, bindPdf, getFormattedText, getImageFile, getImageStream, getOriginX, getOriginY, getPageNumber, getPdfDocument, getPdfFile, and 9 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: background, formattedText, imageFile, imageStream, originX, originY, and 6 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
originX | double | Read | Returns the horizontal position of the stamp origin. |
originY | double | Read | Returns the vertical position of the stamp origin. |
rotation | float | Read | Returns the rotation angle in degrees. |
background | boolean | Read | Returns whether this stamp is rendered behind the page content. |
pageNumber | int | Read | Returns the page number this stamp should be applied to. |
stampId | int | Read | Returns the stamp identifier. |
formattedText | FormattedText | Read | Returns the bound {@link FormattedText}, or {@code null} if none has been set. |
imageFile | String | Read | Returns the bound image file path, or {@code null}. |
imageStream | InputStream | Read | Returns the bound image stream, or {@code null}. |
pdfFile | String | Read | Returns the bound PDF file path, or {@code null}. |
pdfDocument | Document | Read | Returns the bound PDF document, or {@code null}. |
pdfPageNumber | int | Read | Returns the 1-based source PDF page number. |
Methods
| Signature | Description |
|---|---|
Stamp() | Creates a new empty {@code Stamp} instance. |
bindLogo(formattedText: FormattedText) | Binds a {@link FormattedText} as the text content (logo) of this stamp. |
bindLogo(logoFile: String) | Convenience overload: binds an image file as the logo. |
bindImage(imageFile: String) | Binds an image file as the stamp source. |
bindImage(imageStream: InputStream) | Binds an image stream as the stamp source. |
bindPdf(pdfFile: String) | Convenience overload: binds the first page of {@code pdfFile} as the |
| stamp source. | |
bindPdf(pdfStream: InputStream) | Binds the first page of a PDF stream as the stamp source. |
bindPdf(pdfFile: String, pageNumber: int) | Binds a PDF page as the stamp source. |
bindPdf(document: Document, pageNumber: int) | Binds a page from an existing document as the stamp source. |
setOrigin(x: double, y: double) | Sets the origin (position) of the stamp on the page. |
getOriginX() → double | Returns the horizontal position of the stamp origin. |
getOriginY() → double | Returns the vertical position of the stamp origin. |
getRotation() → float | Returns the rotation angle in degrees. |
setRotation(rotation: float) | Sets the rotation angle in degrees. |
isBackground() → boolean | Returns whether this stamp is rendered behind the page content. |
setBackground(background: boolean) | Sets whether this stamp is rendered behind the page content. |
getPageNumber() → int | Returns the page number this stamp should be applied to. |
setPageNumber(pageNumber: int) | Sets the page number this stamp should be applied to. |
getStampId() → int | Returns the stamp identifier. |
setStampId(stampId: int) | Sets the stamp identifier. |
getFormattedText() → FormattedText | Returns the bound {@link FormattedText}, or {@code null} if none has been set. |
getImageFile() → String | Returns the bound image file path, or {@code null}. |
getImageStream() → InputStream | Returns the bound image stream, or {@code null}. |
getPdfFile() → String | Returns the bound PDF file path, or {@code null}. |
getPdfDocument() → Document | Returns the bound PDF document, or {@code null}. |
getPdfPageNumber() → int | Returns the 1-based source PDF page number. |
