Module com.github.librepdf.openpdf

Package com.lowagie.text.pdf

Class PdfFormField

java.lang.Object

com.lowagie.text.pdf.PdfObject

com.lowagie.text.pdf.PdfDictionary

com.lowagie.text.pdf.PdfAnnotation

com.lowagie.text.pdf.PdfFormField

@Deprecated
public class PdfFormField
extends PdfAnnotation

Deprecated.

Implements form fields.

Author:

Paulo Soares (psoares@consiste.pt)

Nested Class Summary

Nested classes/interfaces inherited from class com.lowagie.text.pdf.PdfAnnotation

PdfAnnotation.PdfImportedLink

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FF_COMB	Deprecated.
static final int	FF_COMBO	Deprecated.
static final int	FF_DONOTSCROLL	Deprecated.
static final int	FF_DONOTSPELLCHECK	Deprecated.
static final int	FF_EDIT	Deprecated.
static final int	FF_FILESELECT	Deprecated.
static final int	FF_MULTILINE	Deprecated.
static final int	FF_MULTISELECT	Deprecated.
static final int	FF_NO_EXPORT	Deprecated.
static final int	FF_NO_TOGGLE_TO_OFF	Deprecated.
static final int	FF_PASSWORD	Deprecated.
static final int	FF_PUSHBUTTON	Deprecated.
static final int	FF_RADIO	Deprecated.
static final int	FF_RADIOSINUNISON	Deprecated.
static final int	FF_READ_ONLY	Deprecated.
static final int	FF_REQUIRED	Deprecated.
static final PdfName	IF_SCALE_ALWAYS	Deprecated.
static final PdfName	IF_SCALE_ANAMORPHIC	Deprecated.
static final PdfName	IF_SCALE_BIGGER	Deprecated.
static final PdfName	IF_SCALE_NEVER	Deprecated.
static final PdfName	IF_SCALE_PROPORTIONAL	Deprecated.
static final PdfName	IF_SCALE_SMALLER	Deprecated.
protected List<PdfFormField>	kids	Deprecated.
static final int	MK_CAPTION_ABOVE	Deprecated.
static final int	MK_CAPTION_BELOW	Deprecated.
static final int	MK_CAPTION_LEFT	Deprecated.
static final int	MK_CAPTION_OVERLAID	Deprecated.
static final int	MK_CAPTION_RIGHT	Deprecated.
static final int	MK_NO_CAPTION	Deprecated.
static final int	MK_NO_ICON	Deprecated.
static final boolean	MULTILINE	Deprecated.
protected PdfFormField	parent	Deprecated. Holds value of property parent.
static final boolean	PASSWORD	Deprecated.
static final boolean	PLAINTEXT	Deprecated.
static final int	Q_CENTER	Deprecated.
static final int	Q_LEFT	Deprecated.
static final int	Q_RIGHT	Deprecated.
static final boolean	SINGLELINE	Deprecated.

Fields inherited from class com.lowagie.text.pdf.PdfAnnotation

AA_BLUR, AA_DOWN, AA_ENTER, AA_EXIT, AA_FOCUS, AA_JS_CHANGE, AA_JS_FORMAT, AA_JS_KEY, AA_JS_OTHER_CHANGE, AA_UP, annotation, APPEARANCE_DOWN, APPEARANCE_NORMAL, APPEARANCE_ROLLOVER, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINT, FLAGS_READONLY, FLAGS_TOGGLENOVIEW, form, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, MARKUP_HIGHLIGHT, MARKUP_SQUIGGLY, MARKUP_STRIKEOUT, MARKUP_UNDERLINE, reference, templates, used, writer

Fields inherited from class com.lowagie.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class com.lowagie.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfFormField(PdfWriter writer)	Deprecated. Creates new PdfFormField
	PdfFormField(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)	Deprecated. Constructs a new PdfAnnotation of subtype link (Action).

Method Summary

Modifier and Type	Method	Description
void	addKid(PdfFormField field)	Deprecated.
protected static PdfFormField	createButton(PdfWriter writer, int flags)	Deprecated.
static PdfFormField	createCheckBox(PdfWriter writer)	Deprecated.
protected static PdfFormField	createChoice(PdfWriter writer, int flags, PdfArray options, int topIndex)	Deprecated.
static PdfFormField	createCombo(PdfWriter writer, boolean edit, String[][] options, int topIndex)	Deprecated.
static PdfFormField	createCombo(PdfWriter writer, boolean edit, String[] options, int topIndex)	Deprecated.
static PdfFormField	createEmpty(PdfWriter writer)	Deprecated.
static PdfFormField	createList(PdfWriter writer, String[][] options, int topIndex)	Deprecated.
static PdfFormField	createList(PdfWriter writer, String[] options, int topIndex)	Deprecated.
static PdfFormField	createPushButton(PdfWriter writer)	Deprecated.
static PdfFormField	createRadioButton(PdfWriter writer, boolean noToggleToOff)	Deprecated.
static PdfFormField	createSignature(PdfWriter writer)	Deprecated.
static PdfFormField	createTextField(PdfWriter writer)	Deprecated. Allows creation of a simple textfield.
static PdfFormField	createTextField(PdfWriter writer, boolean multiline, boolean password, int maxLen)	Deprecated.
List<PdfFormField>	getKidFields()	Deprecated.
PdfFormField	getParent()	Deprecated. Getter for property parent.
protected static PdfArray	processOptions(String[] options)	Deprecated.
protected static PdfArray	processOptions(String[][] options)	Deprecated.
void	setButton(int flags)	Deprecated.
void	setDefaultValueAsName(String s)	Deprecated.
void	setDefaultValueAsString(String s)	Deprecated.
int	setFieldFlags(int flags)	Deprecated.
void	setFieldName(String s)	Deprecated.
void	setMappingName(String s)	Deprecated.
void	setQuadding(int v)	Deprecated.
void	setUsed()	Deprecated. Setter for property used.
void	setUserName(String s)	Deprecated.
void	setValue(PdfSignature sig)	Deprecated.
void	setValueAsName(String s)	Deprecated.
void	setValueAsString(String s)	Deprecated.
void	setWidget(Rectangle rect, PdfName highlight)	Deprecated.
static PdfAnnotation	shallowDuplicate(PdfAnnotation annot)	Deprecated.

Methods inherited from class com.lowagie.text.pdf.PdfAnnotation

addFlags, createFileAttachment, createFileAttachment, createFreeText, createInk, createLine, createLink, createLink, createLink, createLink, createMarkup, createPopup, createScreen, createSquareCircle, createStamp, createText, getIndirectReference, getMKColor, getPlaceInPage, getTemplates, isAnnotation, isForm, isUsed, setAction, setAdditionalActions, setAppearance, setAppearance, setAppearanceState, setBorder, setBorderStyle, setColor, setDefaultAppearanceString, setFlags, setHighlighting, setLayer, setMKAlternateCaption, setMKAlternateIcon, setMKBackgroundColor, setMKBorderColor, setMKIconFit, setMKNormalCaption, setMKNormalIcon, setMKRolloverCaption, setMKRolloverIcon, setMKRotation, setMKTextPosition, setName, setPage, setPage, setPlaceInPage, setPopup, setRotate, setTitle

Methods inherited from class com.lowagie.text.pdf.PdfDictionary

clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, getKeysAndValues, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class com.lowagie.text.pdf.PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class java.lang.Object

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

Field Details

FF_READ_ONLY

public static final int FF_READ_ONLY

Deprecated.

See Also:

• Constant Field Values

FF_REQUIRED

public static final int FF_REQUIRED

Deprecated.

See Also:

• Constant Field Values

FF_NO_EXPORT

public static final int FF_NO_EXPORT

Deprecated.

See Also:

• Constant Field Values

FF_NO_TOGGLE_TO_OFF

public static final int FF_NO_TOGGLE_TO_OFF

Deprecated.

See Also:

• Constant Field Values

FF_RADIO

public static final int FF_RADIO

Deprecated.

See Also:

• Constant Field Values

FF_PUSHBUTTON

public static final int FF_PUSHBUTTON

Deprecated.

See Also:

• Constant Field Values

FF_MULTILINE

public static final int FF_MULTILINE

Deprecated.

See Also:

• Constant Field Values

FF_PASSWORD

public static final int FF_PASSWORD

Deprecated.

See Also:

• Constant Field Values

FF_COMBO

public static final int FF_COMBO

Deprecated.

See Also:

• Constant Field Values

FF_EDIT

public static final int FF_EDIT

Deprecated.

See Also:

• Constant Field Values

FF_FILESELECT

public static final int FF_FILESELECT

Deprecated.

See Also:

• Constant Field Values

FF_MULTISELECT

public static final int FF_MULTISELECT

Deprecated.

See Also:

• Constant Field Values

FF_DONOTSPELLCHECK

public static final int FF_DONOTSPELLCHECK

Deprecated.

See Also:

• Constant Field Values

FF_DONOTSCROLL

public static final int FF_DONOTSCROLL

Deprecated.

See Also:

• Constant Field Values

FF_COMB

public static final int FF_COMB

Deprecated.

See Also:

• Constant Field Values

FF_RADIOSINUNISON

public static final int FF_RADIOSINUNISON

Deprecated.

See Also:

• Constant Field Values

Q_LEFT

public static final int Q_LEFT

Deprecated.

See Also:

• Constant Field Values

Q_CENTER

public static final int Q_CENTER

Deprecated.

See Also:

• Constant Field Values

Q_RIGHT

public static final int Q_RIGHT

Deprecated.

See Also:

• Constant Field Values

MK_NO_ICON

public static final int MK_NO_ICON

Deprecated.

See Also:

• Constant Field Values

MK_NO_CAPTION

public static final int MK_NO_CAPTION

Deprecated.

See Also:

• Constant Field Values

MK_CAPTION_BELOW

public static final int MK_CAPTION_BELOW

Deprecated.

See Also:

• Constant Field Values

MK_CAPTION_ABOVE

public static final int MK_CAPTION_ABOVE

Deprecated.

See Also:

• Constant Field Values

MK_CAPTION_RIGHT

public static final int MK_CAPTION_RIGHT

Deprecated.

See Also:

• Constant Field Values

MK_CAPTION_LEFT

public static final int MK_CAPTION_LEFT

Deprecated.

See Also:

• Constant Field Values

MK_CAPTION_OVERLAID

public static final int MK_CAPTION_OVERLAID

Deprecated.

See Also:

• Constant Field Values

IF_SCALE_ALWAYS

public static final PdfName IF_SCALE_ALWAYS

Deprecated.

IF_SCALE_BIGGER

public static final PdfName IF_SCALE_BIGGER

Deprecated.

IF_SCALE_SMALLER

public static final PdfName IF_SCALE_SMALLER

Deprecated.

IF_SCALE_NEVER

public static final PdfName IF_SCALE_NEVER

Deprecated.

IF_SCALE_ANAMORPHIC

public static final PdfName IF_SCALE_ANAMORPHIC

Deprecated.

IF_SCALE_PROPORTIONAL

public static final PdfName IF_SCALE_PROPORTIONAL

Deprecated.

MULTILINE

public static final boolean MULTILINE

Deprecated.

See Also:

• Constant Field Values

SINGLELINE

public static final boolean SINGLELINE

Deprecated.

See Also:

• Constant Field Values

PLAINTEXT

public static final boolean PLAINTEXT

Deprecated.

See Also:

• Constant Field Values

PASSWORD

public static final boolean PASSWORD

Deprecated.

See Also:

• Constant Field Values

parent

protected PdfFormField parent

Deprecated.

Holds value of property parent.

kids

protected List<PdfFormField> kids

Deprecated.

Constructor Details

PdfFormField

public PdfFormField(PdfWriter writer,
 float llx,
 float lly,
 float urx,
 float ury,
 PdfAction action)

Deprecated.

Constructs a new PdfAnnotation of subtype link (Action).

Parameters:

writer - the PdfWriter

llx - lower-left x-coordinated

lly - lower-left y-coordinate

urx - upper-right x-coordinate

ury - upper-right y-coordinate

action - the PdfAction

PdfFormField

protected PdfFormField(PdfWriter writer)

Deprecated.

Creates new PdfFormField

Parameters:

writer - the PdfWriter to associated to the PdfFormField

Method Details

createEmpty

public static PdfFormField createEmpty(PdfWriter writer)

Deprecated.

createButton

protected static PdfFormField createButton(PdfWriter writer,
 int flags)

Deprecated.

createPushButton

public static PdfFormField createPushButton(PdfWriter writer)

Deprecated.

createCheckBox

public static PdfFormField createCheckBox(PdfWriter writer)

Deprecated.

createRadioButton

public static PdfFormField createRadioButton(PdfWriter writer,
 boolean noToggleToOff)

Deprecated.

createTextField

public static PdfFormField createTextField(PdfWriter writer,
 boolean multiline,
 boolean password,
 int maxLen)

Deprecated.

createTextField

public static PdfFormField createTextField(PdfWriter writer)

Deprecated.

Allows creation of a simple textfield.

Parameters:

writer - pdf writer object

Returns:

PdfFormField the created textfield

createChoice

protected static PdfFormField createChoice(PdfWriter writer,
 int flags,
 PdfArray options,
 int topIndex)

Deprecated.

createList

public static PdfFormField createList(PdfWriter writer,
 String[] options,
 int topIndex)

Deprecated.

createList

public static PdfFormField createList(PdfWriter writer,
 String[][] options,
 int topIndex)

Deprecated.

createCombo

public static PdfFormField createCombo(PdfWriter writer,
 boolean edit,
 String[] options,
 int topIndex)

Deprecated.

createCombo

public static PdfFormField createCombo(PdfWriter writer,
 boolean edit,
 String[][] options,
 int topIndex)

Deprecated.

processOptions

protected static PdfArray processOptions(String[] options)

Deprecated.

processOptions

protected static PdfArray processOptions(String[][] options)

Deprecated.

createSignature

public static PdfFormField createSignature(PdfWriter writer)

Deprecated.

shallowDuplicate

public static PdfAnnotation shallowDuplicate(PdfAnnotation annot)

Deprecated.

setWidget

public void setWidget(Rectangle rect,
 PdfName highlight)

Deprecated.

setButton

public void setButton(int flags)

Deprecated.

getParent

public PdfFormField getParent()

Deprecated.

Getter for property parent.

Returns:

Value of property parent.

addKid

public void addKid(PdfFormField field)

Deprecated.

getKidFields

public List<PdfFormField> getKidFields()

Deprecated.

setFieldFlags

public int setFieldFlags(int flags)

Deprecated.

setValueAsString

public void setValueAsString(String s)

Deprecated.

setValueAsName

public void setValueAsName(String s)

Deprecated.

setValue

public void setValue(PdfSignature sig)

Deprecated.

setDefaultValueAsString

public void setDefaultValueAsString(String s)

Deprecated.

setDefaultValueAsName

public void setDefaultValueAsName(String s)

Deprecated.

setFieldName

public void setFieldName(String s)

Deprecated.

setUserName

public void setUserName(String s)

Deprecated.

setMappingName

public void setMappingName(String s)

Deprecated.

setQuadding

public void setQuadding(int v)

Deprecated.

setUsed

public void setUsed()

Deprecated.

Description copied from class: PdfAnnotation

Setter for property used.

Overrides:

setUsed in class PdfAnnotation