TextStamp
Overview
TextStamp is a class in Aspose.Pdf FOSS for Java.
Inherits from: Stamp.
Represents a text stamp that can be overlaid on a PDF page.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
value | String | Read | Returns the text content of this stamp. |
textState | TextState | Read | Returns the text state for this stamp, creating it lazily if needed. |
wordWrapMode | TextFormattingOptions.WordWrapMode | Read | Returns the word wrap mode for this stamp’s text. |
textAlignment | HorizontalAlignment | Read | Returns the text alignment within the stamp area. |
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 |
|---|---|
TextStamp(value: String) | Creates a new TextStamp with the given text value. |
TextStamp(formattedText: FormattedText) | Creates a new TextStamp from a {@link FormattedText} instance. |
getValue() → String | Returns the text content of this stamp. |
setValue(value: String) | Sets the text content of this stamp. |
getTextState() → TextState | Returns the text state for this stamp, creating it lazily if needed. |
setTextState(textState: TextState) | Sets the text state for this stamp. |
getWordWrapMode() → TextFormattingOptions.WordWrapMode | Returns the word wrap mode for this stamp’s text. |
setWordWrapMode(wordWrapMode: TextFormattingOptions.WordWrapMode) | Sets the word wrap mode for this stamp’s text. |
getTextAlignment() → HorizontalAlignment | Returns the text alignment within the stamp area. |
setTextAlignment(textAlignment: HorizontalAlignment) | Sets the text alignment within the stamp area. |
put(page: Page) | Applies this text 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() → 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. |