KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > interfaces > PdfViewerPreferences


1 /*
2  * $Id: PdfViewerPreferences.java 2678 2007-04-10 08:59:39Z blowagie $
3  *
4  * Copyright 2006 Bruno Lowagie
5  *
6  * The contents of this file are subject to the Mozilla Public License Version 1.1
7  * (the "License"); you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the License.
13  *
14  * The Original Code is 'iText, a free JAVA-PDF library'.
15  *
16  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18  * All Rights Reserved.
19  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source code
23  * where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34  *
35  * This library is free software; you can redistribute it and/or modify it
36  * under the terms of the MPL as stated above or under the terms of the GNU
37  * Library General Public License as published by the Free Software Foundation;
38  * either version 2 of the License, or any later version.
39  *
40  * This library is distributed in the hope that it will be useful, but WITHOUT
41  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43  * details.
44  *
45  * If you didn't download this code from the following link, you should check if
46  * you aren't using an obsolete version:
47  * http://www.lowagie.com/iText/
48  */
49
50 package com.lowagie.text.pdf.interfaces;
51
52 import com.lowagie.text.pdf.PdfName;
53 import com.lowagie.text.pdf.PdfObject;
54
55 /**
56  * Viewer preferences are described in section 3.6.1 and 8.1 of the
57  * PDF Reference 1.7 (Table 3.25 on p139-142 and Table 8.1 on p579-581).
58  * They are explained in section 13.1 of the book 'iText in Action'.
59  * The values of the different preferences were originally stored
60  * in class PdfWriter, but they have been moved to this separate interface
61  * for reasons of convenience.
62  */
63
64 public interface PdfViewerPreferences {
65         
66     /**
67      * Sets the page layout and page mode preferences by ORing one or two of these constants.
68      * <p>
69      * <ul>
70      * <li>The page layout to be used when the document is opened (choose one).
71      * <ul>
72      * <li><b>PageLayoutSinglePage</b> - Display one page at a time. (default)
73      * <li><b>PageLayoutOneColumn</b> - Display the pages in one column.
74      * <li><b>PageLayoutTwoColumnLeft</b> - Display the pages in two columns, with
75      * oddnumbered pages on the left.
76      * <li><b>PageLayoutTwoColumnRight</b> - Display the pages in two columns, with
77      * oddnumbered pages on the right.
78      * <li><b>PageLayoutTwoPageLeft</b> - Display the pages two at a time, with
79      * oddnumbered pages on the left.
80      * <li><b>PageLayoutTwoPageRight</b> - Display the pages two at a time, with
81      * oddnumbered pages on the right.
82      * </ul>
83      * <li>The page mode how the document should be displayed
84      * when opened (choose one).
85      * <ul>
86      * <li><b>PageModeUseNone</b> - Neither document outline nor thumbnail images visible. (default)
87      * <li><b>PageModeUseOutlines</b> - Document outline visible.
88      * <li><b>PageModeUseThumbs</b> - Thumbnail images visible.
89      * <li><b>PageModeFullScreen</b> - Full-screen mode, with no menu bar, window
90      * controls, or any other window visible.
91      * <li><b>PageModeUseOC</b> - Optional content group panel visible
92      * <li><b>PageModeUseAttachments</b> - Attachments panel visible
93      * </ul>
94      * </ul>
95      * For backward compatibility these values are also supported,
96      * but it's better to use method <code>addViewerPreference(key, value)</code>
97      * if you want to change the following preferences:
98      * <ul>
99      * <li><b>HideToolbar</b> - A flag specifying whether to hide the viewer application's tool
100      * bars when the document is active.
101      * <li><b>HideMenubar</b> - A flag specifying whether to hide the viewer application's
102      * menu bar when the document is active.
103      * <li><b>HideWindowUI</b> - A flag specifying whether to hide user interface elements in
104      * the document's window (such as scroll bars and navigation controls),
105      * leaving only the document's contents displayed.
106      * <li><b>FitWindow</b> - A flag specifying whether to resize the document's window to
107      * fit the size of the first displayed page.
108      * <li><b>CenterWindow</b> - A flag specifying whether to position the document's window
109      * in the center of the screen.
110      * <li><b>DisplayDocTitle</b> - A flag specifying whether to display the document's title
111      * in the top bar.
112      * <li>The predominant reading order for text. This entry has no direct effect on the
113      * document's contents or page numbering, but can be used to determine the relative
114      * positioning of pages when displayed side by side or printed <i>n-up</i> (choose one).
115      * <ul>
116      * <li><b>DirectionL2R</b> - Left to right
117      * <li><b>DirectionR2L</b> - Right to left (including vertical writing systems such as
118      * Chinese, Japanese, and Korean)
119      * </ul>
120      * <li>The document's page mode, specifying how to display the
121      * document on exiting full-screen mode. It is meaningful only
122      * if the page mode is <b>PageModeFullScreen</b> (choose one).
123      * <ul>
124      * <li><b>NonFullScreenPageModeUseNone</b> - Neither document outline nor thumbnail images
125      * visible
126      * <li><b>NonFullScreenPageModeUseOutlines</b> - Document outline visible
127      * <li><b>NonFullScreenPageModeUseThumbs</b> - Thumbnail images visible
128      * <li><b>NonFullScreenPageModeUseOC</b> - Optional content group panel visible
129      * </ul>
130      * <li><b>PrintScalingNone</b> - Indicates that the print dialog should reflect no page scaling.
131      * </ul>
132      * @param preferences the viewer preferences
133      * @see PdfViewerPreferences#addViewerPreference
134      */
135     public void setViewerPreferences(int preferences);
136     
137     /**
138      * Adds a viewer preference.
139      * <ul>
140      * <li>In case the key is one of these values:
141      * <ul>
142      * <li>PdfName.<b>HIDETOOLBAR</b>
143      * <li>PdfName.<b>HIDEMENUBAR</b>
144      * <li>PdfName.<b>HIDEWINDOWUI</b>
145      * <li>PdfName.<b>FITWINDOW</b>
146      * <li>PdfName.<b>CENTERWINDOW</b>
147      * <li>PdfName.<b>DISPLAYDOCTITLE</b>
148      * </ul>
149      * The value must be a of type PdfBoolean (true or false).
150      * <li>In case the key is PdfName.<b>NONFULLSCREENPAGEMODE</b>,
151      * the value must be one of these names:
152      * <ul>
153      * <li>PdfName.<b>USENONE</b>
154      * <li>PdfName.<b>USEOUTLINES</b>
155      * <li>PdfName.<b>USETHUMBS</b>
156      * <li>PdfName.<b>USEOC</b>
157      * </ul>
158      * <li>In case the key is PdfName.DIRECTION,
159      * the value must be one of these names:
160      * <ul>
161      * <li>PdfName.<b>L2R</b>
162      * <li>PdfName.<b>R2L</b>
163      * </ul>
164      * <li>In case the key is one of these values:
165      * <ul>
166      * <li>PdfName.<b>VIEWAREA</b>
167      * <li>PdfName.<b>VIEWCLIP</b>
168      * <li>PdfName.<b>PRINTAREA</b>
169      * <li>PdfName.<b>PRINTCLIP</b>
170      * </ul>
171      * The value must be one of these names:
172      * <ul>
173      * <li>PdfName.<b>MEDIABOX</b>
174      * <li>PdfName.<b>CROPBOX</b>
175      * <li>PdfName.<b>BLEEDBOX</b>
176      * <li>PdfName.<b>TRIMBOX</b>
177      * <li>PdfName.<b>ARTBOX</b>
178      * </ul>
179      * <li>In case the key is PdfName.<b>PRINTSCALING</b>, the value can be
180      * <ul>
181      * <li>PdfName.<b>APPDEFAULT</b>
182      * <li>PdfName.<b>NONE</b>
183      * </ul>
184      * <li>In case the key is PdfName.<b>DUPLEX</b>, the value can be:
185      * <ul>
186      * <li>PdfName.<b>SIMPLEX</b>
187      * <li>PdfName.<b>DUPLEXFLIPSHORTEDGE</b>
188      * <li>PdfName.<b>DUPLEXFLIPLONGEDGE</b>
189      * </ul>
190      * <li>In case the key is PdfName.<b>PICKTRAYBYPDFSIZE</b>, the value must be of type PdfBoolean.
191      * <li>In case the key is PdfName.<b>PRINTPAGERANGE</b>, the value must be of type PdfArray.
192      * <li>In case the key is PdfName.<b>NUMCOPIES</b>, the value must be of type PdfNumber.
193      * <ul>
194      * </ul>
195      * @param key the name of the viewer preference
196      * @param value the value of the viewer preference
197      * @see PdfViewerPreferences#setViewerPreferences
198      */
199     public void addViewerPreference(PdfName key, PdfObject value);
200 }
Popular Tags