com.datalogics.PDFL

Class Word

java.lang.Object

com.datalogics.PDFL.Word

public class Word
extends java.lang.Object

A word in a PDF file. Each word contains a sequence of characters in one or more styles (see Style).

Method Summary

Modifier and Type	Method and Description
void	delete()
java.util.EnumSet<WordAttributeFlags>	getAttributes() Gets a set of summary flags containing information on the types of characters in a word.
java.util.List<Quad>	getCharQuads() Gets a list of Quads occupied by the individual characters in a word.
boolean	getIsLastWordInRegion() Specifies whether this word is the last word in a region as determined by the WordFinder.
java.util.List<Quad>	getQuads() Gets the specified word's quads, specified in user space coordinates.
java.util.List<StyleTransition>	getStyleTransitions() Gets a list of style transitions for the word.
java.lang.String	getText() Gets a word's text and also converts ligatures to their constituent characters.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

getText

public java.lang.String getText()

Gets a word's text and also converts ligatures to their constituent characters. The string to return includes any word break characters (such as space characters) that follow the word, but not any that precede the word.

Returns:

The text of the Word.

getQuads

public java.util.List<Quad> getQuads()

Gets the specified word's quads, specified in user space coordinates.

The quad's height is the height of the font's bounding box, not the height of the tallest character used in the word. The font's bounding box is determined by the glyphs in the font that extend farthest above and below the baseline; it often extends somewhat above the top of 'A' and below the bottom of 'y'.

The quad's width is determined from the characters actually present in the word.

For example, the quads for the words "AWAY" and "away" have the same height, but generally do not have the same width unless the font is a mono-spaced font (a font in which all characters have the same width).

Despite the names of the fields in an Quad (TopLeft for top left, BottomLeft for bottom left, and so forth) the corners of Quad do not necessarily have these positions.

Returns:

A list containing the Quads found in the word.

getCharQuads

public java.util.List<Quad> getCharQuads()

Gets a list of Quads occupied by the individual characters in a word.

Returns:

A list containing the Quads found in the words, for each individual character

getStyleTransitions

public java.util.List<StyleTransition> getStyleTransitions()

Gets a list of style transitions for the word. Every word has at least one style transition, at character position zero in the word.

Returns:

the list of StyleTransition objects.

getAttributes

public java.util.EnumSet<WordAttributeFlags> getAttributes()

Gets a set of summary flags containing information on the types of characters in a word.

Returns:

A set of flags containing information on the types of characters in word.

getIsLastWordInRegion

public boolean getIsLastWordInRegion()

Specifies whether this word is the last word in a region as determined by the WordFinder.

This can be useful for determining visual line breaks in tagged PDFs. In tagged PDF documents, WordAttributeFlags.LastWordOnLine is set according to the tags in the document, so that flag cannot be used to determine visual line breaks.

Returns:

true if the word is the last word in a region, false if it is not