iText7 8.0.0  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

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 PdfButtonFormField, PdfName getFormType()

Returns Btn, the form type for choice form fields. @return the form type, as a PdfName
Class PdfButtonFormField, boolean isPushButton()

If true, the field is a pushbutton that does not retain a permanent value. @return whether or not the field is currently a pushbutton
Class PdfButtonFormField, boolean isRadio()

If true, the field is a set of radio buttons; if false, the field is a check box. This flag only works if the Pushbutton flag is set to false. @return whether the field is currently radio buttons or a checkbox
Class PdfButtonFormField, boolean isRadiosInUnison()

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If false, the buttons are mutually exclusive exclusive @return whether or not buttons are turned off in unison
Class PdfButtonFormField, boolean isToggleOff()

If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times. Only valid for radio buttons. @return whether a radio button currently allows to choose no options
Class PdfButtonFormField, PdfButtonFormField setPushButton(boolean)

If true, the field is a pushbutton that does not retain a permanent value. @param pushButton whether or not to set the field to a pushbutton pushbutton @return current PdfButtonFormField
Class PdfButtonFormField, PdfButtonFormField setRadio(boolean)

If true, the field is a set of radio buttons; if false, the field is a check box. This flag should be set only if the Pushbutton flag is set to false. @param radio whether the field should be radio buttons or a checkbox checkbox @return current PdfButtonFormField
Class PdfButtonFormField, PdfButtonFormField setRadiosInUnison(boolean)

If true, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If false, the buttons are mutually exclusive exclusive @param radiosInUnison whether or not buttons should turn off in unison unison @return current PdfButtonFormField
Class PdfButtonFormField, PdfButtonFormField setToggleOff(boolean)

If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times. @param toggleOff whether a radio button may allow to choose no options options @return current PdfButtonFormField
Class PdfButtonFormField, int FF_NO_TOGGLE_TO_OFF

Button If field true, flags clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times.
Class PdfChoiceFormField, PdfNumber getTopIndex()

Gets the current index of the first option in a scrollable list. @return the index of the first option, as a PdfNumber
Class PdfChoiceFormField, boolean isCommitOnSelChange()

If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device). @return whether or not to save changes immediately
Class PdfChoiceFormField, boolean isEdit()

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. This flag shall be used only if the Combo flag is true. @return whether or not there is currently an editable text box
Class PdfChoiceFormField, boolean isMultiSelect()

If true, more than one of the field's option items may be selected simultaneously; if false, at most one item item shall be selected. @return whether or not multiple selection is currently allowed
Class PdfChoiceFormField, boolean isSort()

If true, the field's option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers. @return whether or not the items are currently sorted
Class PdfChoiceFormField, boolean isSpellCheck()

If true, text entered in the field shall be spell-checked.. @return whether or not PDF viewer must perform a spell check
Class PdfChoiceFormField, PdfChoiceFormField setCombo(boolean)

If true, the field is a combo box; if false, the field is a list box. @param combo whether or not the field should be a combo box box @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setCommitOnSelChange(boolean)

If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device). @param commitOnSelChange whether or not to save changes immediately immediately @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setEdit(boolean)

If true, the combo box shall include an editable text box as well as a drop-down list; if false, it shall include only a drop-down list. This flag shall be used only if the Combo flag is true. @param edit whether or not to add an editable text box box @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setIndices(PdfArray)

Sets the selected items in the field. @param indices a sorted array of indices representing selected items in the field field @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setListSelected(String[])

Highlights the options. If this method is used for Combo box, the first value in input array will be the field value value @param optionValues Array of options to be highlighted highlighted @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setListSelected(String[], boolean)

Highlights the options and generates field appearance if needed. . If this method is used for Combo box, the first value in input array array will be the field value value @param optionValues Array of options to be highlighted @param generateAppearance if false, appearance won't be regenerated regenerated @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setListSelected(int[])

Highlights the options. If this method is used for Combo box, the first value in input array will be the field value value @param optionNumbers The option numbers numbers @return The edited PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setMultiSelect(boolean)

If true, more than one of the field's option items may be selected simultaneously; if false, at most one item shall be selected. @param multiSelect whether or not to allow multiple selection selection @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setSort(boolean)

If true, the field's option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers. @param sort whether or not to sort the items items @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setSpellCheck(boolean)

If true, text entered in the field shall be spell-checked. . @param spellCheck whether or not to require the PDF viewer to perform a spell check check @return current PdfChoiceFormField
Class PdfChoiceFormField, PdfChoiceFormField setTopIndex(int)

Sets the index of the first visible option in a scrollable list. @param index the index of the first option option @return current PdfChoiceFormField
Class PdfChoiceFormField, int FF_COMBO

Choice If true, the field is a combo box. If false, the field flags is a list box.
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, constructor PdfFormField(PdfDocument)

Creates a minimal PdfFormField. @param pdfDocument The document PdfDocument instance.
Class PdfFormField, constructor PdfFormField(PdfWidgetAnnotation, PdfDocument)

Creates a form field as a parent of a PdfWidgetAnnotation. @param widget The widget which will be a kid of the PdfFormField. @param pdfDocument The document PdfDocument instance.
Class PdfFormField, PdfDictionary getAdditionalAction()

Gets the currently additional action dictionary for the form field. @return the additional action dictionary.
Class PdfFormField, PdfString getAlternativeName()

Gets the current alternate name. The alternate is a descriptive name to be used by status messages etc. @return the current alternate name, as a PdfString.
Class PdfFormField, String[] getAppearanceStates()

Gets the appearance state names. {@inheritDoc} @return an array of Strings containing the names of the appearance states {@inheritDoc}
Class PdfFormField, PdfString getDefaultAppearance()

Gets default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and color. {@inheritDoc} @return the default appearance graphics, as a PdfString {@inheritDoc}
Class PdfFormField, PdfString getDefaultStyle()

Gets a default style string, as described in "Rich Text Strings" section of Pdf spec. @return the default style, as a PdfString.
Class PdfFormField, PdfObject getDefaultValue()

Gets the default fallback value for the form field. @return the default value.
Class PdfFormField, boolean getFieldFlag(int)

Checks whether a certain flag, or any of a combination of flags, is set for this form field. @param flag an int interpreted as a series of a binary flags flags. @return true if any of the flags specified in the parameter is also set in the form field.
Class PdfFormField, int getFieldFlags()

Gets the current list of PDF form field flags. @return the current list of flags, encoded as an int.
Class PdfFormField, PdfString getFieldName()

Gets the current field name. @return the current field name, as a PdfString.
Class PdfFormField, float getFontSize()

Gets the current fontSize of the form field. @return the current fontSize.
Class PdfFormField, TextAlignment getJustification()

Gets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified @return the current justification attribute.
Class PdfFormField, PdfArray getKids()

Gets the kids of this object. @return contents of the dictionary's Kids property, as a PdfArray.
Class PdfFormField, PdfString getMappingName()

Gets the current mapping name. The mapping name can be used when exporting the form data in the document. @return the current mapping name, as a PdfString.
Class PdfFormField, PdfArray getOptions()

Gets options for the form field. Should only return usable values for checkboxes and radio buttons. @return the options, as an PdfArray of PdfString objects.
Class PdfFormField, PdfDictionary getParent()

Gets the parent dictionary. @return another form field that this field belongs to , usually a group field .
Class PdfFormField, PdfObject getRichText()

Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec. May be either PdfStream or PdfString. @return the current rich text value.
Class PdfFormField, PdfObject getValue()

Gets the current value contained in the form field. @return the current value, as a PdfObject.
Class PdfFormField, String getValueAsString()

Gets the current value contained in the form field. @return the current value, as a String.
Class PdfFormField, List getWidgets()

Gets all PdfWidgetAnnotation that this form its children field and its kids refer to. @return a list of PdfWidgetAnnotation.
Class PdfFormField, boolean isPassword()

If true, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks asterisks or bullet characters. @return whether or not the contents of the field must be obfuscated.
Class PdfFormField, PdfFormField makeFormField(PdfObject, PdfDocument)

Creates a (subtype of) PdfFormField object. The type of the object depends on the FT entry in the pdfObject parameter. @param pdfObject assumed to be either a PdfDictionary, or a PdfIndirectReference to a PdfDictionary. @param document the PdfDocument to create the field in in. @return a new PdfFormField, or null if pdfObject does is not contain a FT form entry field.
Class PdfFormField, AbstractPdfFormField put(PdfName, PdfObject)

Inserts the value into the PdfDictionary of this field and associates it with the specified key. If the key is already present in this field dictionary, this method will override the old value with the specified one. @param key key to insert or to override override. @param value the value to associate with the specified key key. @return this the PdfFormField edited instance field.
Class PdfFormField, boolean regenerateField()

This method regenerates appearance stream of the field. Use it if you changed any field parameters and didn't use setValue method which generates appearance by itself. {@inheritDoc} @return whether or not the regeneration was successful. {@inheritDoc}
Class PdfFormField, void release()

Releases underlying pdf object and other pdf entities used by wrapper. This method should be called instead of direct call to PdfObject.release() if the wrapper is used. {@inheritDoc}
Class PdfFormField, AbstractPdfFormField remove(PdfName)

Removes the specified key from the PdfDictionary of this field. @param key key to be removed removed. @return this the PdfFormField edited instance field.
Class PdfFormField, PdfFormField setAdditionalAction(PdfName, PdfAction)

Sets an additional action for the form field. @param key the dictionary key to use for storing the action action. @param action the action action. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setAlternativeName(String)

Changes the alternate name of the field to the specified value. The alternate is a descriptive name to be used by status messages etc. @param name the new alternate name, as a String String. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setCheckType(CheckBoxType)

Changes the type of graphical marker used to mark a checkbox as 'on'. Notice that in order to complete the change one should call regenerateField method method. @param checkType the new checkbox marker marker. @return The the edited field PdfFormField.
Class PdfFormField, AbstractPdfFormField setColor(Color)

Sets the text color. {@inheritDoc} @param color the new value for the Color {@inheritDoc} @return the edited field {@inheritDoc}
Class PdfFormField, PdfFormField setDefaultStyle(PdfString)

Sets a default style string, as described in "Rich Text Strings" section of Pdf spec. @param defaultStyleString a new default style for the form field field. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setDefaultValue(PdfObject)

Sets the default fallback value for the form field. @param value the default value value. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setFieldFlag(int)

Adds a flag, or combination of flags, for the form field. This method is intended to be used one flag at a time, but this is not technically enforced. To replace the current value, use .setFieldFlags(int). @param flag an int interpreted as a series of a binary flags flags. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setFieldFlag(int, boolean)

Adds or removes a flag, or combination of flags, for the form field. This method is intended to be used one flag at a time, but this is not technically enforced. To replace the current value, use .setFieldFlags(int). @param flag an int interpreted as a series of a binary flags flags. @param value if true, adds the flag(s). if false, removes the flag(s). @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setFieldFlags(int)

Sets a flag, or combination of flags, for the form field. This method replaces the previous value. Compare with .setFieldFlag(int) which adds a flag to the existing flags. @param flags an int interpreted as a series of a binary flags flags. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setFieldName(String)

Changes the name of the field to the specified value. @param name the new field name, as a String String. @return the edited field PdfFormField.
Class PdfFormField, AbstractPdfFormField setFont(PdfFont)

Basic setter for the font property. Regenerates the field appearance after setting the new value. Note that the font will be added to the document so ensure that the font is embedded if it's a pdf/a document. @param font The new font to be set set. @return The edited PdfFormField AbstractPdfFormField.
Class PdfFormField, AbstractPdfFormField setFontAndSize(PdfFont, float)

Combined setter for the font and fontSize properties. Regenerates the field appearance after setting the new value. @param font The new font to be set set. @param fontSize The new font size to be set set. @return The edited PdfFormField AbstractPdfFormField.
Class PdfFormField, AbstractPdfFormField setFontSizeAutoScale()

Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3. @return the edited field AbstractPdfFormField.
Class PdfFormField, PdfFormField setJustification(TextAlignment)

Sets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified @param justification the value to set the justification attribute to to. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setMappingName(String)

Changes the mapping name of the field to the specified value. The mapping name can be used when exporting the form data in the document. @param name the new alternate name, as a String String. @return the edited field.
Class PdfFormField, PdfFormField setNoExport(boolean)

Sets the NoExport flag, specifying whether or not exporting is forbidden. @param noExport if true, then exporting is forbidden @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setOptions(PdfArray)

Sets options for the form field. Only to be used for checkboxes and radio buttons. @param options an array of PdfString objects that each represent the 'on' state of one of the choices. @return the edited field PdfFormField.
Class PdfFormField, void setParent(PdfFormField)

Sets a parent PdfFormField for the current object. @param parent another form field that this field belongs to, usually a group field @return the edited field.
Class PdfFormField, PdfFormField setReadOnly(boolean)

Sets the ReadOnly flag, specifying whether or not the field can be changed. @param readOnly if true, then the field cannot be changed. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setRequired(boolean)

Sets the Required flag, specifying whether or not the field must be filled in. @param required if true, then the field must be filled in. @return the edited field PdfFormField.
Class PdfFormField, PdfFormField setRichText(PdfObject)

Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec. May be either PdfStream or PdfString. @param richText a new rich text value value. @return The the edited PdfFormField.
Class PdfFormField, PdfFormField setValue(String)

Sets a value to the field and generating field appearance if needed. @param value of the field field. @return the field.
Class PdfFormField, PdfFormField setValue(String, PdfFont, float)

Set text field value with given font and size size. @param value text value value. @param font a PdfFont. @param fontSize the size of the font font. @return the edited field.
Class PdfFormField, PdfFormField setValue(String, String)

Sets the field value and the display string. The display string is used to build the appearance. @param value the field value value. @param display displayValue the string that is used for the appearance. If null the value parameter will be used used. @return the edited field.
Class PdfFormField, PdfFormField setValue(String, boolean)

Sets a value to the field (and fields with the same names) and generates field appearance if needed. @param value of the field field. @param generateAppearance if false, appearance won't be regenerated regenerated. @return the field.