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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
|
<!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:55 EDT 2006 -->
<TITLE>
PDDocument (PDFBox-0.7.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.pdfbox.pdmodel.PDDocument class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="PDDocument (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/PDDocument.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">
<A HREF="../../../org/pdfbox/pdmodel/PDDestinationNameTreeNode.html" title="class in org.pdfbox.pdmodel"><B>PREV CLASS</B></A>
<A HREF="../../../org/pdfbox/pdmodel/PDDocumentCatalog.html" title="class in org.pdfbox.pdmodel"><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="PDDocument.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</FONT>
<BR>
Class PDDocument</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.PDDocument</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>PDDocument</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="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></DL>
<P>
This is the in-memory representation of the PDF document. You need to call
close() on this object when you are done using it!!
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.43 $</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 =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_java.awt.print.Pageable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from interface java.awt.print.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html#UNKNOWN_NUMBER_OF_PAGES" title="class or interface in java.awt.print">UNKNOWN_NUMBER_OF_PAGES</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== 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/PDDocument.html#PDDocument()">PDDocument</A></B>()</CODE>
<BR>
Constructor, creates a new PDF Document with no pages. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#PDDocument(org.pdfbox.cos.COSDocument)">PDDocument</A></B>(<A HREF="../../../org/pdfbox/cos/COSDocument.html" title="class in org.pdfbox.cos">COSDocument</A> doc)</CODE>
<BR>
Constructor that uses an existing document. </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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#addPage(org.pdfbox.pdmodel.PDPage)">addPage</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)</CODE>
<BR>
This will add a page to the document. </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/PDDocument.html#clearWillEncryptWhenSaving()">clearWillEncryptWhenSaving</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>Do not rely on this method anymore. It is the responsability of
COSWriter to hold this state.</I></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/PDDocument.html#close()">close</A></B>()</CODE>
<BR>
This will close the underlying COSDocument object.</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/PDDocument.html#decrypt(java.lang.String)">decrypt</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> password)</CODE>
<BR>
This will decrypt a document. </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/PDDocument.html#encrypt(java.lang.String, java.lang.String)">encrypt</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> ownerPassword,
<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> userPassword)</CODE>
<BR>
This will <b>mark</b> a document to be encrypted. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/encryption/AccessPermission.html" title="class in org.pdfbox.pdmodel.encryption">AccessPermission</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getCurrentAccessPermission()">getCurrentAccessPermission</A></B>()</CODE>
<BR>
Returns the access permissions granted when the document was decrypted.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/cos/COSDocument.html" title="class in org.pdfbox.cos">COSDocument</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getDocument()">getDocument</A></B>()</CODE>
<BR>
This will get the low level document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/PDDocumentCatalog.html" title="class in org.pdfbox.pdmodel">PDDocumentCatalog</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getDocumentCatalog()">getDocumentCatalog</A></B>()</CODE>
<BR>
This will get the document CATALOG. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/PDDocumentInformation.html" title="class in org.pdfbox.pdmodel">PDDocumentInformation</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getDocumentInformation()">getDocumentInformation</A></B>()</CODE>
<BR>
This will get the document info dictionary. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/encryption/PDEncryptionDictionary.html" title="class in org.pdfbox.pdmodel.encryption">PDEncryptionDictionary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getEncryptionDictionary()">getEncryptionDictionary</A></B>()</CODE>
<BR>
This will get the encryption dictionary for this document. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getNumberOfPages()">getNumberOfPages</A></B>()</CODE>
<BR>
</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/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getOwnerPasswordForEncryption()">getOwnerPasswordForEncryption</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>Do not rely on this method anymore.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getPageCount()">getPageCount</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>Use the getNumberOfPages method instead!</I></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/awt/print/PageFormat.html" title="class or interface in java.awt.print">PageFormat</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getPageFormat(int)">getPageFormat</A></B>(int pageIndex)</CODE>
<BR>
</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/awt/print/Printable.html" title="class or interface in java.awt.print">Printable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getPrintable(int)">getPrintable</A></B>(int pageIndex)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getSecurityHandler()">getSecurityHandler</A></B>()</CODE>
<BR>
Get the security handler that is used for document encryption.</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/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#getUserPasswordForEncryption()">getUserPasswordForEncryption</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>Do not rely on this method anymore.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#importPage(org.pdfbox.pdmodel.PDPage)">importPage</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)</CODE>
<BR>
This will import and copy the contents from another location. </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/PDDocument.html#isEncrypted()">isEncrypted</A></B>()</CODE>
<BR>
This will tell if this document is encrypted or not.</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/PDDocument.html#isOwnerPassword(java.lang.String)">isOwnerPassword</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> password)</CODE>
<BR>
<B>Deprecated.</B> <I></I> </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/PDDocument.html#isUserPassword(java.lang.String)">isUserPassword</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> password)</CODE>
<BR>
<B>Deprecated.</B> <I></I> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.io.File)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A> file)</CODE>
<BR>
This will load a document from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.io.File, org.pdfbox.io.RandomAccess)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A> file,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)</CODE>
<BR>
This will load a document from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.io.InputStream)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> input)</CODE>
<BR>
This will load a document from an input stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.io.InputStream, org.pdfbox.io.RandomAccess)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> input,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)</CODE>
<BR>
This will load a document from an input stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.lang.String)">load</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> filename)</CODE>
<BR>
This will load a document from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.lang.String, org.pdfbox.io.RandomAccess)">load</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> filename,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)</CODE>
<BR>
This will load a document from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.net.URL)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A> url)</CODE>
<BR>
This will load a document from a url.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/PDDocument.html#load(java.net.URL, org.pdfbox.io.RandomAccess)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A> url,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)</CODE>
<BR>
This will load a document from a url.</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/PDDocument.html#openProtection(org.pdfbox.pdmodel.encryption.DecryptionMaterial)">openProtection</A></B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/DecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption">DecryptionMaterial</A> pm)</CODE>
<BR>
Tries to decrypt the document in memory using the provided decryption material.</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/PDDocument.html#print()">print</A></B>()</CODE>
<BR>
This will send the PDF document to a printer. </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/PDDocument.html#protect(org.pdfbox.pdmodel.encryption.ProtectionPolicy)">protect</A></B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/ProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption">ProtectionPolicy</A> pp)</CODE>
<BR>
Protects the document with the protection policy pp. </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/PDDocument.html#removePage(int)">removePage</A></B>(int pageNumber)</CODE>
<BR>
Remove the page from the document.</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/PDDocument.html#removePage(org.pdfbox.pdmodel.PDPage)">removePage</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)</CODE>
<BR>
Remove the page from the document.</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/PDDocument.html#save(java.io.OutputStream)">save</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> output)</CODE>
<BR>
This will save the document to an output stream.</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/PDDocument.html#save(java.lang.String)">save</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> fileName)</CODE>
<BR>
This will save this document to the filesystem.</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/PDDocument.html#setDocumentInformation(org.pdfbox.pdmodel.PDDocumentInformation)">setDocumentInformation</A></B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocumentInformation.html" title="class in org.pdfbox.pdmodel">PDDocumentInformation</A> info)</CODE>
<BR>
This will set the document information for this document.</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/PDDocument.html#setEncryptionDictionary(org.pdfbox.pdmodel.encryption.PDEncryptionDictionary)">setEncryptionDictionary</A></B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/PDEncryptionDictionary.html" title="class in org.pdfbox.pdmodel.encryption">PDEncryptionDictionary</A> encDictionary)</CODE>
<BR>
This will set the encryption dictionary for this document.</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/PDDocument.html#silentPrint()">silentPrint</A></B>()</CODE>
<BR>
This will send the PDF to the default printer without prompting the user
for any printer settings.</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/PDDocument.html#wasDecryptedWithOwnerPassword()">wasDecryptedWithOwnerPassword</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>use <code>getCurrentAccessPermission</code> instead</I></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/PDDocument.html#willEncryptWhenSaving()">willEncryptWhenSaving</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>Do not rely on this method anymore. It is the responsibility of
COSWriter to hold this state</I></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="PDDocument()"><!-- --></A><H3>
PDDocument</H3>
<PRE>
public <B>PDDocument</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>Constructor, creates a new PDF Document with no pages. You need to add
at least one page for the document to be valid.
<P>
<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 creating this document.</DL>
<HR>
<A NAME="PDDocument(org.pdfbox.cos.COSDocument)"><!-- --></A><H3>
PDDocument</H3>
<PRE>
public <B>PDDocument</B>(<A HREF="../../../org/pdfbox/cos/COSDocument.html" title="class in org.pdfbox.cos">COSDocument</A> doc)</PRE>
<DL>
<DD>Constructor that uses an existing document. The COSDocument that
is passed in must be valid.
<P>
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The COSDocument that this document wraps.</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="addPage(org.pdfbox.pdmodel.PDPage)"><!-- --></A><H3>
addPage</H3>
<PRE>
public void <B>addPage</B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)</PRE>
<DL>
<DD>This will add a page to the document. This is a convenience method, that
will add the page to the root of the hierarchy and set the parent of the
page to the root.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - The page to add to the document.</DL>
</DD>
</DL>
<HR>
<A NAME="removePage(org.pdfbox.pdmodel.PDPage)"><!-- --></A><H3>
removePage</H3>
<PRE>
public boolean <B>removePage</B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)</PRE>
<DL>
<DD>Remove the page from the document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - The page to remove from the document.
<DT><B>Returns:</B><DD>true if the page was found false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="removePage(int)"><!-- --></A><H3>
removePage</H3>
<PRE>
public boolean <B>removePage</B>(int pageNumber)</PRE>
<DL>
<DD>Remove the page from the document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pageNumber</CODE> - 0 based index to page number.
<DT><B>Returns:</B><DD>true if the page was found false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="importPage(org.pdfbox.pdmodel.PDPage)"><!-- --></A><H3>
importPage</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> <B>importPage</B>(<A HREF="../../../org/pdfbox/pdmodel/PDPage.html" title="class in org.pdfbox.pdmodel">PDPage</A> page)
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 import and copy the contents from another location. Currently
the content stream is stored in a scratch file. The scratch file is
associated with the document. If you are adding a page to this document
from another document and want to copy the contents to this document's
scratch file then use this method otherwise just use the addPage method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - The page to import.
<DT><B>Returns:</B><DD>The page that was imported.
<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 copying the page.</DL>
</DD>
</DL>
<HR>
<A NAME="getDocument()"><!-- --></A><H3>
getDocument</H3>
<PRE>
public <A HREF="../../../org/pdfbox/cos/COSDocument.html" title="class in org.pdfbox.cos">COSDocument</A> <B>getDocument</B>()</PRE>
<DL>
<DD>This will get the low level document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The document that this layer sits on top of.</DL>
</DD>
</DL>
<HR>
<A NAME="getDocumentInformation()"><!-- --></A><H3>
getDocumentInformation</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/PDDocumentInformation.html" title="class in org.pdfbox.pdmodel">PDDocumentInformation</A> <B>getDocumentInformation</B>()</PRE>
<DL>
<DD>This will get the document info dictionary. This is guaranteed to not return null.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The documents /Info dictionary</DL>
</DD>
</DL>
<HR>
<A NAME="setDocumentInformation(org.pdfbox.pdmodel.PDDocumentInformation)"><!-- --></A><H3>
setDocumentInformation</H3>
<PRE>
public void <B>setDocumentInformation</B>(<A HREF="../../../org/pdfbox/pdmodel/PDDocumentInformation.html" title="class in org.pdfbox.pdmodel">PDDocumentInformation</A> info)</PRE>
<DL>
<DD>This will set the document information for this document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>info</CODE> - The updated document information.</DL>
</DD>
</DL>
<HR>
<A NAME="getDocumentCatalog()"><!-- --></A><H3>
getDocumentCatalog</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/PDDocumentCatalog.html" title="class in org.pdfbox.pdmodel">PDDocumentCatalog</A> <B>getDocumentCatalog</B>()</PRE>
<DL>
<DD>This will get the document CATALOG. This is guaranteed to not return null.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The documents /Root dictionary</DL>
</DD>
</DL>
<HR>
<A NAME="isEncrypted()"><!-- --></A><H3>
isEncrypted</H3>
<PRE>
public boolean <B>isEncrypted</B>()</PRE>
<DL>
<DD>This will tell if this document is encrypted or not.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true If this document is encrypted.</DL>
</DD>
</DL>
<HR>
<A NAME="getEncryptionDictionary()"><!-- --></A><H3>
getEncryptionDictionary</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/encryption/PDEncryptionDictionary.html" title="class in org.pdfbox.pdmodel.encryption">PDEncryptionDictionary</A> <B>getEncryptionDictionary</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 get the encryption dictionary for this document. This will still
return the parameters if the document was decrypted. If the document was
never encrypted then this will return null. As the encryption architecture
in PDF documents is plugable this returns an abstract class, but the only
supported subclass at this time is a PDStandardEncryption object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The encryption dictionary(most likely a PDStandardEncryption object)
<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 determining which security handler to use.</DL>
</DD>
</DL>
<HR>
<A NAME="setEncryptionDictionary(org.pdfbox.pdmodel.encryption.PDEncryptionDictionary)"><!-- --></A><H3>
setEncryptionDictionary</H3>
<PRE>
public void <B>setEncryptionDictionary</B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/PDEncryptionDictionary.html" title="class in org.pdfbox.pdmodel.encryption">PDEncryptionDictionary</A> encDictionary)
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 set the encryption dictionary for this document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encDictionary</CODE> - The encryption dictionary(most likely a PDStandardEncryption object)
<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 determining which security handler to use.</DL>
</DD>
</DL>
<HR>
<A NAME="isUserPassword(java.lang.String)"><!-- --></A><H3>
isUserPassword</H3>
<PRE>
public boolean <B>isUserPassword</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> password)
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>,
<A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></PRE>
<DL>
<DD><B>Deprecated.</B> <I></I>
<P>
<DD>This will determine if this is the user password. This only applies when
the document is encrypted and uses standard encryption.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>password</CODE> - The plain text user password.
<DT><B>Returns:</B><DD>true If the password passed in matches the user password used to encrypt 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 determining if it is the user password.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></CODE> - If there is an error in the encryption algorithms.</DL>
</DD>
</DL>
<HR>
<A NAME="isOwnerPassword(java.lang.String)"><!-- --></A><H3>
isOwnerPassword</H3>
<PRE>
public boolean <B>isOwnerPassword</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> password)
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>,
<A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></PRE>
<DL>
<DD><B>Deprecated.</B> <I></I>
<P>
<DD>This will determine if this is the owner password. This only applies when
the document is encrypted and uses standard encryption.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>password</CODE> - The plain text owner password.
<DT><B>Returns:</B><DD>true If the password passed in matches the owner password used to encrypt 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 determining if it is the user password.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></CODE> - If there is an error in the encryption algorithms.</DL>
</DD>
</DL>
<HR>
<A NAME="decrypt(java.lang.String)"><!-- --></A><H3>
decrypt</H3>
<PRE>
public void <B>decrypt</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> password)
throws <A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A>,
<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>,
<A HREF="../../../org/pdfbox/exceptions/InvalidPasswordException.html" title="class in org.pdfbox.exceptions">InvalidPasswordException</A></PRE>
<DL>
<DD>This will decrypt a document. This method is provided for compatibility reasons only. User should use
the new security layer instead and the openProtection method especially.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>password</CODE> - Either the user or owner password.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></CODE> - If there is an error decrypting the document.
<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 stream data.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/InvalidPasswordException.html" title="class in org.pdfbox.exceptions">InvalidPasswordException</A></CODE> - If the password is not a user or owner password.</DL>
</DD>
</DL>
<HR>
<A NAME="wasDecryptedWithOwnerPassword()"><!-- --></A><H3>
wasDecryptedWithOwnerPassword</H3>
<PRE>
public boolean <B>wasDecryptedWithOwnerPassword</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>use <code>getCurrentAccessPermission</code> instead</I>
<P>
<DD>This will tell if the document was decrypted with the master password. This
entry is invalid if the PDF was not decrypted.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the pdf was decrypted with the master password.</DL>
</DD>
</DL>
<HR>
<A NAME="encrypt(java.lang.String, java.lang.String)"><!-- --></A><H3>
encrypt</H3>
<PRE>
public void <B>encrypt</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> ownerPassword,
<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> userPassword)
throws <A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A>,
<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 <b>mark</b> a document to be encrypted. The actual encryption
will occur when the document is saved.
This method is provided for compatibility reasons only. User should use
the new security layer instead and the openProtection method especially.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ownerPassword</CODE> - The owner password to encrypt the document.<DD><CODE>userPassword</CODE> - The user password to encrypt the document.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></CODE> - If an error occurs during encryption.
<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 accessing the data.</DL>
</DD>
</DL>
<HR>
<A NAME="getOwnerPasswordForEncryption()"><!-- --></A><H3>
getOwnerPasswordForEncryption</H3>
<PRE>
public <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> <B>getOwnerPasswordForEncryption</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Do not rely on this method anymore.</I>
<P>
<DD>The owner password that was passed into the encrypt method. You should
never use this method. This will not longer be valid once encryption
has occured.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The owner password passed to the encrypt method.</DL>
</DD>
</DL>
<HR>
<A NAME="getUserPasswordForEncryption()"><!-- --></A><H3>
getUserPasswordForEncryption</H3>
<PRE>
public <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> <B>getUserPasswordForEncryption</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Do not rely on this method anymore.</I>
<P>
<DD>The user password that was passed into the encrypt method. You should
never use this method. This will not longer be valid once encryption
has occured.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The user password passed to the encrypt method.</DL>
</DD>
</DL>
<HR>
<A NAME="willEncryptWhenSaving()"><!-- --></A><H3>
willEncryptWhenSaving</H3>
<PRE>
public boolean <B>willEncryptWhenSaving</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Do not rely on this method anymore. It is the responsibility of
COSWriter to hold this state</I>
<P>
<DD>Internal method do determine if the document will be encrypted when it is saved.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True if encrypt has been called and the document
has not been saved yet.</DL>
</DD>
</DL>
<HR>
<A NAME="clearWillEncryptWhenSaving()"><!-- --></A><H3>
clearWillEncryptWhenSaving</H3>
<PRE>
public void <B>clearWillEncryptWhenSaving</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Do not rely on this method anymore. It is the responsability of
COSWriter to hold this state.</I>
<P>
<DD>This shoule only be called by the COSWriter after encryption has completed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.net.URL)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A> url)
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 load a document from a url.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - The url to load the PDF from.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.net.URL, org.pdfbox.io.RandomAccess)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A> url,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)
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 load a document from a url.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - The url to load the PDF from.<DD><CODE>scratchFile</CODE> - A location to store temp PDFBox data for this document.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.lang.String)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</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> filename)
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 load a document from a file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the file to load.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.lang.String, org.pdfbox.io.RandomAccess)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</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> filename,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)
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 load a document from a file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the file to load.<DD><CODE>scratchFile</CODE> - A location to store temp PDFBox data for this document.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.io.File)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A> file)
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 load a document from a file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - The name of the file to load.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.io.File, org.pdfbox.io.RandomAccess)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html" title="class or interface in java.io">File</A> file,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)
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 load a document from a file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - The name of the file to load.<DD><CODE>scratchFile</CODE> - A location to store temp PDFBox data for this document.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.io.InputStream)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> input)
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 load a document from an input stream.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - The stream that contains the document.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="load(java.io.InputStream, org.pdfbox.io.RandomAccess)"><!-- --></A><H3>
load</H3>
<PRE>
public static <A HREF="../../../org/pdfbox/pdmodel/PDDocument.html" title="class in org.pdfbox.pdmodel">PDDocument</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> input,
<A HREF="../../../org/pdfbox/io/RandomAccess.html" title="interface in org.pdfbox.io">RandomAccess</A> scratchFile)
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 load a document from an input stream.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - The stream that contains the document.<DD><CODE>scratchFile</CODE> - A location to store temp PDFBox data for this document.
<DT><B>Returns:</B><DD>The document that was loaded.
<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 reading from the stream.</DL>
</DD>
</DL>
<HR>
<A NAME="save(java.lang.String)"><!-- --></A><H3>
save</H3>
<PRE>
public void <B>save</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> fileName)
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>,
<A HREF="../../../org/pdfbox/exceptions/COSVisitorException.html" title="class in org.pdfbox.exceptions">COSVisitorException</A></PRE>
<DL>
<DD>This will save this document to the filesystem.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The file to save as.
<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 saving the document.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/COSVisitorException.html" title="class in org.pdfbox.exceptions">COSVisitorException</A></CODE> - If an error occurs while generating the data.</DL>
</DD>
</DL>
<HR>
<A NAME="save(java.io.OutputStream)"><!-- --></A><H3>
save</H3>
<PRE>
public void <B>save</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> output)
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>,
<A HREF="../../../org/pdfbox/exceptions/COSVisitorException.html" title="class in org.pdfbox.exceptions">COSVisitorException</A></PRE>
<DL>
<DD>This will save the document to an output stream.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>output</CODE> - The stream to write to.
<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 writing the document.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/COSVisitorException.html" title="class in org.pdfbox.exceptions">COSVisitorException</A></CODE> - If an error occurs while generating the data.</DL>
</DD>
</DL>
<HR>
<A NAME="getPageCount()"><!-- --></A><H3>
getPageCount</H3>
<PRE>
public int <B>getPageCount</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use the getNumberOfPages method instead!</I>
<P>
<DD>This will return the total page count of the PDF document. Note: This method
is deprecated in favor of the getNumberOfPages method. The getNumberOfPages is
a required interface method of the Pageable interface. This method will
be removed in a future version of PDFBox!!
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The total number of pages in the PDF document.</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberOfPages()"><!-- --></A><H3>
getNumberOfPages</H3>
<PRE>
public int <B>getNumberOfPages</B>()</PRE>
<DL>
<DD>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html#getNumberOfPages()" title="class or interface in java.awt.print">getNumberOfPages</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPageFormat(int)"><!-- --></A><H3>
getPageFormat</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/PageFormat.html" title="class or interface in java.awt.print">PageFormat</A> <B>getPageFormat</B>(int pageIndex)</PRE>
<DL>
<DD>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html#getPageFormat(int)" title="class or interface in java.awt.print">getPageFormat</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPrintable(int)"><!-- --></A><H3>
getPrintable</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Printable.html" title="class or interface in java.awt.print">Printable</A> <B>getPrintable</B>(int pageIndex)</PRE>
<DL>
<DD>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html#getPrintable(int)" title="class or interface in java.awt.print">getPrintable</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/Pageable.html" title="class or interface in java.awt.print">Pageable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="print()"><!-- --></A><H3>
print</H3>
<PRE>
public void <B>print</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/PrinterException.html" title="class or interface in java.awt.print">PrinterException</A></PRE>
<DL>
<DD>This will send the PDF document to a printer. The printing functionality
depends on the org.pdfbox.pdfviewer.PageDrawer functionality. The PageDrawer
is a work in progress and some PDFs will print correctly and some will
not. This is a convenience method to create the java.awt.print.PrinterJob.
The PDDocument implements the java.awt.print.Pageable interface and
PDPage implementes the java.awt.print.Printable interface, so advanced printing
capabilities can be done by using those interfaces instead of this method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/PrinterException.html" title="class or interface in java.awt.print">PrinterException</A></CODE> - If there is an error while sending the PDF to
the printer, or you do not have permissions to print this document.</DL>
</DD>
</DL>
<HR>
<A NAME="silentPrint()"><!-- --></A><H3>
silentPrint</H3>
<PRE>
public void <B>silentPrint</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/PrinterException.html" title="class or interface in java.awt.print">PrinterException</A></PRE>
<DL>
<DD>This will send the PDF to the default printer without prompting the user
for any printer settings.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/awt/print/PrinterException.html" title="class or interface in java.awt.print">PrinterException</A></CODE> - If there is an error while printing.<DT><B>See Also:</B><DD><A HREF="../../../org/pdfbox/pdmodel/PDDocument.html#print()"><CODE>print()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</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 close the underlying COSDocument object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<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 releasing resources.</DL>
</DD>
</DL>
<HR>
<A NAME="protect(org.pdfbox.pdmodel.encryption.ProtectionPolicy)"><!-- --></A><H3>
protect</H3>
<PRE>
public void <B>protect</B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/ProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption">ProtectionPolicy</A> pp)
throws <A HREF="../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></PRE>
<DL>
<DD>Protects the document with the protection policy pp. The document content will be really encrypted
when it will be saved. This method only marks the document for encryption.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pp</CODE> - The protection policy.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></CODE> - If there is an error during protection.<DT><B>See Also:</B><DD><A HREF="../../../org/pdfbox/pdmodel/encryption/StandardProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption"><CODE>StandardProtectionPolicy</CODE></A>,
<A HREF="../../../org/pdfbox/pdmodel/encryption/PublicKeyProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption"><CODE>PublicKeyProtectionPolicy</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="openProtection(org.pdfbox.pdmodel.encryption.DecryptionMaterial)"><!-- --></A><H3>
openProtection</H3>
<PRE>
public void <B>openProtection</B>(<A HREF="../../../org/pdfbox/pdmodel/encryption/DecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption">DecryptionMaterial</A> pm)
throws <A HREF="../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A>,
<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>,
<A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></PRE>
<DL>
<DD>Tries to decrypt the document in memory using the provided decryption material.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pm</CODE> - The decryption material (password or certificate).
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></CODE> - If there is an error during decryption.
<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 reading cryptographic information.
<DD><CODE><A HREF="../../../org/pdfbox/exceptions/CryptographyException.html" title="class in org.pdfbox.exceptions">CryptographyException</A></CODE> - If there is an error during decryption.<DT><B>See Also:</B><DD><A HREF="../../../org/pdfbox/pdmodel/encryption/StandardDecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><CODE>StandardDecryptionMaterial</CODE></A>,
<A HREF="../../../org/pdfbox/pdmodel/encryption/PublicKeyDecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><CODE>PublicKeyDecryptionMaterial</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getCurrentAccessPermission()"><!-- --></A><H3>
getCurrentAccessPermission</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/encryption/AccessPermission.html" title="class in org.pdfbox.pdmodel.encryption">AccessPermission</A> <B>getCurrentAccessPermission</B>()</PRE>
<DL>
<DD>Returns the access permissions granted when the document was decrypted.
If the document was not decrypted this method returns the access permission
for a document owner (ie can do everything).
The returned object is in read only mode so that permissions cannot be changed.
Methods providing access to content should rely on this object to verify if the current
user is allowed to proceed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the access permissions for the current user on the document.</DL>
</DD>
</DL>
<HR>
<A NAME="getSecurityHandler()"><!-- --></A><H3>
getSecurityHandler</H3>
<PRE>
public <A HREF="../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A> <B>getSecurityHandler</B>()</PRE>
<DL>
<DD>Get the security handler that is used for document encryption.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The handler used to encrypt/decrypt the document.</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/PDDocument.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">
<A HREF="../../../org/pdfbox/pdmodel/PDDestinationNameTreeNode.html" title="class in org.pdfbox.pdmodel"><B>PREV CLASS</B></A>
<A HREF="../../../org/pdfbox/pdmodel/PDDocumentCatalog.html" title="class in org.pdfbox.pdmodel"><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="PDDocument.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>
|
