public abstract Class FDFAnnotationTextMarkup

Class Inheritance

java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup

Known Direct Subclasses

org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline, org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight, org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly, org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut

Imports

java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.w3c.dom.Element

This abstract class is used as a superclass for the different FDF annotations with text markup attributes.

Author: Johanneke Lamberink

Field Summary

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:: annot

Constructor Summary

Access	Constructor and Description
public	FDFAnnotationTextMarkup() Default constructor.
public	FDFAnnotationTextMarkup(COSDictionary An existing FDF Annotation. a) Constructor.
public	FDFAnnotationTextMarkup(Element An XFDF element. element) Constructor.

Method Summary

Modifier and Type	Method and Description
public float[]	Returns: the array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals. getCoords() Get the coordinates of individual words or group of words.
public void	setCoords(float[] an array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals. coords) Set the coordinates of individual words or group of words.

Constructor Detail

FDFAnnotationTextMarkup	back to summary
public FDFAnnotationTextMarkup() Default constructor.

FDFAnnotationTextMarkup	back to summary
public FDFAnnotationTextMarkup(COSDictionary a) Constructor. Parameters a:COSDictionary An existing FDF Annotation.

FDFAnnotationTextMarkup

back to summary

public FDFAnnotationTextMarkup(COSDictionary a)

Constructor.

Parameters

a:COSDictionary: An existing FDF Annotation.

FDFAnnotationTextMarkup	back to summary
public FDFAnnotationTextMarkup(Element element) throws IOException Constructor. Parameters element:Element An XFDF element. Exceptions IOException: If there is an error extracting information from the element.

FDFAnnotationTextMarkup

back to summary

public FDFAnnotationTextMarkup(Element element) throws IOException

Constructor.

Parameters

element:Element: An XFDF element.

Exceptions

IOException:: If there is an error extracting information from the element.

Method Detail

getCoords back to summary

getCoords	back to summary
public float[] getCoords() Get the coordinates of individual words or group of words. Returns:float[] the array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals. See Also `setCoords(float[])`

public float[] getCoords()

Get the coordinates of individual words or group of words.

Returns:float[]: the array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals.
See Also: setCoords(float[])

setCoords	back to summary
public void setCoords(float[] coords) Set the coordinates of individual words or group of words. The quadliterals shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order x1 y1 x2 y2 x3 y3 x4 y4. Parameters coords:float[] an array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals.

setCoords

back to summary

public void setCoords(float[] coords)

Set the coordinates of individual words or group of words. The quadliterals shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order x1 y1 x2 y2 x3 y3 x4 y4.

Parameters

coords:float[]: an array of 8 􏰍 n numbers specifying the coordinates of n quadrilaterals.