public
class
implements AutoCloseable
PrinterMode
extends Objectimplements AutoCloseable
| java.lang.Object | |
| ↳ | com.pdftron.pdf.PrinterMode |
Class Overview
PrinterMode is a utility class used to set printer options for printing PDF documents.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
PrinterMode()
Instantiates a new printer mode.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| long | __GetHandle() | ||||||||||
| void |
close()
Frees the native memory of the object.
| ||||||||||
| void |
destroy()
Frees the native memory of the object.
| ||||||||||
| void |
setAutoCenter(boolean autoCenter)
Set automatic centering of document pages onto the output pages.
| ||||||||||
| void |
setAutoRotate(boolean autoRotate)
Set automatic rotation of document pages to best fit the output pages.
| ||||||||||
| void |
setCollation(boolean collation)
Set the collation of the printing, useful for multiple copies.
| ||||||||||
| void |
setCopyCount(int copyCount)
Set the number of copies to be printed.
| ||||||||||
| void |
setDPI(int dpi)
Set the DPI (dots per inch) of the printing.
| ||||||||||
| void |
setDuplexing(int mode)
Set the duplexing mode.
| ||||||||||
| void |
setNUp(int nup, int pageOrder)
Set the number of document pages to place on the output pages across and
vertically.
| ||||||||||
| void |
setNUp(int x, int y, int pageOrder)
Set the number of document pages to place on the output pages across and
vertically.
| ||||||||||
| void |
setOrientation(int orientation)
Set the orientation of the output document.
| ||||||||||
| void |
setOutputAnnot(int printContent)
Set the printing of annotations.
| ||||||||||
| void |
setOutputColor(int color)
Set the color output of the printing.
| ||||||||||
| void |
setOutputPageBorder(boolean printBorder)
Set the printing of page borders, helpful when printing multiple document
pages per output page.
| ||||||||||
| void |
setOutputQuality(int quality)
Set the quality of the printing.
| ||||||||||
| void |
setPaperSize(Rect size)
Set the output printer paper size (assumed to be correct).
| ||||||||||
| void | setPaperSize(int paperSize) | ||||||||||
| void |
setScale(double scale)
Set the scaling of the document pages to the output pages.
| ||||||||||
| void |
setScaleType(int scaleType)
Set the scaling of the document page to the output pages.
| ||||||||||
| void |
setUseRleImageCompression(boolean useRleImageCompression)
Set whether RLE image compression is used for printing bitmaps.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.AutoCloseable
| |||||||||||
Constants
public static final int e_10x11
Constant Value:
45
(0x0000002d)
public static final int e_10x14
Constant Value:
16
(0x00000010)
public static final int e_11x17
Constant Value:
17
(0x00000011)
public static final int e_12x11
Constant Value:
89
(0x00000059)
public static final int e_15x11
Constant Value:
46
(0x0000002e)
public static final int e_6_3_Quarters_Envelope
Constant Value:
38
(0x00000026)
public static final int e_9x11
Constant Value:
44
(0x0000002c)
public static final int e_A2
Constant Value:
66
(0x00000042)
public static final int e_A3
Constant Value:
8
(0x00000008)
public static final int e_A3_Extra
Constant Value:
63
(0x0000003f)
public static final int e_A3_Extra_Transverse
Constant Value:
67
(0x00000043)
public static final int e_A3_Rotated
Constant Value:
75
(0x0000004b)
public static final int e_A3_Transverse
Constant Value:
66
(0x00000042)
public static final int e_A4
Constant Value:
9
(0x00000009)
public static final int e_A4_Extra
Constant Value:
53
(0x00000035)
public static final int e_A4_Plus
Constant Value:
60
(0x0000003c)
public static final int e_A4_Rotated
Constant Value:
76
(0x0000004c)
public static final int e_A4_Small
Constant Value:
10
(0x0000000a)
public static final int e_A4_Transverse
Constant Value:
55
(0x00000037)
public static final int e_A5
Constant Value:
11
(0x0000000b)
public static final int e_A5_Extra
Constant Value:
64
(0x00000040)
public static final int e_A5_Rotated
Constant Value:
77
(0x0000004d)
public static final int e_A5_Transverse
Constant Value:
61
(0x0000003d)
public static final int e_A6
Constant Value:
69
(0x00000045)
public static final int e_A6_Rotated
Constant Value:
82
(0x00000052)
public static final int e_B4_ISO
Constant Value:
42
(0x0000002a)
public static final int e_B4_JIS
Constant Value:
12
(0x0000000c)
public static final int e_B4_JIS_Rotated
Constant Value:
78
(0x0000004e)
public static final int e_B5_ISO_Extra
Constant Value:
65
(0x00000041)
public static final int e_B5_JIS
Constant Value:
13
(0x0000000d)
public static final int e_B5_JIS_Rotated
Constant Value:
79
(0x0000004f)
public static final int e_B5_JIS_Transverse
Constant Value:
62
(0x0000003e)
public static final int e_B6_JIS
Constant Value:
87
(0x00000057)
public static final int e_B6_JIS_Rotated
Constant Value:
88
(0x00000058)
public static final int e_C_Size_Sheet
Constant Value:
24
(0x00000018)
public static final int e_Custom
Constant Value:
0
(0x00000000)
public static final int e_D_Size_Sheet
Constant Value:
25
(0x00000019)
public static final int e_Double_Japanese_Postcard_Rotated
Constant Value:
81
(0x00000051)
public static final int e_Duplex_Auto
The Constant e_Duplex_Auto.
Constant Value:
0
(0x00000000)
public static final int e_Duplex_LongSide
The Constant e_Duplex_LongSide.
Constant Value:
2
(0x00000002)
public static final int e_Duplex_None
The Constant e_Duplex_None.
Constant Value:
1
(0x00000001)
public static final int e_Duplex_ShortSide
The Constant e_Duplex_ShortSide.
Constant Value:
3
(0x00000003)
public static final int e_E_Size_Sheet
Constant Value:
26
(0x0000001a)
public static final int e_Envelope_10
Constant Value:
20
(0x00000014)
public static final int e_Envelope_11
Constant Value:
21
(0x00000015)
public static final int e_Envelope_12
Constant Value:
22
(0x00000016)
public static final int e_Envelope_14
Constant Value:
23
(0x00000017)
public static final int e_Envelope_9
Constant Value:
19
(0x00000013)
public static final int e_Envelope_B4
Constant Value:
33
(0x00000021)
public static final int e_Envelope_B5
Constant Value:
34
(0x00000022)
public static final int e_Envelope_B6
Constant Value:
35
(0x00000023)
public static final int e_Envelope_C3
Constant Value:
29
(0x0000001d)
public static final int e_Envelope_C4
Constant Value:
30
(0x0000001e)
public static final int e_Envelope_C5
Constant Value:
28
(0x0000001c)
public static final int e_Envelope_C6
Constant Value:
31
(0x0000001f)
public static final int e_Envelope_C65
Constant Value:
32
(0x00000020)
public static final int e_Envelope_DL
Constant Value:
27
(0x0000001b)
public static final int e_Envelope_Invite
Constant Value:
47
(0x0000002f)
public static final int e_Envelope_Italy
Constant Value:
36
(0x00000024)
public static final int e_Envelope_Monarch
Constant Value:
37
(0x00000025)
public static final int e_Executive
Constant Value:
7
(0x00000007)
public static final int e_Folio
Constant Value:
14
(0x0000000e)
public static final int e_German_Legal_Fanfold
Constant Value:
41
(0x00000029)
public static final int e_German_Std_Fanfold
Constant Value:
40
(0x00000028)
public static final int e_Japanese_Double_Postcard
Constant Value:
68
(0x00000044)
public static final int e_Japanese_Envelope_Kaku_2
Constant Value:
70
(0x00000046)
public static final int e_Japanese_Envelope_Kaku_2_Rotated
Constant Value:
83
(0x00000053)
public static final int e_Japanese_Envelope_Kaku_3
Constant Value:
71
(0x00000047)
public static final int e_Japanese_Envelope_Kaku_3_Rotated
Constant Value:
84
(0x00000054)
public static final int e_Japanese_Envelope_You_4
Constant Value:
90
(0x0000005a)
public static final int e_Japanese_Envelope_You_4_Rotated
Constant Value:
91
(0x0000005b)
public static final int e_Japanese_Envelope_chou_3
Constant Value:
72
(0x00000048)
public static final int e_Japanese_Envelope_chou_3_Rotated
Constant Value:
85
(0x00000055)
public static final int e_Japanese_Envelope_chou_4
Constant Value:
73
(0x00000049)
public static final int e_Japanese_Envelope_chou_4_Rotated
Constant Value:
86
(0x00000056)
public static final int e_Japanese_Postcard
Constant Value:
43
(0x0000002b)
public static final int e_Japanese_Postcard_Rotated
Constant Value:
80
(0x00000050)
public static final int e_Ledger
Constant Value:
4
(0x00000004)
public static final int e_Legal
Constant Value:
5
(0x00000005)
public static final int e_Legal_Extra
Constant Value:
51
(0x00000033)
public static final int e_Letter
Constant Value:
1
(0x00000001)
public static final int e_Letter_Extra
Constant Value:
50
(0x00000032)
public static final int e_Letter_Extra_Transverse
Constant Value:
56
(0x00000038)
public static final int e_Letter_Plus
Constant Value:
59
(0x0000003b)
public static final int e_Letter_Rotated
Constant Value:
74
(0x0000004a)
public static final int e_Letter_Small
Constant Value:
2
(0x00000002)
public static final int e_Letter_Transverse
Constant Value:
54
(0x00000036)
public static final int e_NUp_1_1
The Constant e_NUp_1_1.
Constant Value:
0
(0x00000000)
public static final int e_NUp_2_1
The Constant e_NUp_2_1.
Constant Value:
1
(0x00000001)
public static final int e_NUp_2_2
The Constant e_NUp_2_2.
Constant Value:
2
(0x00000002)
public static final int e_NUp_3_2
The Constant e_NUp_3_2.
Constant Value:
3
(0x00000003)
public static final int e_NUp_3_3
The Constant e_NUp_3_3.
Constant Value:
4
(0x00000004)
public static final int e_NUp_4_4
The Constant e_NUp_4_4.
Constant Value:
5
(0x00000005)
public static final int e_Note
Constant Value:
18
(0x00000012)
public static final int e_Orientation_Landscape
The Constant e_Orientation_Landscape.
Constant Value:
1
(0x00000001)
public static final int e_Orientation_Portrait
The Constant e_Orientation_Portrait.
Constant Value:
0
(0x00000000)
public static final int e_OutputColor_Color
The Constant e_OutputColor_Color.
Constant Value:
0
(0x00000000)
public static final int e_OutputColor_Grayscale
The Constant e_OutputColor_Grayscale.
Constant Value:
1
(0x00000001)
public static final int e_OutputColor_Monochrome
The Constant e_OutputColor_Monochrome.
Constant Value:
2
(0x00000002)
public static final int e_OutputQuality_Draft
The Constant e_OutputQuality_Draft.
Constant Value:
-1
(0xffffffff)
public static final int e_OutputQuality_High
The Constant e_OutputQuality_High.
Constant Value:
-4
(0xfffffffc)
public static final int e_OutputQuality_Low
The Constant e_OutputQuality_Low.
Constant Value:
-2
(0xfffffffe)
public static final int e_OutputQuality_Medium
The Constant e_OutputQuality_Medium.
Constant Value:
-3
(0xfffffffd)
public static final int e_PRC_16k
Constant Value:
92
(0x0000005c)
public static final int e_PRC_16k_Rotated
Constant Value:
105
(0x00000069)
public static final int e_PRC_32k
Constant Value:
93
(0x0000005d)
public static final int e_PRC_32k_Big
Constant Value:
94
(0x0000005e)
public static final int e_PRC_32k_Big__Rotated
Constant Value:
107
(0x0000006b)
public static final int e_PRC_32k_Rotated
Constant Value:
106
(0x0000006a)
public static final int e_PRC_Envelop_1
Constant Value:
95
(0x0000005f)
public static final int e_PRC_Envelop_10
Constant Value:
104
(0x00000068)
public static final int e_PRC_Envelop_10_Rotated
Constant Value:
117
(0x00000075)
public static final int e_PRC_Envelop_1_Rotated
Constant Value:
108
(0x0000006c)
public static final int e_PRC_Envelop_2
Constant Value:
96
(0x00000060)
public static final int e_PRC_Envelop_2_Rotated
Constant Value:
109
(0x0000006d)
public static final int e_PRC_Envelop_3
Constant Value:
97
(0x00000061)
public static final int e_PRC_Envelop_3_Rotated
Constant Value:
110
(0x0000006e)
public static final int e_PRC_Envelop_4
Constant Value:
98
(0x00000062)
public static final int e_PRC_Envelop_4_Rotated
Constant Value:
111
(0x0000006f)
public static final int e_PRC_Envelop_5
Constant Value:
99
(0x00000063)
public static final int e_PRC_Envelop_5_Rotated
Constant Value:
112
(0x00000070)
public static final int e_PRC_Envelop_6
Constant Value:
100
(0x00000064)
public static final int e_PRC_Envelop_6_Rotated
Constant Value:
113
(0x00000071)
public static final int e_PRC_Envelop_7
Constant Value:
101
(0x00000065)
public static final int e_PRC_Envelop_7_Rotated
Constant Value:
114
(0x00000072)
public static final int e_PRC_Envelop_8
Constant Value:
102
(0x00000066)
public static final int e_PRC_Envelop_8_Rotated
Constant Value:
115
(0x00000073)
public static final int e_PRC_Envelop_9
Constant Value:
103
(0x00000067)
public static final int e_PRC_Envelop_9_Rotated
Constant Value:
116
(0x00000074)
public static final int e_PageOrder_BottomToTopThenLeftToRight
The Constant e_PageOrder_BottomToTopThenLeftToRight.
Constant Value:
3
(0x00000003)
public static final int e_PageOrder_LeftToRightThenTopToBottom
The Constant e_PageOrder_LeftToRightThenTopToBottom.
Constant Value:
0
(0x00000000)
public static final int e_PageOrder_RightToLeftThenTopToBottom
The Constant e_PageOrder_RightToLeftThenTopToBottom.
Constant Value:
1
(0x00000001)
public static final int e_PageOrder_TopToBottomThenLeftToRight
The Constant e_PageOrder_TopToBottomThenLeftToRight.
Constant Value:
2
(0x00000002)
public static final int e_PrintContent_DocumentAndAnnotations
The Constant e_PrintContent_DocumentAndAnnotations.
Constant Value:
1
(0x00000001)
public static final int e_PrintContent_DocumentAnnotationsAndComments
The Constant e_PrintContent_DocumentAnnotationsAndComments.
Constant Value:
2
(0x00000002)
public static final int e_PrintContent_DocumentOnly
The Constant e_PrintContent_DocumentOnly.
Constant Value:
0
(0x00000000)
public static final int e_Quarto
Constant Value:
15
(0x0000000f)
public static final int e_Reserved_48
Constant Value:
48
(0x00000030)
public static final int e_Reserved_49
Constant Value:
49
(0x00000031)
public static final int e_ScaleType_FitToOutputPage
The Constant e_ScaleType_FitToOutputPage.
Constant Value:
1
(0x00000001)
public static final int e_ScaleType_None
The Constant e_ScaleType_None.
Constant Value:
0
(0x00000000)
public static final int e_ScaleType_ReduceToOutputPage
The Constant e_ScaleType_ReduceToOutputPage.
Constant Value:
2
(0x00000002)
public static final int e_Statement
Constant Value:
6
(0x00000006)
public static final int e_Supera_Supera_A4
Constant Value:
57
(0x00000039)
public static final int e_Superb_Superb_A3
Constant Value:
58
(0x0000003a)
public static final int e_Tabloid
Constant Value:
3
(0x00000003)
public static final int e_Tabloid_Extra
Constant Value:
52
(0x00000034)
public static final int e_US_Std_Fanfold
Constant Value:
39
(0x00000027)
Public Constructors
Public Methods
public long __GetHandle ()
public void close ()
Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.
Throws
| PDFNetException |
|---|
public void destroy ()
Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.
public void setAutoCenter (boolean autoCenter)
Set automatic centering of document pages onto the output pages.
Parameters
| autoCenter | if true will center document pages onto the output pages. Default is true. |
|---|
Throws
| PDFNetException |
|---|
public void setAutoRotate (boolean autoRotate)
Set automatic rotation of document pages to best fit the output pages.
Parameters
| autoRotate | if true will rotate document pages onto the output pages. Default is true. |
|---|
Throws
| PDFNetException |
|---|
public void setCollation (boolean collation)
Set the collation of the printing, useful for multiple copies.
Parameters
| collation | if true, pages of copies will be printed 1, 2, 3. if false, then pages of copies will be printed 1, 1, 1, ..., 2, 2, 2, ... |
|---|
Throws
| PDFNetException |
|---|
public void setCopyCount (int copyCount)
Set the number of copies to be printed.
Parameters
| copyCount | the number of copies to be printed, must be greater than zero |
|---|
Throws
| PDFNetException |
|---|
public void setDPI (int dpi)
public void setDuplexing (int mode)
public void setNUp (int nup, int pageOrder)
Set the number of document pages to place on the output pages across and vertically. Pages will be automatically rotated to best fit the page.
Parameters
| nup | one of {e_NUp_1_1, e_NUp_2_1, e_NUp_2_2, e_NUp_3_2, e_NUp_3_3, e_NUp_4_4}. Default is e_NUp_1_1. |
|---|---|
| pageOrder | order of document pages across and down output page. Default is e_PageOrder_LeftToRightThenTopToBottom. |
Throws
| PDFNetException |
|---|
public void setNUp (int x, int y, int pageOrder)
Set the number of document pages to place on the output pages across and vertically. Pages will be automatically rotated to best fit the page. Typical values: (2,1) 2-up; (2,2) 4 per page, etc
Parameters
| x | number of document pages across. Default is 1. |
|---|---|
| y | number of document pages down. Default is 1. |
| pageOrder | order of document pages across and down output page Default is e_PageOrder_LeftToRightThenTopToBottom. |
Throws
| PDFNetException |
|---|
public void setOrientation (int orientation)
Set the orientation of the output document.
Parameters
| orientation | {e_Orientation_Portrait, e_Orientation_Landscape} Default is e_Orientation_Portrait. |
|---|
Throws
| PDFNetException |
|---|
public void setOutputAnnot (int printContent)
Set the printing of annotations.
Parameters
| printContent | one of {e_PrintContent_DocumentOnly, e_PrintContent_DocumentAndAnnotations}. Default is e_PrintContent_DocumentAndAnnotations. |
|---|
Throws
| PDFNetException |
|---|
public void setOutputColor (int color)
public void setOutputPageBorder (boolean printBorder)
Set the printing of page borders, helpful when printing multiple document pages per output page.
Parameters
| printBorder | if true will add a thin frame around each page border. Default is false. |
|---|
Throws
| PDFNetException |
|---|
public void setOutputQuality (int quality)
Set the quality of the printing. Overridden if SetDPI is called.
Parameters
| quality | the new output quality |
|---|
Throws
| PDFNetException |
|---|
public void setPaperSize (Rect size)
Set the output printer paper size (assumed to be correct).
Parameters
| size | the size of the output paper size in points (72 points = 1 inch). Default is US Letter or Rect(0, 0, 612, 792) |
|---|
Throws
| PDFNetException |
|---|
public void setScale (double scale)
Set the scaling of the document pages to the output pages. Causes SetScaleType(e_ScaleType_CustomScale) to be set.
Parameters
| scale | to apply to document pages. 1.0 is no scale, greater than 1.0 increases document page sizes, less than 1.0 reduces document pages sizes on output pages. Default is 1.0 |
|---|
Throws
| PDFNetException |
|---|
public void setScaleType (int scaleType)
Set the scaling of the document page to the output pages.
Parameters
| scaleType | one of {e_ScaleType_None, e_ScaleType_FitToOutputPage, e_ScaleType_ReduceToOutputPage}. Default is e_ScaleType_None. |
|---|
Throws
| PDFNetException |
|---|
public void setUseRleImageCompression (boolean useRleImageCompression)
Set whether RLE image compression is used for printing bitmaps.
Parameters
| useRleImageCompression | if true, printer spool file will be reduced. However, some printers do not support this type of image compression and will produce blank pages. Default is false |
|---|
Throws
| PDFNetException |
|---|