Top Inners Fields Constructors Methods
com.openhtmltopdf.pdfboxout

public Class PdfBoxForm

extends Object
Class Inheritance
Imports
java.awt.geom.AffineTransform, .Rectangle2D, java.io.ByteArrayOutputStream, .IOException, .OutputStream, java.nio.charset.StandardCharsets, java.util.ArrayList, .HashMap, .LinkedHashMap, .List, .Locale, .Map, java.util.logging.Level, java.util.regex.Pattern, java.util.stream.Collectors, com.openhtmltopdf.util.LogMessageId, .ArrayUtil, .OpenUtil, .XRLog, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, .COSString, org.apache.pdfbox.pdmodel.PDDocument, .PDPage, .PDResources, org.apache.pdfbox.pdmodel.common.COSArrayList, .PDRectangle, org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification, org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm, .PDActionSubmitForm, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget, .PDAppearanceCharacteristicsDictionary, .PDAppearanceDictionary, .PDAppearanceStream, org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, .PDCheckBox, .PDComboBox, .PDField, .PDListBox, .PDNonTerminalField, .PDPushButton, .PDRadioButton, .PDTextField, org.w3c.dom.Element, .NamedNodeMap, .Node, com.openhtmltopdf.css.constants.CSSName, .IdentValue, com.openhtmltopdf.css.parser.FSCMYKColor, .FSColor, .FSRGBColor, com.openhtmltopdf.render.Box, .RenderingContext

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class
private static class
private static class

Field Summary

Modifier and TypeField and Description
private final Map<String, PdfBoxForm.Field>
private final List<PdfBoxForm.ControlFontPair>
private final PdfBoxPerDocumentFormState
private final Element
private final PdfBoxOutputDevice
private final Map<String, List<PdfBoxForm.Control>>
private final List<PdfBoxForm.Control>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public void
public static PDAppearanceStream
createCheckboxAppearance(PdfBoxForm.CheckboxStyle style, PDDocument doc, PDResources resources)

Creates a checkbox appearance stream.

public static PDAppearanceStream
public static PdfBoxForm
private void
createNonTerminalFields(PdfBoxForm.Field f, PDAcroForm form)

This method will create the non terminal fields.

private void
createNonTerminalFields(PDAcroForm form)

Calls createNonTerminalFields on all root non-terminal fields.

private static String
getColorOperator(FSColor color)

Get a PDF graphics operator for a specific color.

private COSString
private String
private String
populateOptions(Element e, List<String> labels, List<String> values, List<Integer> selectedIndices)

public int
process(PDAcroForm acro, int startId, Box root)

private void
private void
processControlNames()

This method will create a tree of names, both non-terminal and terminal.

private void
private void
private void
private void
processSelectControl(PdfBoxForm.ControlFontPair pair, PdfBoxForm.Control ctrl, PDAcroForm acro, int i, Box root)

Processes select controls and the custom openhtmltopdf-combo control.

private void
private void
private void
private static void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allFieldMapback to summary
private final Map<String, PdfBoxForm.Field> allFieldMap
controlsback to summary
private final List<PdfBoxForm.ControlFontPair> controls
docFormsStateContainerback to summary
private final PdfBoxPerDocumentFormState docFormsStateContainer
elementback to summary
private final Element element
odback to summary
private final PdfBoxOutputDevice od
radioGroupsback to summary
private final Map<String, List<PdfBoxForm.Control>> radioGroups
submitsback to summary
private final List<PdfBoxForm.Control> submits

Constructor Detail

PdfBoxFormback to summary
private PdfBoxForm(Element element, PdfBoxPerDocumentFormState forms, PdfBoxOutputDevice od)

Method Detail

addControlback to summary
public void addControl(PdfBoxForm.Control ctrl, String fontName)
createCheckboxAppearanceback to summary
public static PDAppearanceStream createCheckboxAppearance(PdfBoxForm.CheckboxStyle style, PDDocument doc, PDResources resources)

Creates a checkbox appearance stream. Uses an ordinal of the zapf dingbats font for the check mark.

createCheckboxAppearanceback to summary
public static PDAppearanceStream createCheckboxAppearance(String appear, PDDocument doc, PDResources resources)
createFormback to summary
public static PdfBoxForm createForm(Element e, PdfBoxPerDocumentFormState forms, PdfBoxOutputDevice od)
createNonTerminalFieldsback to summary
private void createNonTerminalFields(PdfBoxForm.Field f, PDAcroForm form)

This method will create the non terminal fields. It is called recursively to create all non-terminal field descendants. It should be called after all the PDField objects are created.

createNonTerminalFieldsback to summary
private void createNonTerminalFields(PDAcroForm form)

Calls createNonTerminalFields on all root non-terminal fields. Otherwise, root fields are added to the acro form field collection.

getColorOperatorback to summary
private static String getColorOperator(FSColor color)

Get a PDF graphics operator for a specific color.

getCOSStringUTF16Encodedback to summary
private COSString getCOSStringUTF16Encoded(String value)
getTextareaTextback to summary
private String getTextareaText(Element e)
populateOptionsback to summary
private String populateOptions(Element e, List<String> labels, List<String> values, List<Integer> selectedIndices)
processback to summary
public int process(PDAcroForm acro, int startId, Box root) throws IOException
processCheckboxControlback to summary
private void processCheckboxControl(PdfBoxForm.ControlFontPair pair, PDAcroForm acro, int i, PdfBoxForm.Control ctrl, Box root) throws IOException
processControlNamesback to summary
private void processControlNames()

This method will create a tree of names, both non-terminal and terminal.

processHiddenControlback to summary
private void processHiddenControl(PdfBoxForm.ControlFontPair pair, PdfBoxForm.Control ctrl, PDAcroForm acro, int i, Box root) throws IOException
processMultiSelectControlback to summary
private void processMultiSelectControl(PdfBoxForm.ControlFontPair pair, PdfBoxForm.Control ctrl, PDAcroForm acro, int i, Box root) throws IOException
processRadioButtonGroupback to summary
private void processRadioButtonGroup(List<PdfBoxForm.Control> group, PDAcroForm acro, int i, Box root) throws IOException
processSelectControlback to summary
private void processSelectControl(PdfBoxForm.ControlFontPair pair, PdfBoxForm.Control ctrl, PDAcroForm acro, int i, Box root) throws IOException

Processes select controls and the custom openhtmltopdf-combo control.

processSubmitControlback to summary
private void processSubmitControl(PDAcroForm acro, int i, PdfBoxForm.Control ctrl, Box root) throws IOException
processTextControlback to summary
private void processTextControl(PdfBoxForm.ControlFontPair pair, PdfBoxForm.Control ctrl, PDAcroForm acro, int i, Box root) throws IOException
setPartialNameToFieldback to summary
private void setPartialNameToField(PdfBoxForm.Control ctrl, PDField field)
setPartialNameToFieldback to summary
private static void setPartialNameToField(Element element, PdfBoxForm.Field fObj, PDField field)
com.openhtmltopdf.pdfboxout back to summary

public final Enum PdfBoxForm.CheckboxStyle

extends Enum<PdfBoxForm.CheckboxStyle>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final int
public static final PdfBoxForm.CheckboxStyle
public static final PdfBoxForm.CheckboxStyle
public static final PdfBoxForm.CheckboxStyle
public static final PdfBoxForm.CheckboxStyle
public static final PdfBoxForm.CheckboxStyle
public static final PdfBoxForm.CheckboxStyle

Constructor Summary

AccessConstructor and Description
private
CheckboxStyle(int caption)

Method Summary

Modifier and TypeMethod and Description
public static PdfBoxForm.CheckboxStyle
public static PdfBoxForm.CheckboxStyle
public static PdfBoxForm.CheckboxStyle[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

captionback to summary
private final int caption
CHECKback to summary
public static final PdfBoxForm.CheckboxStyle CHECK
CIRCLEback to summary
public static final PdfBoxForm.CheckboxStyle CIRCLE
CROSSback to summary
public static final PdfBoxForm.CheckboxStyle CROSS
DIAMONDback to summary
public static final PdfBoxForm.CheckboxStyle DIAMOND
SQUAREback to summary
public static final PdfBoxForm.CheckboxStyle SQUARE
STARback to summary
public static final PdfBoxForm.CheckboxStyle STAR

Constructor Detail

CheckboxStyleback to summary
private CheckboxStyle(int caption)

Method Detail

fromIdentback to summary
public static PdfBoxForm.CheckboxStyle fromIdent(IdentValue id)
valueOfback to summary
public static PdfBoxForm.CheckboxStyle valueOf(String name)
valuesback to summary
public static PdfBoxForm.CheckboxStyle[] values()
com.openhtmltopdf.pdfboxout back to summary

public Class PdfBoxForm.Control

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public final Box
private final RenderingContext
c

private final PDPage
private final float
private final AffineTransform

Constructor Summary

AccessConstructor and Description
public
Control(Box box, PDPage page, AffineTransform transform, RenderingContext c, float pageHeight)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

boxback to summary
public final Box box
cback to summary
private final RenderingContext c
pageback to summary
private final PDPage page
pageHeightback to summary
private final float pageHeight
transformback to summary
private final AffineTransform transform

Constructor Detail

Controlback to summary
public Control(Box box, PDPage page, AffineTransform transform, RenderingContext c, float pageHeight)
com.openhtmltopdf.pdfboxout back to summary

private Class PdfBoxForm.ControlFontPair

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final PdfBoxForm.Control
private final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

controlback to summary
private final PdfBoxForm.Control control
fontNameback to summary
private final String fontName

Constructor Detail

ControlFontPairback to summary
private ControlFontPair(PdfBoxForm.Control control, String fontName)
com.openhtmltopdf.pdfboxout back to summary

private Class PdfBoxForm.Field

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private PDField
private boolean
private String
private String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fieldback to summary
private PDField field
isTerminalback to summary
private boolean isTerminal
partialNameback to summary
private String partialName
qualifiedNameback to summary
private String qualifiedName

Constructor Detail

Fieldback to summary
private Field()