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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_07) on Thu Oct 12 12:19:58 EDT 2006 -->
<TITLE>
PDAcroForm (PDFBox-0.7.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.pdfbox.pdmodel.interactive.form.PDAcroForm class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="PDAcroForm (PDFBox-0.7.3 API)";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PDAcroForm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAppearance.html" title="class in org.pdfbox.pdmodel.interactive.form"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="PDAcroForm.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.pdfbox.pdmodel.interactive.form</FONT>
<BR>
Class PDAcroForm</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.pdfbox.pdmodel.interactive.form.PDAcroForm</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.pdfbox.pdmodel.common">COSObjectable</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>PDAcroForm</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.pdfbox.pdmodel.common">COSObjectable</A></DL>
<P>
This class represents the acroform of a PDF document.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.14 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#PDAcroForm(org.pdfbox.pdmodel.PDDocument)">PDAcroForm</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> doc)</CODE>
<BR>
Constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#PDAcroForm(org.pdfbox.pdmodel.PDDocument, org.pdfbox.cos.COSDictionary)">PDAcroForm</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> doc,
<A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A> form)</CODE>
<BR>
Constructor.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.pdfbox.pdmodel.fdf">FDFDocument</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#exportFDF()">exportFDF</A></B>()</CODE>
<BR>
This will export all FDF form data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/cos/COSBase.html" title="class in org.pdfbox.cos">COSBase</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getCOSObject()">getCOSObject</A></B>()</CODE>
<BR>
Convert this standard java object to a COS object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/pdmodel/PDResources.html" title="class in org.pdfbox.pdmodel">PDResources</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getDefaultResources()">getDefaultResources</A></B>()</CODE>
<BR>
This will get the default resources for the acro form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getDictionary()">getDictionary</A></B>()</CODE>
<BR>
This will get the dictionary that this form wraps.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getDocument()">getDocument</A></B>()</CODE>
<BR>
This will get the document associated with this form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDField.html" title="class in org.pdfbox.pdmodel.interactive.form">PDField</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getField(java.lang.String)">getField</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
This will get a field by name, possibly using the cache if setCache is true.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getFields()">getFields</A></B>()</CODE>
<BR>
This will return all of the fields in the document. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDXFA.html" title="class in org.pdfbox.pdmodel.interactive.form">PDXFA</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#getXFA()">getXFA</A></B>()</CODE>
<BR>
Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#importFDF(org.pdfbox.pdmodel.fdf.FDFDocument)">importFDF</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.pdfbox.pdmodel.fdf">FDFDocument</A> fdf)</CODE>
<BR>
This method will import an entire FDF document into the PDF document
that this acroform is part of.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#isCachingFields()">isCachingFields</A></B>()</CODE>
<BR>
This will tell if this acro form is caching the fields.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setCacheFields(boolean)">setCacheFields</A></B>(boolean cache)</CODE>
<BR>
This will tell this form to cache the fields into a Map structure
for fast access via the getField method. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setDefaultResources(org.pdfbox.pdmodel.PDResources)">setDefaultResources</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDResources.html" title="class in org.pdfbox.pdmodel">PDResources</A> dr)</CODE>
<BR>
This will set the default resources for the acroform.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setFields(java.util.List)">setFields</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A> fields)</CODE>
<BR>
Set the fields that are part of this AcroForm.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAcroForm.html#setXFA(org.pdfbox.pdmodel.interactive.form.PDXFA)">setXFA</A></B>(<A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDXFA.html" title="class in org.pdfbox.pdmodel.interactive.form">PDXFA</A> xfa)</CODE>
<BR>
Set the XFA resource, this is only used for PDF 1.5+ forms.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="PDAcroForm(org.pdfbox.pdmodel.PDDocument)"><!-- --></A><H3>
PDAcroForm</H3>
<PRE>
public <B>PDAcroForm</B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> doc)</PRE>
<DL>
<DD>Constructor.
<P>
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The document that this form is part of.</DL>
<HR>
<A NAME="PDAcroForm(org.pdfbox.pdmodel.PDDocument, org.pdfbox.cos.COSDictionary)"><!-- --></A><H3>
PDAcroForm</H3>
<PRE>
public <B>PDAcroForm</B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> doc,
<A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A> form)</PRE>
<DL>
<DD>Constructor.
<P>
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The document that this form is part of.<DD><CODE>form</CODE> - The existing acroForm.</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getDocument()"><!-- --></A><H3>
getDocument</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>getDocument</B>()</PRE>
<DL>
<DD>This will get the document associated with this form.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The PDF document.</DL>
</DD>
</DL>
<HR>
<A NAME="getDictionary()"><!-- --></A><H3>
getDictionary</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/cos/COSDictionary.html" title="class in org.pdfbox.cos">COSDictionary</A> <B>getDictionary</B>()</PRE>
<DL>
<DD>This will get the dictionary that this form wraps.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The dictionary for this form.</DL>
</DD>
</DL>
<HR>
<A NAME="importFDF(org.pdfbox.pdmodel.fdf.FDFDocument)"><!-- --></A><H3>
importFDF</H3>
<PRE>
public void <B>importFDF</B>(<A HREF="../../../../../org/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.pdfbox.pdmodel.fdf">FDFDocument</A> fdf)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>This method will import an entire FDF document into the PDF document
that this acroform is part of.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fdf</CODE> - The FDF document to import.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error doing the import.</DL>
</DD>
</DL>
<HR>
<A NAME="exportFDF()"><!-- --></A><H3>
exportFDF</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.pdfbox.pdmodel.fdf">FDFDocument</A> <B>exportFDF</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>This will export all FDF form data.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>An FDF document used to export the document.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error when exporting the document.</DL>
</DD>
</DL>
<HR>
<A NAME="getFields()"><!-- --></A><H3>
getFields</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>getFields</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>This will return all of the fields in the document. The type
will be a org.pdfbox.pdmodel.field.PDField.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A list of all the fields.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error while getting the list of fields.</DL>
</DD>
</DL>
<HR>
<A NAME="setFields(java.util.List)"><!-- --></A><H3>
setFields</H3>
<PRE>
public void <B>setFields</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A> fields)</PRE>
<DL>
<DD>Set the fields that are part of this AcroForm.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fields</CODE> - The fields that are part of this form.</DL>
</DD>
</DL>
<HR>
<A NAME="setCacheFields(boolean)"><!-- --></A><H3>
setCacheFields</H3>
<PRE>
public void <B>setCacheFields</B>(boolean cache)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>This will tell this form to cache the fields into a Map structure
for fast access via the getField method. The default is false. You would
want this to be false if you were changing the COSDictionary behind the scenes,
otherwise setting this to true is acceptable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cache</CODE> - A boolean telling if we should cache the fields.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error while caching the fields.</DL>
</DD>
</DL>
<HR>
<A NAME="isCachingFields()"><!-- --></A><H3>
isCachingFields</H3>
<PRE>
public boolean <B>isCachingFields</B>()</PRE>
<DL>
<DD>This will tell if this acro form is caching the fields.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the fields are being cached.</DL>
</DD>
</DL>
<HR>
<A NAME="getField(java.lang.String)"><!-- --></A><H3>
getField</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDField.html" title="class in org.pdfbox.pdmodel.interactive.form">PDField</A> <B>getField</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>This will get a field by name, possibly using the cache if setCache is true.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the field to get.
<DT><B>Returns:</B><DD>The field with that name of null if one was not found.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error getting the field type.</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultResources()"><!-- --></A><H3>
getDefaultResources</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/PDResources.html" title="class in org.pdfbox.pdmodel">PDResources</A> <B>getDefaultResources</B>()</PRE>
<DL>
<DD>This will get the default resources for the acro form.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The default resources.</DL>
</DD>
</DL>
<HR>
<A NAME="setDefaultResources(org.pdfbox.pdmodel.PDResources)"><!-- --></A><H3>
setDefaultResources</H3>
<PRE>
public void <B>setDefaultResources</B>(<A HREF="../../../../../org/pdfbox/pdmodel/PDResources.html" title="class in org.pdfbox.pdmodel">PDResources</A> dr)</PRE>
<DL>
<DD>This will set the default resources for the acroform.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dr</CODE> - The new default resources.</DL>
</DD>
</DL>
<HR>
<A NAME="getCOSObject()"><!-- --></A><H3>
getCOSObject</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/cos/COSBase.html" title="class in org.pdfbox.cos">COSBase</A> <B>getCOSObject</B>()</PRE>
<DL>
<DD>Convert this standard java object to a COS object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/COSObjectable.html#getCOSObject()">getCOSObject</A></CODE> in interface <CODE><A HREF="../../../../../org/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.pdfbox.pdmodel.common">COSObjectable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The cos object that matches this Java object.</DL>
</DD>
</DL>
<HR>
<A NAME="getXFA()"><!-- --></A><H3>
getXFA</H3>
<PRE>
public <A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDXFA.html" title="class in org.pdfbox.pdmodel.interactive.form">PDXFA</A> <B>getXFA</B>()</PRE>
<DL>
<DD>Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The xfa resource or null if it does not exist.</DL>
</DD>
</DL>
<HR>
<A NAME="setXFA(org.pdfbox.pdmodel.interactive.form.PDXFA)"><!-- --></A><H3>
setXFA</H3>
<PRE>
public void <B>setXFA</B>(<A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDXFA.html" title="class in org.pdfbox.pdmodel.interactive.form">PDXFA</A> xfa)</PRE>
<DL>
<DD>Set the XFA resource, this is only used for PDF 1.5+ forms.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xfa</CODE> - The xfa resource.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PDAcroForm.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../org/pdfbox/pdmodel/interactive/form/PDAppearance.html" title="class in org.pdfbox.pdmodel.interactive.form"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="PDAcroForm.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
