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
|
<!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:56 EDT 2006 -->
<TITLE>
AccessPermission (PDFBox-0.7.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.pdfbox.pdmodel.encryption.AccessPermission class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AccessPermission (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/AccessPermission.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/encryption/DecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><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="AccessPermission.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.encryption</FONT>
<BR>
Class AccessPermission</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.encryption.AccessPermission</B>
</PRE>
<HR>
<DL>
<DT>public class <B>AccessPermission</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></DL>
<P>
This class represents the access permissions to a document.
These permissions are specified in the PDF format specifications, they include:
<ul>
<li>print the document</li>
<li>modify the content of the document</li>
<li>copy or extract content of the document</li>
<li>add or modify annotations</li>
<li>fill in interactive form fields</li>
<li>extract text and graphics for accessibility to visually impaired people</li>
<li>assemble the document</li>
<li>print in degraded quality</li>
</ul>
This class can be used to protect a document by assigning access permissions to recipients.
In this case, it must be used with a specific ProtectionPolicy.
When a document is decrypted, it has a currentAccessPermission property which is the access permissions
granted to the user who decrypted the document.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.3 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>, Benoit Guillon (benoit.guillon@snv.jussieu.fr)</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../org/pdfbox/pdmodel/encryption/ProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption"><CODE>ProtectionPolicy</CODE></A>,
<A HREF="../../../../org/pdfbox/pdmodel/PDDocument.html#getCurrentAccessPermission()"><CODE>PDDocument.getCurrentAccessPermission()</CODE></A></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/encryption/AccessPermission.html#AccessPermission()">AccessPermission</A></B>()</CODE>
<BR>
Create a new access permission object.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/AccessPermission.html#AccessPermission(byte[])">AccessPermission</A></B>(byte[] b)</CODE>
<BR>
Create a new access permission object from a byte array.
</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/AccessPermission.html#canAssembleDocument()">canAssembleDocument</A></B>()</CODE>
<BR>
This will tell if the user can insert/rotate/delete pages.</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/encryption/AccessPermission.html#canExtractContent()">canExtractContent</A></B>()</CODE>
<BR>
This will tell if the user can extract text and images from the PDF 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/encryption/AccessPermission.html#canExtractForAccessibility()">canExtractForAccessibility</A></B>()</CODE>
<BR>
This will tell if the user can extract text and images from the PDF document
for accessibility purposes.</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/encryption/AccessPermission.html#canFillInForm()">canFillInForm</A></B>()</CODE>
<BR>
This will tell if the user can fill in interactive forms.</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/encryption/AccessPermission.html#canModify()">canModify</A></B>()</CODE>
<BR>
This will tell if the user can modify contents of 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/encryption/AccessPermission.html#canModifyAnnotations()">canModifyAnnotations</A></B>()</CODE>
<BR>
This will tell if the user can add/modify text annotations, fill in interactive forms fields.</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/encryption/AccessPermission.html#canPrint()">canPrint</A></B>()</CODE>
<BR>
This will tell if the user can print.</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/encryption/AccessPermission.html#canPrintDegraded()">canPrintDegraded</A></B>()</CODE>
<BR>
This will tell if the user can print the document in a degraded format.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <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/encryption/AccessPermission.html#getOwnerAccessPermission()">getOwnerAccessPermission</A></B>()</CODE>
<BR>
returns an access permission object for a document owner.</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/encryption/AccessPermission.html#getPermissionBytes()">getPermissionBytes</A></B>()</CODE>
<BR>
The returns an integer representing the access permissions.
</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/encryption/AccessPermission.html#getPermissionBytesForPublicKey()">getPermissionBytesForPublicKey</A></B>()</CODE>
<BR>
This returns an integer representing the access permissions.
</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/encryption/AccessPermission.html#isOwnerPermission()">isOwnerPermission</A></B>()</CODE>
<BR>
This will tell if the access permission corresponds to owner
access permission (no restriction).</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/encryption/AccessPermission.html#isReadOnly()">isReadOnly</A></B>()</CODE>
<BR>
This will tell if the object has been set as read only.</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/encryption/AccessPermission.html#setCanAssembleDocument(boolean)">setCanAssembleDocument</A></B>(boolean allowAssembly)</CODE>
<BR>
Set if the user can insert/rotate/delete pages.
</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/encryption/AccessPermission.html#setCanExtractContent(boolean)">setCanExtractContent</A></B>(boolean allowExtraction)</CODE>
<BR>
Set if the user can extract content 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/encryption/AccessPermission.html#setCanExtractForAccessibility(boolean)">setCanExtractForAccessibility</A></B>(boolean allowExtraction)</CODE>
<BR>
Set if the user can extract content from the document for accessibility purposes.
</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/encryption/AccessPermission.html#setCanFillInForm(boolean)">setCanFillInForm</A></B>(boolean allowFillingInForm)</CODE>
<BR>
Set if the user can fill in interactive 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/encryption/AccessPermission.html#setCanModify(boolean)">setCanModify</A></B>(boolean allowModifications)</CODE>
<BR>
Set if the user can modify 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/encryption/AccessPermission.html#setCanModifyAnnotations(boolean)">setCanModifyAnnotations</A></B>(boolean allowAnnotationModification)</CODE>
<BR>
Set if the user can modify annotations.
</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/encryption/AccessPermission.html#setCanPrint(boolean)">setCanPrint</A></B>(boolean allowPrinting)</CODE>
<BR>
Set if the user can print.
</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/encryption/AccessPermission.html#setCanPrintDegraded(boolean)">setCanPrintDegraded</A></B>(boolean allowAssembly)</CODE>
<BR>
Set if the user can print the document in a degraded format.
</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/encryption/AccessPermission.html#setReadOnly()">setReadOnly</A></B>()</CODE>
<BR>
Locks the access permission read only (ie, the setters will have no effects).
</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="AccessPermission(byte[])"><!-- --></A><H3>
AccessPermission</H3>
<PRE>
public <B>AccessPermission</B>(byte[] b)</PRE>
<DL>
<DD>Create a new access permission object from a byte array.
Bytes are ordered most significant byte first.
<P>
<DT><B>Parameters:</B><DD><CODE>b</CODE> - the bytes as defined in PDF specs</DL>
<HR>
<A NAME="AccessPermission()"><!-- --></A><H3>
AccessPermission</H3>
<PRE>
public <B>AccessPermission</B>()</PRE>
<DL>
<DD>Create a new access permission object.
By default, all permissions are granted.
<P>
</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="isOwnerPermission()"><!-- --></A><H3>
isOwnerPermission</H3>
<PRE>
public boolean <B>isOwnerPermission</B>()</PRE>
<DL>
<DD>This will tell if the access permission corresponds to owner
access permission (no restriction).
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the access permission does not restrict the use of the document</DL>
</DD>
</DL>
<HR>
<A NAME="getOwnerAccessPermission()"><!-- --></A><H3>
getOwnerAccessPermission</H3>
<PRE>
public static <A HREF="../../../../org/pdfbox/pdmodel/encryption/AccessPermission.html" title="class in org.pdfbox.pdmodel.encryption">AccessPermission</A> <B>getOwnerAccessPermission</B>()</PRE>
<DL>
<DD>returns an access permission object for a document owner.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A standard owner access permission set.</DL>
</DD>
</DL>
<HR>
<A NAME="getPermissionBytesForPublicKey()"><!-- --></A><H3>
getPermissionBytesForPublicKey</H3>
<PRE>
public int <B>getPermissionBytesForPublicKey</B>()</PRE>
<DL>
<DD>This returns an integer representing the access permissions.
This integer can be used for public key encryption. This format
is not documented in the PDF specifications but is necessary for compatibility
with Adobe Acrobat and Adobe Reader.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the integer representing access permissions</DL>
</DD>
</DL>
<HR>
<A NAME="getPermissionBytes()"><!-- --></A><H3>
getPermissionBytes</H3>
<PRE>
public int <B>getPermissionBytes</B>()</PRE>
<DL>
<DD>The returns an integer representing the access permissions.
This integer can be used for standard PDF encryption as specified
in the PDF specifications.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the integer representing the access permissions</DL>
</DD>
</DL>
<HR>
<A NAME="canPrint()"><!-- --></A><H3>
canPrint</H3>
<PRE>
public boolean <B>canPrint</B>()</PRE>
<DL>
<DD>This will tell if the user can print.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to print.</DL>
</DD>
</DL>
<HR>
<A NAME="setCanPrint(boolean)"><!-- --></A><H3>
setCanPrint</H3>
<PRE>
public void <B>setCanPrint</B>(boolean allowPrinting)</PRE>
<DL>
<DD>Set if the user can print.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowPrinting</CODE> - A boolean determining if the user can print.</DL>
</DD>
</DL>
<HR>
<A NAME="canModify()"><!-- --></A><H3>
canModify</H3>
<PRE>
public boolean <B>canModify</B>()</PRE>
<DL>
<DD>This will tell if the user can modify contents of the document.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to modify the document</DL>
</DD>
</DL>
<HR>
<A NAME="setCanModify(boolean)"><!-- --></A><H3>
setCanModify</H3>
<PRE>
public void <B>setCanModify</B>(boolean allowModifications)</PRE>
<DL>
<DD>Set if the user can modify the document.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowModifications</CODE> - A boolean determining if the user can modify the document.</DL>
</DD>
</DL>
<HR>
<A NAME="canExtractContent()"><!-- --></A><H3>
canExtractContent</H3>
<PRE>
public boolean <B>canExtractContent</B>()</PRE>
<DL>
<DD>This will tell if the user can extract text and images from the PDF document.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to extract content
from the PDF document</DL>
</DD>
</DL>
<HR>
<A NAME="setCanExtractContent(boolean)"><!-- --></A><H3>
setCanExtractContent</H3>
<PRE>
public void <B>setCanExtractContent</B>(boolean allowExtraction)</PRE>
<DL>
<DD>Set if the user can extract content from the document.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowExtraction</CODE> - A boolean determining if the user can extract content
from the document.</DL>
</DD>
</DL>
<HR>
<A NAME="canModifyAnnotations()"><!-- --></A><H3>
canModifyAnnotations</H3>
<PRE>
public boolean <B>canModifyAnnotations</B>()</PRE>
<DL>
<DD>This will tell if the user can add/modify text annotations, fill in interactive forms fields.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to modify annotations.</DL>
</DD>
</DL>
<HR>
<A NAME="setCanModifyAnnotations(boolean)"><!-- --></A><H3>
setCanModifyAnnotations</H3>
<PRE>
public void <B>setCanModifyAnnotations</B>(boolean allowAnnotationModification)</PRE>
<DL>
<DD>Set if the user can modify annotations.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowAnnotationModification</CODE> - A boolean determining if the user can modify annotations.</DL>
</DD>
</DL>
<HR>
<A NAME="canFillInForm()"><!-- --></A><H3>
canFillInForm</H3>
<PRE>
public boolean <B>canFillInForm</B>()</PRE>
<DL>
<DD>This will tell if the user can fill in interactive forms.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to fill in form fields.</DL>
</DD>
</DL>
<HR>
<A NAME="setCanFillInForm(boolean)"><!-- --></A><H3>
setCanFillInForm</H3>
<PRE>
public void <B>setCanFillInForm</B>(boolean allowFillingInForm)</PRE>
<DL>
<DD>Set if the user can fill in interactive forms.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowFillingInForm</CODE> - A boolean determining if the user can fill in interactive forms.</DL>
</DD>
</DL>
<HR>
<A NAME="canExtractForAccessibility()"><!-- --></A><H3>
canExtractForAccessibility</H3>
<PRE>
public boolean <B>canExtractForAccessibility</B>()</PRE>
<DL>
<DD>This will tell if the user can extract text and images from the PDF document
for accessibility purposes.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to extract content
from the PDF document</DL>
</DD>
</DL>
<HR>
<A NAME="setCanExtractForAccessibility(boolean)"><!-- --></A><H3>
setCanExtractForAccessibility</H3>
<PRE>
public void <B>setCanExtractForAccessibility</B>(boolean allowExtraction)</PRE>
<DL>
<DD>Set if the user can extract content from the document for accessibility purposes.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowExtraction</CODE> - A boolean determining if the user can extract content
from the document.</DL>
</DD>
</DL>
<HR>
<A NAME="canAssembleDocument()"><!-- --></A><H3>
canAssembleDocument</H3>
<PRE>
public boolean <B>canAssembleDocument</B>()</PRE>
<DL>
<DD>This will tell if the user can insert/rotate/delete pages.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to extract content
from the PDF document</DL>
</DD>
</DL>
<HR>
<A NAME="setCanAssembleDocument(boolean)"><!-- --></A><H3>
setCanAssembleDocument</H3>
<PRE>
public void <B>setCanAssembleDocument</B>(boolean allowAssembly)</PRE>
<DL>
<DD>Set if the user can insert/rotate/delete pages.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowAssembly</CODE> - A boolean determining if the user can assemble the document.</DL>
</DD>
</DL>
<HR>
<A NAME="canPrintDegraded()"><!-- --></A><H3>
canPrintDegraded</H3>
<PRE>
public boolean <B>canPrintDegraded</B>()</PRE>
<DL>
<DD>This will tell if the user can print the document in a degraded format.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true If supplied with the user password they are allowed to print the
document in a degraded format.</DL>
</DD>
</DL>
<HR>
<A NAME="setCanPrintDegraded(boolean)"><!-- --></A><H3>
setCanPrintDegraded</H3>
<PRE>
public void <B>setCanPrintDegraded</B>(boolean allowAssembly)</PRE>
<DL>
<DD>Set if the user can print the document in a degraded format.
This method will have no effect if the object is in read only mode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowAssembly</CODE> - A boolean determining if the user can print the
document in a degraded format.</DL>
</DD>
</DL>
<HR>
<A NAME="setReadOnly()"><!-- --></A><H3>
setReadOnly</H3>
<PRE>
public void <B>setReadOnly</B>()</PRE>
<DL>
<DD>Locks the access permission read only (ie, the setters will have no effects).
After that, the object cannot be unlocked.
This method is used for the currentAccessPermssion of a document to avoid
users to change access permission.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
public boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD>This will tell if the object has been set as read only.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the object is in read only mode.</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/AccessPermission.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/encryption/DecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><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="AccessPermission.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>
|
