Package com.itextpdf.forms.fields
Class PdfButtonFormField
- java.lang.Object
-
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
-
- com.itextpdf.forms.fields.AbstractPdfFormField
-
- com.itextpdf.forms.fields.PdfFormField
-
- com.itextpdf.forms.fields.PdfButtonFormField
-
public class PdfButtonFormField extends PdfFormField
An interactive control on the screen that raises events and/or can retain data.
-
-
Field Summary
Fields Modifier and Type Field Description static int
FF_NO_TOGGLE_TO_OFF
If true, clicking the selected button deselects it, leaving no button selected.static int
FF_PUSH_BUTTON
If true, the field is a push button that does not retain a permanent value.static int
FF_RADIO
If true, the field is a set of radio buttons.static int
FF_RADIOS_IN_UNISON
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.private static org.slf4j.Logger
LOGGER
-
Fields inherited from class com.itextpdf.forms.fields.PdfFormField
checkType, FF_MULTILINE, FF_NO_EXPORT, FF_PASSWORD, FF_READ_ONLY, FF_REQUIRED, form, img, text
-
Fields inherited from class com.itextpdf.forms.fields.AbstractPdfFormField
color, DEFAULT_FONT_SIZE, font, fontSize, MIN_FONT_SIZE, parent, pdfConformance
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PdfButtonFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)
Creates a button form field as a parent of aPdfWidgetAnnotation
.protected
PdfButtonFormField(PdfDictionary pdfObject)
Creates a button form field as a wrapper object around aPdfDictionary
.protected
PdfButtonFormField(PdfDocument pdfDocument)
Creates a minimalPdfButtonFormField
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfFormField
addKid(AbstractPdfFormField kid)
Adds a new kid to theKids
array property from aAbstractPdfFormField
.PdfName
getFormType()
ReturnsBtn
, the form type for choice form fields.boolean
isPushButton()
If true, the field is a pushbutton that does not retain a permanent value.boolean
isRadio()
If true, the field is a set of radio buttons; if false, the field is a check box.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.boolean
isToggleOff()
If true, clicking the selected button deselects it, leaving no button selected.PdfButtonFormField
setImage(java.lang.String image)
Set image to be used as a background content in a push button.PdfButtonFormField
setImageAsForm(PdfFormXObject form)
Set image to be used as a background content in a push button asPdfFormXObject
.PdfButtonFormField
setPushButton(boolean pushButton)
If true, the field is a pushbutton that does not retain a permanent value.PdfButtonFormField
setRadio(boolean radio)
If true, the field is a set of radio buttons; if false, the field is a check box.PdfButtonFormField
setRadiosInUnison(boolean radiosInUnison)
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.PdfButtonFormField
setToggleOff(boolean toggleOff)
If true, clicking the selected button deselects it, leaving no button selected.-
Methods inherited from class com.itextpdf.forms.fields.PdfFormField
addKid, addKid, getAdditionalAction, getAllChildFields, getAllChildFormFields, getAlternativeName, getAppearanceStates, getChildField, getChildFields, getChildFormAnnotations, getChildFormFields, getDefaultAppearance, getDefaultStyle, getDefaultValue, getDisplayValue, getFieldFlag, getFieldFlags, getFirstFormAnnotation, getFormFieldKeys, getFormType, getJustification, getKids, getMappingName, getOptions, getPartialFieldName, getRichText, getValue, getValueAsString, getWidgets, isFormField, isInReadingMode, isMultiline, isNoExport, isPassword, isReadOnly, isRequired, makeFieldFlag, makeFormField, makeFormFieldOrAnnotation, optionsArrayToString, regenerateField, release, removeChild, removeChildren, replaceKids, setAdditionalAction, setAlternativeName, setCheckType, setChildField, setColor, setDefaultStyle, setDefaultValue, setFieldFlag, setFieldFlag, setFieldFlags, setFieldName, setJustification, setMappingName, setNoExport, setOptions, setReadOnly, setRequired, setRichText, setValue, setValue, setValue, setValue, updateDefaultAppearance, updateFontAndFontSize
-
Methods inherited from class com.itextpdf.forms.fields.AbstractPdfFormField
disableCurrentFieldRegeneration, disableFieldRegeneration, enableCurrentFieldRegeneration, enableFieldRegeneration, equals, getAcroFormObject, getColor, getDocument, getFieldName, getFont, getFontSize, getParent, getParentField, getPdfConformance, getPdfObject, hashCode, isFieldRegenerationEnabled, isTerminalFormField, isWrappedObjectMustBeIndirect, put, remove, retrieveStyles, setColorNoRegenerate, setFont, setFontAndSize, setFontSize, setFontSize, setFontSizeAutoScale, setParent
-
Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
-
-
-
-
Field Detail
-
LOGGER
private static final org.slf4j.Logger LOGGER
-
FF_NO_TOGGLE_TO_OFF
public static final int FF_NO_TOGGLE_TO_OFF
If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times.
-
FF_RADIO
public static final int FF_RADIO
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 theFF_PUSH_BUTTON
flag is set to false.
-
FF_PUSH_BUTTON
public static final int FF_PUSH_BUTTON
If true, the field is a push button that does not retain a permanent value.
-
FF_RADIOS_IN_UNISON
public static final int FF_RADIOS_IN_UNISON
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.
-
-
Constructor Detail
-
PdfButtonFormField
protected PdfButtonFormField(PdfDocument pdfDocument)
Creates a minimalPdfButtonFormField
.- Parameters:
pdfDocument
- ThePdfDocument
instance.
-
PdfButtonFormField
protected PdfButtonFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)
Creates a button form field as a parent of aPdfWidgetAnnotation
.- Parameters:
widget
- The widget which will be a kid of thePdfButtonFormField
.pdfDocument
- ThePdfDocument
instance.
-
PdfButtonFormField
protected PdfButtonFormField(PdfDictionary pdfObject)
Creates a button form field as a wrapper object around aPdfDictionary
. ThisPdfDictionary
must be an indirect object.- Parameters:
pdfObject
- the dictionary to be wrapped, must have an indirect reference.
-
-
Method Detail
-
getFormType
public PdfName getFormType()
ReturnsBtn
, the form type for choice form fields.- Overrides:
getFormType
in classPdfFormField
- Returns:
- the form type, as a
PdfName
-
isRadio
public 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.- Returns:
- whether the field is currently radio buttons or a checkbox
-
setRadio
public PdfButtonFormField setRadio(boolean radio)
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.- Parameters:
radio
- whether the field should be radio buttons or a checkbox- Returns:
- current
PdfButtonFormField
-
isToggleOff
public 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.- Returns:
- whether a radio button currently allows to choose no options
-
setToggleOff
public PdfButtonFormField setToggleOff(boolean toggleOff)
If true, clicking the selected button deselects it, leaving no button selected. If false, exactly one radio button shall be selected at all times.- Parameters:
toggleOff
- whether a radio button may allow to choose no options- Returns:
- current
PdfButtonFormField
-
isPushButton
public boolean isPushButton()
If true, the field is a pushbutton that does not retain a permanent value.- Returns:
- whether or not the field is currently a pushbutton
-
setPushButton
public PdfButtonFormField setPushButton(boolean pushButton)
If true, the field is a pushbutton that does not retain a permanent value.- Parameters:
pushButton
- whether or not to set the field to a pushbutton- Returns:
- current
PdfButtonFormField
-
isRadiosInUnison
public 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- Returns:
- whether or not buttons are turned off in unison
-
setRadiosInUnison
public PdfButtonFormField setRadiosInUnison(boolean radiosInUnison)
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- Parameters:
radiosInUnison
- whether or not buttons should turn off in unison- Returns:
- current
PdfButtonFormField
-
setImage
public PdfButtonFormField setImage(java.lang.String image) throws java.io.IOException
Set image to be used as a background content in a push button.- Parameters:
image
- path to the image to be used.- Returns:
- this
PdfButtonFormField
- Throws:
java.io.IOException
- if provided path to the image is not correct
-
setImageAsForm
public PdfButtonFormField setImageAsForm(PdfFormXObject form)
Set image to be used as a background content in a push button asPdfFormXObject
.- Parameters:
form
-PdfFormXObject
to be used as an image- Returns:
- this
PdfButtonFormField
-
addKid
public PdfFormField addKid(AbstractPdfFormField kid)
Adds a new kid to theKids
array property from aAbstractPdfFormField
. Also sets the kid'sParent
property to this object.- Overrides:
addKid
in classPdfFormField
- Parameters:
kid
- a newAbstractPdfFormField
entry for the field'sKids
array property.- Returns:
- the edited
PdfFormField
.
-
-