In this example we will Apache PDFBox to create PDF form.
The form will contain the following elements
- Labels
- Input Text Fields
- Check Boxes
- Radio Buttons
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 | import java.awt.geom.Rectangle2D;import java.io.IOException;import java.util.ArrayList;import org.apache.pdfbox.cos.COSDictionary;import org.apache.pdfbox.cos.COSName;import org.apache.pdfbox.pdmodel.PDDocument;import org.apache.pdfbox.pdmodel.PDPage;import org.apache.pdfbox.pdmodel.PDPageContentStream;import org.apache.pdfbox.pdmodel.PDResources;import org.apache.pdfbox.pdmodel.common.PDRectangle;import org.apache.pdfbox.pdmodel.font.PDFont;import org.apache.pdfbox.pdmodel.font.PDType1Font;import org.apache.pdfbox.pdmodel.graphics.color.PDColor;import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB;import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary;import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry;import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;import org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary;import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;import org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox;import org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton;import org.apache.pdfbox.pdmodel.interactive.form.PDTextField;public class GeneratePDFForm { public static void main(String[] args) throws Exception{ // Create a new document with an empty page. PDDocument document = new PDDocument(); PDPage page = new PDPage(PDRectangle.LETTER); document.addPage(page); // Adobe Acrobat uses Helvetica as a default font and // stores that under the name '/Helv' in the resources dictionary PDFont font = PDType1Font.HELVETICA; PDResources resources = new PDResources(); resources.put(COSName.getPDFName("Helv"), font); // Add a new AcroForm and add that to the document PDAcroForm acroForm = new PDAcroForm(document); document.getDocumentCatalog().setAcroForm(acroForm); // Add and set the resources and default appearance at the form level acroForm.setDefaultResources(resources); // Acrobat sets the font size on the form level to be // auto sized as default. This is done by setting the font size to '0' String defaultAppearanceString = "/Helv 12 Tf 0 g"; acroForm.setDefaultAppearance(defaultAppearanceString); int x = 25; int y = 750; addText(document, page, "Registration Form", x , y, true); y = y - 30; addText(document, page, "Name", x , y, false); addField(acroForm, page, "name", "Your Name", x + 75, y); y = y - 20; addText(document, page, "Address", x , y, false); addField(acroForm, page, "address", "", x + 75, y); y = y - 20; addText(document, page, "Phone No", x , y, false); addField(acroForm, page, "phone", " ", x + 75, y); y = y - 30; addText(document, page, "Hobbies", x , y, true); y = y - 20; addCheckBox(document, acroForm, page, "sports", false, x, y); addText(document, page, "Sports", x + 25 , y, false); y = y - 20; addCheckBox(document, acroForm, page, "cooking", false, x, y); addText(document, page, "Cooking", x + 25 , y, false); y = y - 20; addCheckBox(document, acroForm, page, "music", true, x, y); addText(document, page, "Music", x + 25 , y, false); y = y - 20; addCheckBox(document, acroForm, page, "travel", false, x, y); addText(document, page, "Travelling", x + 25 , y, false); y = y - 30; addText(document, page, "Gender", x , y, true); ArrayList<button> genderList = new ArrayList</button><button>(); Button button = new Button(); button.setName("Male"); button.setValue("male"); genderList.add(button); button = new Button(); button.setName("Female"); button.setValue("female"); genderList.add(button); button = new Button(); button.setName("Other"); button.setValue("other"); genderList.add(button); addRadioButtons(document, acroForm, page, genderList, "male", x, y); document.save("docs/my_form.pdf"); document.close(); } // Generate Form Labels private static void addText(PDDocument document, PDPage page, String myText, float x, float y, boolean bold) { try { //Get Content Stream for Writing Data PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true); //Begin the Content stream contentStream.beginText(); //Setting the font to the Content stream if(bold){ contentStream.setFont(PDType1Font.HELVETICA_BOLD, 12); } else{ contentStream.setFont(PDType1Font.HELVETICA, 12); } //Setting the position for the line contentStream.newLineAtOffset(x, y); //Adding text in the form of string contentStream.showText(myText); //Ending the content stream contentStream.endText(); //Closing the content stream contentStream.close(); } catch (IOException e) { e.printStackTrace(); } } // Generate Form Text fields private static void addField(PDAcroForm acroForm, PDPage page, String name, String defaultValue, float x, float y) { try { // Add a form field to the form. PDTextField textBox = new PDTextField(acroForm); textBox.setPartialName(name); acroForm.getFields().add(textBox); // Specify the widget annotation associated with the field PDAnnotationWidget widget = textBox.getWidgets().get(0); PDRectangle rect = new PDRectangle(x, y, 200, 15); widget.setRectangle(rect); widget.setPage(page); // set black border // if you prefer defaults, just delete this code block PDAppearanceCharacteristicsDictionary fieldAppearance = new PDAppearanceCharacteristicsDictionary(new COSDictionary()); fieldAppearance.setBorderColour(new PDColor(new float[]{0,0,0}, PDDeviceRGB.INSTANCE)); // for background color if you need // fieldAppearance.setBackground(new PDColor(new float[]{1,1,0}, PDDeviceRGB.INSTANCE)); widget.setAppearanceCharacteristics(fieldAppearance); // make sure the widget annotation is visible on screen and paper widget.setPrinted(true); // Add the widget annotation to the page page.getAnnotations().add(widget); // set the field value textBox.setValue(defaultValue); } catch (IOException e) { e.printStackTrace(); } } // Generate Form Check Boxes private static void addCheckBox(PDDocument document, PDAcroForm acroForm, PDPage page, String name, boolean checked, float x, float y) { try { PDRectangle rect = new PDRectangle(x, y, 15, 15); PDCheckBox checkbox = new PDCheckBox(acroForm); checkbox.setPartialName(name); PDAnnotationWidget widget = checkbox.getWidgets().get(0); widget.setPage(page); widget.setRectangle(rect); widget.setPrinted(true); PDAppearanceCharacteristicsDictionary appearanceCharacteristics = new PDAppearanceCharacteristicsDictionary(new COSDictionary()); appearanceCharacteristics.setBorderColour(new PDColor(new float[]{1, 0, 0}, PDDeviceRGB.INSTANCE)); appearanceCharacteristics.setBackground(new PDColor(new float[]{1, 1, 0}, PDDeviceRGB.INSTANCE)); // 8 = cross; 4 = checkmark; H = star; u = diamond; n = square, l = dot appearanceCharacteristics.setNormalCaption("4"); widget.setAppearanceCharacteristics(appearanceCharacteristics); PDBorderStyleDictionary borderStyleDictionary = new PDBorderStyleDictionary(); borderStyleDictionary.setWidth(1); borderStyleDictionary.setStyle(PDBorderStyleDictionary.STYLE_SOLID); widget.setBorderStyle(borderStyleDictionary); PDAppearanceDictionary ap = new PDAppearanceDictionary(); widget.setAppearance(ap); PDAppearanceEntry normalAppearance = ap.getNormalAppearance(); COSDictionary normalAppearanceDict = (COSDictionary) normalAppearance.getCOSObject(); normalAppearanceDict.setItem(COSName.Off, createCheckBoxAppearanceStream(document, widget, false)); normalAppearanceDict.setItem(COSName.YES, createCheckBoxAppearanceStream(document, widget, true)); // If we ever decide to implement a /D (down) appearance, just // replace the background colors c with c * 0.75 page.getAnnotations().add(checkbox.getWidgets().get(0)); acroForm.getFields().add(checkbox); if(checked){ checkbox.check(); } else { checkbox.unCheck(); } } catch (IOException e) { e.printStackTrace(); } } // Generate Form Radio Buttons private static void addRadioButtons(PDDocument document, PDAcroForm acroForm, PDPage page, ArrayList</button><button> buttonList, String defaultValue, float x, float y) { try { ArrayList<string> buttonValues = new ArrayList<string>(); for(Button button: buttonList){ buttonValues.add(button.getValue()); } PDRadioButton radioButton = new PDRadioButton(acroForm); radioButton.setPartialName("MyRadioButton"); radioButton.setExportValues(buttonValues); PDAppearanceCharacteristicsDictionary appearanceCharacteristics = new PDAppearanceCharacteristicsDictionary(new COSDictionary()); appearanceCharacteristics.setBorderColour(new PDColor(new float[] { 1, 0, 0 }, PDDeviceRGB.INSTANCE)); appearanceCharacteristics.setBackground(new PDColor(new float[]{0, 1, 0.3f}, PDDeviceRGB.INSTANCE)); ArrayList<pdannotationwidget> widgets = new ArrayList<pdannotationwidget>(); for (int i = 0; i < buttonList.size(); i++) { y = y - 20; PDAnnotationWidget widget = new PDAnnotationWidget(); widget.setRectangle(new PDRectangle(x, y, 15, 15)); widget.setAppearanceCharacteristics(appearanceCharacteristics); PDBorderStyleDictionary borderStyleDictionary = new PDBorderStyleDictionary(); borderStyleDictionary.setWidth(1); borderStyleDictionary.setStyle(PDBorderStyleDictionary.STYLE_SOLID); widget.setBorderStyle(borderStyleDictionary); widget.setPage(page); COSDictionary apNDict = new COSDictionary(); apNDict.setItem(COSName.Off, createRadioButtonAppearanceStream(document, widget, false)); apNDict.setItem(buttonList.get(i).getValue(), createRadioButtonAppearanceStream(document, widget, true)); PDAppearanceDictionary appearance = new PDAppearanceDictionary(); PDAppearanceEntry appearanceNEntry = new PDAppearanceEntry(apNDict); appearance.setNormalAppearance(appearanceNEntry); widget.setAppearance(appearance); widget.setAppearanceState("Off"); // don't forget this, or button will be invisible widgets.add(widget); page.getAnnotations().add(widget); addText(document, page, buttonList.get(i).getName(), x + 25 , y+3, false); } radioButton.setWidgets(widgets); acroForm.getFields().add(radioButton); radioButton.setValue(defaultValue); } catch (IOException e) { e.printStackTrace(); } } private static PDAppearanceStream createCheckBoxAppearanceStream( final PDDocument document, PDAnnotationWidget widget, boolean on) throws IOException { PDRectangle rect = widget.getRectangle(); PDAppearanceCharacteristicsDictionary appearanceCharacteristics; PDAppearanceStream yesAP = new PDAppearanceStream(document); yesAP.setBBox(new PDRectangle(rect.getWidth(), rect.getHeight())); yesAP.setResources(new PDResources()); PDPageContentStream yesAPCS = new PDPageContentStream(document, yesAP); appearanceCharacteristics = widget.getAppearanceCharacteristics(); PDColor backgroundColor = appearanceCharacteristics.getBackground(); PDColor borderColor = appearanceCharacteristics.getBorderColour(); float lineWidth = getLineWidth(widget); yesAPCS.setLineWidth(lineWidth); // border style (dash) ignored yesAPCS.setNonStrokingColor(backgroundColor); yesAPCS.addRect(0, 0, rect.getWidth(), rect.getHeight()); yesAPCS.fill(); yesAPCS.setStrokingColor(borderColor); yesAPCS.addRect(lineWidth / 2, lineWidth / 2, rect.getWidth() - lineWidth, rect.getHeight() - lineWidth); yesAPCS.stroke(); if (!on) { yesAPCS.close(); return yesAP; } yesAPCS.addRect(lineWidth, lineWidth, rect.getWidth() - lineWidth * 2, rect.getHeight() - lineWidth * 2); yesAPCS.clip(); String normalCaption = appearanceCharacteristics.getNormalCaption(); if (normalCaption == null) { normalCaption = "4"; // Adobe behaviour } if ("8".equals(normalCaption)) { // Adobe paints a cross instead of using the Zapf Dingbats cross symbol yesAPCS.setStrokingColor(0f); yesAPCS.moveTo(lineWidth * 2, rect.getHeight() - lineWidth * 2); yesAPCS.lineTo(rect.getWidth() - lineWidth * 2, lineWidth * 2); yesAPCS.moveTo(rect.getWidth() - lineWidth * 2, rect.getHeight() - lineWidth * 2); yesAPCS.lineTo(lineWidth * 2, lineWidth * 2); yesAPCS.stroke(); } else { // The caption is not unicode, but the Zapf Dingbats code in the PDF // Thus convert it back to unicode // Assume that only the first character is used. String name = PDType1Font.ZAPF_DINGBATS.codeToName(normalCaption.codePointAt(0)); String unicode = PDType1Font.ZAPF_DINGBATS.getGlyphList().toUnicode(name); Rectangle2D bounds = PDType1Font.ZAPF_DINGBATS.getPath(name).getBounds2D(); float size = (float) Math.min(bounds.getWidth(), bounds.getHeight()) / 1000; // assume that checkmark has square size // the calculations approximate what Adobe is doing, i.e. put the glyph in the middle float fontSize = (rect.getWidth() - lineWidth * 2) / size * 0.6666f; float xOffset = (float) (rect.getWidth() - (bounds.getWidth()) / 1000 * fontSize) / 2; xOffset -= bounds.getX() / 1000 * fontSize; float yOffset = (float) (rect.getHeight() - (bounds.getHeight()) / 1000 * fontSize) / 2; yOffset -= bounds.getY() / 1000 * fontSize; yesAPCS.setNonStrokingColor(0f); yesAPCS.beginText(); yesAPCS.setFont(PDType1Font.ZAPF_DINGBATS, fontSize); yesAPCS.newLineAtOffset(xOffset, yOffset); yesAPCS.showText(unicode); yesAPCS.endText(); } yesAPCS.close(); return yesAP; } private static PDAppearanceStream createRadioButtonAppearanceStream( final PDDocument document, PDAnnotationWidget widget, boolean on) throws IOException { PDRectangle rect = widget.getRectangle(); PDAppearanceStream onAP = new PDAppearanceStream(document); onAP.setBBox(new PDRectangle(rect.getWidth(), rect.getHeight())); PDPageContentStream onAPCS = new PDPageContentStream(document, onAP); PDAppearanceCharacteristicsDictionary appearanceCharacteristics = widget.getAppearanceCharacteristics(); PDColor backgroundColor = appearanceCharacteristics.getBackground(); PDColor borderColor = appearanceCharacteristics.getBorderColour(); float lineWidth = getLineWidth(widget); onAPCS.setLineWidth(lineWidth); // border style (dash) ignored onAPCS.setNonStrokingColor(backgroundColor); float radius = Math.min(rect.getWidth() / 2, rect.getHeight() / 2); drawCircle(onAPCS, rect.getWidth() / 2, rect.getHeight() / 2, radius); onAPCS.fill(); onAPCS.setStrokingColor(borderColor); drawCircle(onAPCS, rect.getWidth() / 2, rect.getHeight() / 2, radius - lineWidth / 2); onAPCS.stroke(); if (on) { onAPCS.setNonStrokingColor(0f); drawCircle(onAPCS, rect.getWidth() / 2, rect.getHeight() / 2, (radius - lineWidth) / 2); onAPCS.fill(); } onAPCS.close(); return onAP; } private static float getLineWidth(PDAnnotationWidget widget) { PDBorderStyleDictionary bs = widget.getBorderStyle(); if (bs != null) { return bs.getWidth(); } return 1; } private static void drawCircle(PDPageContentStream cs, float x, float y, float r) throws IOException { float magic = r * 0.551784f; cs.moveTo(x, y + r); cs.curveTo(x + magic, y + r, x + r, y + magic, x + r, y); cs.curveTo(x + r, y - magic, x + magic, y - r, x, y - r); cs.curveTo(x - magic, y - r, x - r, y - magic, x - r, y); cs.curveTo(x - r, y + magic, x - magic, y + r, x, y + r); cs.closePath(); }}class Button { private String name = ""; private String value = ""; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getValue() { return value; } public void setValue(String value) { this.value = value; }}</pdannotationwidget></pdannotationwidget></string></string></button> |
No comments:
Post a Comment
NO JUNK, Please try to keep this clean and related to the topic at hand.
Comments are for users to ask questions, collaborate or improve on existing.