001: /*
002: * $Id: PdfViewerPreferences.java 2678 2007-04-10 08:59:39Z blowagie $
003: *
004: * Copyright 2006 Bruno Lowagie
005: *
006: * The contents of this file are subject to the Mozilla Public License Version 1.1
007: * (the "License"); you may not use this file except in compliance with the License.
008: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
009: *
010: * Software distributed under the License is distributed on an "AS IS" basis,
011: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
012: * for the specific language governing rights and limitations under the License.
013: *
014: * The Original Code is 'iText, a free JAVA-PDF library'.
015: *
016: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
017: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
018: * All Rights Reserved.
019: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
020: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
021: *
022: * Contributor(s): all the names of the contributors are added in the source code
023: * where applicable.
024: *
025: * Alternatively, the contents of this file may be used under the terms of the
026: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
027: * provisions of LGPL are applicable instead of those above. If you wish to
028: * allow use of your version of this file only under the terms of the LGPL
029: * License and not to allow others to use your version of this file under
030: * the MPL, indicate your decision by deleting the provisions above and
031: * replace them with the notice and other provisions required by the LGPL.
032: * If you do not delete the provisions above, a recipient may use your version
033: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
034: *
035: * This library is free software; you can redistribute it and/or modify it
036: * under the terms of the MPL as stated above or under the terms of the GNU
037: * Library General Public License as published by the Free Software Foundation;
038: * either version 2 of the License, or any later version.
039: *
040: * This library is distributed in the hope that it will be useful, but WITHOUT
041: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
042: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
043: * details.
044: *
045: * If you didn't download this code from the following link, you should check if
046: * you aren't using an obsolete version:
047: * http://www.lowagie.com/iText/
048: */
049:
050: package com.lowagie.text.pdf.interfaces;
051:
052: import com.lowagie.text.pdf.PdfName;
053: import com.lowagie.text.pdf.PdfObject;
054:
055: /**
056: * Viewer preferences are described in section 3.6.1 and 8.1 of the
057: * PDF Reference 1.7 (Table 3.25 on p139-142 and Table 8.1 on p579-581).
058: * They are explained in section 13.1 of the book 'iText in Action'.
059: * The values of the different preferences were originally stored
060: * in class PdfWriter, but they have been moved to this separate interface
061: * for reasons of convenience.
062: */
063:
064: public interface PdfViewerPreferences {
065:
066: /**
067: * Sets the page layout and page mode preferences by ORing one or two of these constants.
068: * <p>
069: * <ul>
070: * <li>The page layout to be used when the document is opened (choose one).
071: * <ul>
072: * <li><b>PageLayoutSinglePage</b> - Display one page at a time. (default)
073: * <li><b>PageLayoutOneColumn</b> - Display the pages in one column.
074: * <li><b>PageLayoutTwoColumnLeft</b> - Display the pages in two columns, with
075: * oddnumbered pages on the left.
076: * <li><b>PageLayoutTwoColumnRight</b> - Display the pages in two columns, with
077: * oddnumbered pages on the right.
078: * <li><b>PageLayoutTwoPageLeft</b> - Display the pages two at a time, with
079: * oddnumbered pages on the left.
080: * <li><b>PageLayoutTwoPageRight</b> - Display the pages two at a time, with
081: * oddnumbered pages on the right.
082: * </ul>
083: * <li>The page mode how the document should be displayed
084: * when opened (choose one).
085: * <ul>
086: * <li><b>PageModeUseNone</b> - Neither document outline nor thumbnail images visible. (default)
087: * <li><b>PageModeUseOutlines</b> - Document outline visible.
088: * <li><b>PageModeUseThumbs</b> - Thumbnail images visible.
089: * <li><b>PageModeFullScreen</b> - Full-screen mode, with no menu bar, window
090: * controls, or any other window visible.
091: * <li><b>PageModeUseOC</b> - Optional content group panel visible
092: * <li><b>PageModeUseAttachments</b> - Attachments panel visible
093: * </ul>
094: * </ul>
095: * For backward compatibility these values are also supported,
096: * but it's better to use method <code>addViewerPreference(key, value)</code>
097: * if you want to change the following preferences:
098: * <ul>
099: * <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: }
|