KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > documentnavigation > destination > PDPageFitDestination


1 /**
2  * Copyright (c) 2005, www.pdfbox.org
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * 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  */
31 package org.pdfbox.pdmodel.interactive.documentnavigation.destination;
32
33 import org.pdfbox.cos.COSArray;
34
35 /**
36  * This represents a destination to a page and the page contents will be magnified to just
37  * fit on the screen.
38  *
39  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
40  * @version $Revision: 1.2 $
41  */
42 public class PDPageFitDestination extends PDPageDestination
43 {
44     /**
45      * The type of this destination.
46      */
47     protected static final String JavaDoc TYPE = "Fit";
48     /**
49      * The type of this destination.
50      */
51     protected static final String JavaDoc TYPE_BOUNDED = "FitB";
52     
53     /**
54      * Default constructor.
55      *
56      */
57     public PDPageFitDestination()
58     {
59         super();
60         array.growToSize(2);
61         array.setName( 1, TYPE );
62         
63     }
64     
65     /**
66      * Constructor from an existing destination array.
67      *
68      * @param arr The destination array.
69      */
70     public PDPageFitDestination( COSArray arr )
71     {
72         super( arr );
73     }
74     
75     /**
76      * A flag indicating if this page destination should just fit bounding box of the PDF.
77      *
78      * @return true If the destination should fit just the bounding box.
79      */
80     public boolean fitBoundingBox()
81     {
82         return TYPE_BOUNDED.equals( array.getName( 1 ) );
83     }
84     
85     /**
86      * Set if this page destination should just fit the bounding box. The default is false.
87      *
88      * @param fitBoundingBox A flag indicating if this should fit the bounding box.
89      */
90     public void setFitBoundingBox( boolean fitBoundingBox )
91     {
92         array.growToSize( 2 );
93         if( fitBoundingBox )
94         {
95             array.setName( 1, TYPE_BOUNDED );
96         }
97         else
98         {
99             array.setName( 1, TYPE );
100         }
101     }
102 }
103
Popular Tags