Package com.pdftools.toolbox.pdf.forms

Class RadioButtonGroup

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.forms.FieldNode

com.pdftools.toolbox.pdf.forms.Field

com.pdftools.toolbox.pdf.forms.RadioButtonGroup

public class RadioButtonGroup
extends Field

A radio button field

Method Summary

Modifier and Type	Method	Description
RadioButton	addNewButton(java.lang.String exportName)	Create a radio button
static RadioButtonGroup	create(Document targetDocument)	Create a radio button form field
RadioButtonList	getButtons()	This field's buttons (Getter)
RadioButton	getChosenButton()	This field's selected button (Getter)
void	setChosenButton(RadioButton value)	This field's selected button (Setter)

Methods inherited from class com.pdftools.toolbox.pdf.forms.Field

addNewWidget, getDoNotExport, getReadOnly, getRequired, getWidgets, setDoNotExport, setReadOnly, setRequired

Methods inherited from class com.pdftools.toolbox.pdf.forms.FieldNode

copy, getDisplayName, getExportName, setDisplayName, setExportName

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static RadioButtonGroup create(Document targetDocument)

Create a radio button form field

The returned form field object is not yet used, but it is associated with the given target document.

Parameters:

targetDocument - the output document with which the returned object is associated

Returns:

the newly created radio button field

Throws:

java.lang.IllegalArgumentException - if the targetDocument argument has already been closed

java.lang.IllegalArgumentException - if the targetDocument argument is read-only

java.lang.IllegalArgumentException - the target document contains form fields that have been implicitly copied by a call to toolbox.pdf.Page.copy with an argument options in which toolbox.pdf.PageCopyOptions.setFormFields was set to FormFieldCopyStrategy.COPY

java.lang.IllegalArgumentException - the target document contains unsigned signatures that have been implicitly copied by a call to toolbox.pdf.Page.copy with an argument options in which toolbox.pdf.PageCopyOptions.setUnsignedSignatures was set to toolbox.pdf.CopyStrategy.COPY.

java.lang.IllegalArgumentException - if targetDocument is null

addNewButton

public RadioButton addNewButton(java.lang.String exportName)

Create a radio button

The created radio button is automatically added to this radio button field's getButtons().

Parameters:

exportName - the radio button's export name

Returns:

the newly created radio button

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getButtons

public RadioButtonList getButtons()

This field's buttons (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getChosenButton

public RadioButton getChosenButton()

This field's selected button (Getter)

if null is set, then no button is chosen.

Throws:

java.lang.IllegalStateException - if the object has already been closed

setChosenButton

public void setChosenButton(RadioButton value)

This field's selected button (Setter)

if null is set, then no button is chosen.

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalArgumentException - if the provided radio button object does not belong to the radio button field

java.lang.IllegalStateException - if the given RadioButton object is null and the radio button group does not support toggling to off

java.lang.IllegalStateException - if the form field is marked as read-only