Package com.itextpdf.forms.fields

Class PdfButtonFormField

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

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 final int	FF_NO_TOGGLE_TO_OFF	Button field flags
static final int	FF_PUSH_BUTTON
static final int	FF_RADIO
static final int	FF_RADIOS_IN_UNISON

Fields inherited from class com.itextpdf.forms.fields.PdfFormField

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, backgroundColor, borderColor, borderWidth, checkType, color, FF_MULTILINE, FF_NO_EXPORT, FF_PASSWORD, FF_READ_ONLY, FF_REQUIRED, font, fontSize, form, HIDDEN, HIDDEN_BUT_PRINTABLE, img, pdfAConformanceLevel, rotation, text, TYPE_CHECK, TYPE_CIRCLE, TYPE_CROSS, TYPE_DIAMOND, TYPE_SQUARE, TYPE_STAR, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfButtonFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)
protected	PdfButtonFormField(PdfDictionary pdfObject)
protected	PdfButtonFormField(PdfDocument pdfDocument)

Method Summary

Modifier and Type	Method	Description
PdfName	getFormType()	Returns Btn, 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(String image)
PdfButtonFormField	setImageAsForm(PdfFormXObject form)
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, createButton, createButton, createButton, createButton, createCheckBox, createCheckBox, createCheckBox, createChoice, createChoice, createChoice, createChoice, createChoice, createChoice, createChoice, createComboBox, createComboBox, createComboBox, createComboBox, createEmptyField, createEmptyField, createList, createList, createList, createList, createMultilineText, createMultilineText, createPushButton, createPushButton, createPushButton, createRadioButton, createRadioButton, createRadioGroup, createRadioGroup, createSignature, createSignature, createSignature, createSignature, createText, createText, createText, createText, createText, createText, createText, createText, drawBorder, drawButton, drawCheckAppearance, drawCheckBox, drawMultiLineTextAppearance, drawPdfA2CheckAppearance, drawPdfACheckBox, drawPushButtonAppearance, drawRadioAppearance, drawRadioBorder, drawRadioField, drawTextAppearance, getAdditionalAction, getAlternativeName, getAppearanceStates, getBorderWidth, getColor, getDefaultAppearance, getDefaultStyle, getDefaultValue, getDocument, getFieldFlag, getFieldFlags, getFieldName, getFont, getFontSize, getJustification, getKids, getMappingName, getOptions, getParent, getRect, getRichText, getValue, getValueAsString, getWidgets, isMultiline, isNoExport, isPassword, isReadOnly, isRequired, isWrappedObjectMustBeIndirect, makeFieldFlag, makeFormField, processOptions, processOptions, put, regenerateField, release, remove, setAction, setAdditionalAction, setAlternativeName, setAppearance, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setCheckType, setColor, setDefaultStyle, setDefaultValue, setFieldFlag, setFieldFlag, setFieldFlags, setFieldName, setFont, setFontAndSize, setFontSize, setFontSize, setFontSizeAutoScale, setJustification, setMappingName, setNoExport, setOptions, setPage, setParent, setReadOnly, setRequired, setRichText, setRotation, setValue, setValue, setValue, setValue, setVisibility, splitDAelements, updateDefaultAppearance

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Field Details

FF_NO_TOGGLE_TO_OFF

 public static final int FF_NO_TOGGLE_TO_OFF 
            

Button field flags

FF_RADIO

 public static final int FF_RADIO 
            

FF_PUSH_BUTTON

 public static final int FF_PUSH_BUTTON 
            

FF_RADIOS_IN_UNISON

 public static final int FF_RADIOS_IN_UNISON 
            

Constructor Details

PdfButtonFormField

 protected PdfButtonFormField 
             (PdfDocument pdfDocument) 
            

PdfButtonFormField

 protected PdfButtonFormField 
             (PdfWidgetAnnotation widget, PdfDocument pdfDocument) 
            

PdfButtonFormField

 protected PdfButtonFormField 
             (PdfDictionary pdfObject) 
            

Method Details

getFormType

 public PdfName getFormType() 
            

Returns Btn, the form type for choice form fields.

Overrides:

getFormType in class PdfFormField

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 
             (String image) throws IOException 
            

Throws:

IOException

setImageAsForm

 public PdfButtonFormField setImageAsForm 
             (PdfFormXObject form)