Package com.pdftools.toolbox.pdf.annotations

Class TextStamp

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.annotations.Annotation

com.pdftools.toolbox.pdf.annotations.MarkupAnnotation

com.pdftools.toolbox.pdf.annotations.Stamp

com.pdftools.toolbox.pdf.annotations.TextStamp

public class TextStamp
extends Stamp

A text stamp annotation

Method Summary

Modifier and Type	Method	Description
static TextStamp	create(Document targetDocument, Point topLeft, java.lang.Double height, TextStampType textType)	Create a text stamp annotation.
static TextStamp	createRaw(Document targetDocument, Point topLeft, java.lang.Double height, TextStampType textType, java.lang.String text)	Deprecated. Deprecated in Version 4.2.
TextStampType	getTextType()	The displayed text (Getter)

Methods inherited from class com.pdftools.toolbox.pdf.annotations.Stamp

getPopup, getPopupPaint

Methods inherited from class com.pdftools.toolbox.pdf.annotations.MarkupAnnotation

getInfo, getLocked, getReplies

Methods inherited from class com.pdftools.toolbox.pdf.annotations.Annotation

copy, getBoundingBox, getHidden, getId, getNoPrint, getNoRotate, getNoZoom

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

createRaw

public static TextStamp createRaw(Document targetDocument,
                                  Point topLeft,
                                  java.lang.Double height,
                                  TextStampType textType,
                                  java.lang.String text)

Deprecated.

Deprecated in Version 4.2. Use static method TextStamp.Create instead.

Create a text stamp annotation.

The width of the annotation is computed from the given stamp text. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters:

targetDocument - The output document with which the returned object is associated.

topLeft - The location of the annotation's upper left corner on the page.

height - The height of the annotation.

textType - The text stamp type.

text - The text to be shown in this stamp.

Returns:

The newly created text stamp annotation.

Throws:

java.lang.IllegalArgumentException - if the targetDocument has already been closed

java.lang.IllegalArgumentException - if the targetDocument is read-only

java.lang.IllegalArgumentException - if the textType argument is TextStampType.CUSTOM_STAMP_TEXT

java.lang.IllegalArgumentException - if the text argument is empty

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if topLeft is null

java.lang.IllegalArgumentException - if textType is null

java.lang.IllegalArgumentException - if text is null

create

public static TextStamp create(Document targetDocument,
                               Point topLeft,
                               java.lang.Double height,
                               TextStampType textType)

Create a text stamp annotation.

The width of the annotation is computed based on the given textType. The returned text stamp annotation is not yet part of any page. It can be added to a page's list of annotations.

Parameters:

targetDocument - The output document with which the returned object is associated.

topLeft - The location of the annotation's upper left corner on the page.

height - The height of the annotation.

textType - The text stamp type.

Returns:

The newly created text stamp annotation.

Throws:

java.lang.IllegalArgumentException - if the targetDocument has already been closed

java.lang.IllegalArgumentException - if the targetDocument is read-only

java.lang.IllegalArgumentException - if the textType argument is TextStampType.CUSTOM_STAMP_TEXT

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if topLeft is null

java.lang.IllegalArgumentException - if textType is null

getTextType

public TextStampType getTextType()

The displayed text (Getter)

This defines a predefined text for this text stamp.

Throws:

java.lang.IllegalStateException - if the object has already been closed