com.pdf_tools.fourheights.pdftoolbox.pdf.annotations

Class FreeText

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.FreeText

public class FreeText
extends MarkupAnnotation

An annotation that displays text

For a free-text annotation, the annotation's content is used as text to be displayed as the annotation's visual manifestation on the page.

Method Summary

Modifier and Type	Method and Description
static FreeText	create(Document targetDocument, Rectangle boundingBox, java.lang.String content, Paint paint) Create a free-text annotation.
static FreeText	createDynamicObject(long handle)
HorizontalAlignment	getAlignment() The text alignment (Getter)
Paint	getPaint() The paint for the text background and the popup (Getter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.MarkupAnnotation

getInfo, getLocked, getReplies

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.annotations.Annotation

copy, getBoundingBox, getHidden, getNoPrint, getNoRotate, getNoZoom

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

createDynamicObject

public static FreeText createDynamicObject(long handle)

create

public static FreeText create(Document targetDocument,
                              Rectangle boundingBox,
                              java.lang.String content,
                              Paint paint)

Create a free-text annotation.

The returned free-text 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.

boundingBox - The location on the page.

content - The text content.

paint - This paint used for the background of the free text annotation. If null, the background is transparent.

Returns:

The newly created free text annotation.

Throws:

java.lang.IllegalArgumentException - if the targetDocument is null

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

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

java.lang.IllegalArgumentException - if the paint has a pdftoolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the paint has a non-nullpdftoolbox.pdf.content.Paint.getTransparency with pdftoolbox.pdf.content.Transparency.getBlendMode other than pdftoolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the paint argument is not associated with the targetDocument

java.lang.IllegalArgumentException - if boundingBox is null

getAlignment

public HorizontalAlignment getAlignment()

The text alignment (Getter)

Throws:

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

getPaint

public Paint getPaint()
               throws CorruptException

The paint for the text background and the popup (Getter)

Throws:

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

CorruptException - if the PDF is corrupt and the annotation's paint cannot be read