Package com.pspdfkit.forms
Class EditableButtonFormField
-
- All Implemented Interfaces:
public abstract class EditableButtonFormField extends ButtonFormField
Represents editable button field in a PDF form - i.e. checkbox or radio button.
-
-
Field Summary
Fields Modifier and Type Field Description public final FormType
type
public final String
name
public final String
mappingName
public final String
alternateFieldName
public List<out FormElement>
formElements
-
Method Summary
Modifier and Type Method Description List<out EditableButtonFormElement>
getSelectedButtons()
Gets a list of form elements that are currently selected. boolean
setSelectedButtons(@NonNull() List<out EditableButtonFormElement> formElements)
Sets a list of form elements that should be selected. List<out EditableButtonFormElement>
getFormElements()
Retrieve list of form elements that represents this field visually. -
Methods inherited from class com.pspdfkit.forms.FormField
equals, getAdditionalAction, getAlternateFieldName, getFormElement, getFormElements, getFullyQualifiedName, getInternal, getMappingName, getName, getType, hashCode, isDirty, isExported, isReadOnly, isRequired, reset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getSelectedButtons
@NonNull() List<out EditableButtonFormElement> getSelectedButtons()
Gets a list of form elements that are currently selected.
- Returns:
List of form elements representing buttons that are currently selected.
-
setSelectedButtons
boolean setSelectedButtons(@NonNull() List<out EditableButtonFormElement> formElements)
Sets a list of form elements that should be selected.
- Returns:
true
if button state was updated.
-
getFormElements
@NonNull() List<out EditableButtonFormElement> getFormElements()
Retrieve list of form elements that represents this field visually. Each FormElement can be part of a single field and each field can contain multiple form elements.
- Returns:
List of child form elements.
-
-
-
-