01: /**
02: * Copyright (c) 2005, www.pdfbox.org
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * 1. Redistributions of source code must retain the above copyright notice,
09: * this list of conditions and the following disclaimer.
10: * 2. Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: * 3. Neither the name of pdfbox; nor the names of its
14: * contributors may be used to endorse or promote products derived from this
15: * software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20: * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27: *
28: * http://www.pdfbox.org
29: *
30: */package org.pdfbox.pdmodel.interactive.documentnavigation.destination;
31:
32: import org.pdfbox.cos.COSArray;
33:
34: /**
35: * This represents a destination to a page and the page contents will be magnified to just
36: * fit on the screen.
37: *
38: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
39: * @version $Revision: 1.2 $
40: */
41: public class PDPageFitDestination extends PDPageDestination {
42: /**
43: * The type of this destination.
44: */
45: protected static final String TYPE = "Fit";
46: /**
47: * The type of this destination.
48: */
49: protected static final String TYPE_BOUNDED = "FitB";
50:
51: /**
52: * Default constructor.
53: *
54: */
55: public PDPageFitDestination() {
56: super ();
57: array.growToSize(2);
58: array.setName(1, TYPE);
59:
60: }
61:
62: /**
63: * Constructor from an existing destination array.
64: *
65: * @param arr The destination array.
66: */
67: public PDPageFitDestination(COSArray arr) {
68: super (arr);
69: }
70:
71: /**
72: * A flag indicating if this page destination should just fit bounding box of the PDF.
73: *
74: * @return true If the destination should fit just the bounding box.
75: */
76: public boolean fitBoundingBox() {
77: return TYPE_BOUNDED.equals(array.getName(1));
78: }
79:
80: /**
81: * Set if this page destination should just fit the bounding box. The default is false.
82: *
83: * @param fitBoundingBox A flag indicating if this should fit the bounding box.
84: */
85: public void setFitBoundingBox(boolean fitBoundingBox) {
86: array.growToSize(2);
87: if (fitBoundingBox) {
88: array.setName(1, TYPE_BOUNDED);
89: } else {
90: array.setName(1, TYPE);
91: }
92: }
93: }
|