Generated by
JDiff

com.itextpdf.forms.fields Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.forms.fields as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.

Class PdfFormField

This class represents a single field or field group in an AcroForm.

To be able to be wrapped with this PdfObjectWrapper the PdfObject must be indirect.

Class PdfFormField, PdfTextFormField createText(PdfDocument, PdfAConformanceLevel)

Creates an empty text form field. @param doc the PdfDocument to create the text field in @param pdfAConformanceLevel the desired PdfAConformanceLevel of the field. Must match the conformance level of the PdfDocument this field will eventually be added into @return a new PdfTextFormField
Class PdfFormField, void drawPdfA1CheckAppearance(float, float, String, int)

@ deprecated use param width .drawPdfA2CheckAppearance(float, float, String, int) instead. @param width width of the checkbox @param height height of the checkbox @param selectedValue the selected value of the checkbox which determines the appearance of the checkbox @param checkType the type that determines how the checkbox will look like. Allowed values are {@value TYPE_CHECK}, {@value TYPE_CIRCLE}, {@value TYPE_CROSS}, {@value TYPE_DIAMOND}, {@value TYPE_SQUARE}, {@value TYPE_STAR} @deprecated use .drawPdfA2CheckAppearance(float, float, String, int) instead.
Class PdfFormField, void drawPdfA2CheckAppearance(float, float, String, int)

Draws PDF/A-2 compliant check appearance. Actually it's just PdfA check appearance. According to corrigendum there is no difference between them them @param width width of the checkbox @param height height of the checkbox @param onStateName name that corresponds to the "On" state of the checkbox @param checkType the type that determines how the checkbox will look like. Allowed values are {@value TYPE_CHECK}, {@value TYPE_CIRCLE}, {@value TYPE_CROSS}, {@value TYPE_DIAMOND}, {@value TYPE_SQUARE}, {@value TYPE_STAR}
Class PdfFormField, PdfFormXObject drawPushButtonAppearance(float, float, String, PdfFont, PdfName, float)

Draws the appearance for a push button. @param width the width of the pushbutton @param height the width of the pushbutton @param text the text to display on the button @param font a PdfFont @param fontName will be ignored. @param fontSize the size of the font @return a new PdfFormXObject @deprecated use .drawPushButtonAppearance(float, float, String, PdfFont, float) instead. @return a new PdfFormXObject
Class PdfFormField, String generateDefaultAppearanceString(PdfFont, float, Color, PdfResources)

Generate default appearance, /DA key. @param font preferred font. If .getFont() is not null, it will be used instead. @param fontSize preferred font size. If PdfFormField.fontSize is valid, it will be used instead. @param color color for the DA @param res resources @return generated string @deprecated use .updateDefaultAppearance() instead. @return generated string
Class PdfFormField, PdfFormField setAppearance(PdfName, String, PdfStream)

Sets an appearance for (the widgets related to) the form field. @param appearanceType the type of appearance stream to be added @param appearanceState the state of the form field that needs to be true for the appearance to be used. Differentiates between several streams of the same type. @param appearanceStream the appearance instructions, as a PdfStream @return the edited field