Package com.pdf_tools.fourheights.pdftoolbox.pdf.forms

Class CombTextField

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

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.CombTextField

public class CombTextField
extends TextField

A fixed pitch text field

In a comb text field, the GeneralTextField.getMaxLength() must be defined. The glyphs displayed are placed in GeneralTextField.getMaxLength() equally spaced cells.

Method Summary

Modifier and Type	Method	Description
static CombTextField	create(Document targetDocument, int maxLength)	Create a comb text form field
int	getMaxLength()	The maximal text length (Getter)
void	setMaxLength(int value)	The maximal text length (Setter)

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

getAlignment, getFontSize, getText, setAlignment, setFontSize, setText

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

create

public static CombTextField create(Document targetDocument,
                                   int maxLength)

Create a comb text form field

The returned form field object is not yet used, but it is associated with the given target document.

Parameters:

targetDocument - the output document with which the returned object is associated

maxLength - the maximal character length for this field

Returns:

the newly created comb text field

Throws:

java.lang.IllegalArgumentException - if the targetDocument argument has already been closed

java.lang.IllegalArgumentException - if the targetDocument argument is read-only

java.lang.IllegalArgumentException - the target document contains form fields that have been implicitly copied by a call to pdftoolbox.pdf.Page.copy with an argument options in which pdftoolbox.pdf.PageCopyOptions.setFormFields was set to FormFieldCopyStrategy.COPY

java.lang.IllegalArgumentException - the target document contains unsigned signatures that have been implicitly copied by a call to pdftoolbox.pdf.Page.copy with an argument options in which pdftoolbox.pdf.PageCopyOptions.setUnsignedSignatures was set to pdftoolbox.pdf.CopyStrategy.COPY.

java.lang.IllegalArgumentException - if maxLength is smaller than 0

java.lang.IllegalArgumentException - if targetDocument is null

getMaxLength

public int getMaxLength()

The maximal text length (Getter)

When setting this property, the length of this field's text is truncated to the given value.

Throws:

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

setMaxLength

public void setMaxLength(int value)

The maximal text length (Setter)

When setting this property, the length of this field's text is truncated to the given value.

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