Package com.pdftools.toolbox.pdf.annotations

Class FreeText

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.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	Description
static FreeText	create(Document targetDocument, Rectangle boundingBox, java.lang.String content, Paint paint)	Create a free-text annotation.
static FreeText	create(Document targetDocument, Rectangle boundingBox, java.lang.String content, Paint paint, Stroke stroke)	Create a free-text annotation.
HorizontalAlignment	getAlignment()	The text alignment (Getter)
double	getFontSize()	The font size (Getter)
Paint	getPaint()	The paint for the text background and the popup (Getter)
void	setFontSize(double value)	The font size (Setter)

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

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 has already been closed

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

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

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

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

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getPaint has a toolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getPaint has a non-nulltoolbox.pdf.content.Paint.getTransparency with toolbox.pdf.content.Transparency.getBlendMode other than toolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getLineCapStyle is other than toolbox.pdf.content.LineCapStyle.BUTT

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getLineJoinStyle is other than toolbox.pdf.content.LineJoinStyle.MITER

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getMiterLimit is other than 10

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getDashPhase is other than 0

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if boundingBox is null

create

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

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.

stroke - The stroking parameters used for stroking the rectangle. The stroking paint is used as the annotation's main paint.

Returns:

The newly created free text 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 paint has a toolbox.pdf.content.Paint.getColorSpace other than a device color space

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

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

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getPaint has a toolbox.pdf.content.Paint.getColorSpace other than a device color space

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getPaint has a non-nulltoolbox.pdf.content.Paint.getTransparency with toolbox.pdf.content.Transparency.getBlendMode other than toolbox.pdf.content.BlendMode.NORMAL

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getLineCapStyle is other than toolbox.pdf.content.LineCapStyle.BUTT

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getLineJoinStyle is other than toolbox.pdf.content.LineJoinStyle.MITER

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getMiterLimit is other than 10

java.lang.IllegalArgumentException - if the stroke's toolbox.pdf.content.Stroke.getDashPhase is other than 0

java.lang.IllegalArgumentException - if targetDocument is null

java.lang.IllegalArgumentException - if boundingBox is null

getFontSize

public double getFontSize()

The font size (Getter)

Default value: 12.

Note: the font size has no effect when rich text is used

Throws:

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

setFontSize

public void setFontSize(double value)

The font size (Setter)

Default value: 12.

Note: the font size has no effect when rich text is used

Throws:

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

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalArgumentException - if the given value is smaller than 0.0

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