com.pdf_tools.fourheights.pdftoolbox.pdf.content

Class TextFragment

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.content.TextFragment

public class TextFragment
extends NativeObject

Method Summary

Modifier and Type	Method and Description
static TextFragment	createDynamicObject(long handle)
Rectangle	getBoundingBox() the bounding box (Getter)
double	getCharacterSpacing() The additional spacing between glyphs (Getter)
Fill	getFill() This text fragment's parameters for filling the text or null if the text is not filled
double	getFontSize() The font size (Getter)
double	getHorizontalScaling() The horizontal scaling factor (Getter)
double	getRise() The rise of the baseline (Getter)
Stroke	getStroke() This text fragment's parameters for stroking the text or null if the text is not stroked
java.lang.String	getText() The string painted by this text fragment
AffineTransform	getTransform() the transform to be applied to the bounding box rectangle (Getter)
double	getWordSpacing() The additional spacing between words (Getter)

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 TextFragment createDynamicObject(long handle)

getBoundingBox

public Rectangle getBoundingBox()

the bounding box (Getter)

This is a rectangle that encompasses all parts of the text fragment.

Throws:

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

getTransform

public AffineTransform getTransform()

the transform to be applied to the bounding box rectangle (Getter)

Use this transform matrix to compute the actual location of the text fragment's bounding box.

Throws:

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

getText

public java.lang.String getText()

The string painted by this text fragment

Throws:

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

getStroke

public Stroke getStroke()

This text fragment's parameters for stroking the text or null if the text is not stroked

Throws:

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

getFill

public Fill getFill()

This text fragment's parameters for filling the text or null if the text is not filled

Throws:

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

getFontSize

public double getFontSize()

The font size (Getter)

Throws:

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

getCharacterSpacing

public double getCharacterSpacing()

The additional spacing between glyphs (Getter)

When the glyph for each character in the text is rendered, the character spacing is added to the horizontal or vertical component of the glyph's displacement, depending on the writing mode. It is subject to scaling by the horizontal scaling if the writing mode is horizontal.

Throws:

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

getWordSpacing

public double getWordSpacing()

The additional spacing between words (Getter)

Word spacing works the same way as character spacing, but applies only to the space character, code 32.

Throws:

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

getHorizontalScaling

public double getHorizontalScaling()

The horizontal scaling factor (Getter)

The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Its value is specified relative to the normal width of the glyphs, with 1 being the normal width.

Throws:

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

getRise

public double getRise()

The rise of the baseline (Getter)

the text rise specifies the distance to move the baseline up or down from its default location. Positive values of text rise move the baseline up. Adjustments to the baseline are useful for drawing superscripts or subscripts.

Throws:

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