com.pdf_tools.fourheights.pdftoolbox.pdf.forms

Class TextField

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.FieldNode

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.Field

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.TextField

Direct Known Subclasses:

CombTextField, GeneralTextField

public class TextField
extends Field

A text field

Method Summary

Modifier and Type	Method and Description
static TextField	createDynamicObject(long handle)
HorizontalAlignment	getAlignment() The text alignment (Getter)
java.lang.Double	getFontSize() The font size (Getter)
java.lang.String	getText() This field's text (Getter)
void	setAlignment(HorizontalAlignment value) The text alignment (Setter)
void	setFontSize(java.lang.Double value) The font size (Setter)
void	setText(java.lang.String value) This field's text (Setter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.forms.Field

addNewWidget, getDoNotExport, getReadOnly, getRequired, getWidgets, setDoNotExport, setReadOnly, setRequired

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.forms.FieldNode

copy, getDisplayName, getExportName, setDisplayName, setExportName

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

getText

public java.lang.String getText()

This field's text (Getter)

Throws:

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

setText

public void setText(java.lang.String value)

This field's text (Setter)

Throws:

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

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

java.lang.IllegalStateException - the form field is marked as read-only

java.lang.IllegalStateException - if the form field has widgets

java.lang.IllegalArgumentException - the string length of the given value exceeds the text field's GeneralTextField.getMaxLength()

getAlignment

public HorizontalAlignment getAlignment()

The text alignment (Getter)

Throws:

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

setAlignment

public void setAlignment(HorizontalAlignment value)

The text alignment (Setter)

Throws:

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

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

java.lang.IllegalStateException - if the form field has widgets

java.lang.IllegalArgumentException - if value is null

getFontSize

public java.lang.Double getFontSize()

The font size (Getter)

If null then the font size is chosen automatically by the PDF viewer.

Throws:

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

setFontSize

public void setFontSize(java.lang.Double value)

The font size (Setter)

If null then the font size is chosen automatically by the PDF viewer.

Throws:

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

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

java.lang.IllegalStateException - if the form field has widgets

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