Class WidgetAnnotation

java.lang.Object

org.openpdf.renderer.annotation.PDFAnnotation

org.openpdf.renderer.annotation.WidgetAnnotation

public class WidgetAnnotation
extends PDFAnnotation

PDF annotation describing a widget.

Since:

Aug 20, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WidgetAnnotation.FieldType	Type for PDF form elements

Nested classes/interfaces inherited from class PDFAnnotation

PDFAnnotation.Flags

Field Summary

Fields inherited from class PDFAnnotation

GOTO, GOTOE, GOTOR, URI

Constructor Summary

Constructors

Constructor	Description
WidgetAnnotation(PDFObject annotObject)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	Name for this widget.
WidgetAnnotation.FieldType	getFieldType()	Returns the type of the field
String	getFieldValue()	The field's value as a string.
List<PDFCmd>	getPageCommandsForAnnotation()	Get list of pdf commands for this annotation
void	setFieldValue(String fieldValue)	Sets the field value for a text field.

Methods inherited from class PDFAnnotation

createAnnotation, getAnnotationName, getAppearanceState, getContents, getFlags, getModified, getPdfObj, getRect, getScalingTransformation, getSubType, getType, isFlagSet, parseRect, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WidgetAnnotation

public WidgetAnnotation(PDFObject annotObject)
                 throws IOException

Throws:

IOException

Method Details

getFieldType

public WidgetAnnotation.FieldType getFieldType()

Returns the type of the field

Returns:

Field type

getFieldValue

public String getFieldValue()

The field's value as a string. Might be null.

Returns:

The field value or null.

setFieldValue

public void setFieldValue(String fieldValue)

Sets the field value for a text field. Note: this doesn't actually change the PDF file yet.

Parameters:

fieldValue - The new value for the text field

getFieldName

public String getFieldName()

Name for this widget.

Returns:

Widget name

getPageCommandsForAnnotation

public List<PDFCmd> getPageCommandsForAnnotation()

Description copied from class: PDFAnnotation

Get list of pdf commands for this annotation

Overrides:

getPageCommandsForAnnotation in class PDFAnnotation

Returns: