KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.pdfbox.cos.COSBase;
35
36 /**
37  * This represents a destination to a page at a x location and the height is magnified
38  * to just fit on the screen.
39  *
40  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
41  * @version $Revision: 1.2 $
42  */
43 public class PDPageFitHeightDestination extends PDPageDestination
44 {
45     /**
46      * The type of this destination.
47      */
48     protected static final String JavaDoc TYPE = "FitV";
49     /**
50      * The type of this destination.
51      */
52     protected static final String JavaDoc TYPE_BOUNDED = "FitBV";
53     
54     /**
55      * Default constructor.
56      *
57      */
58     public PDPageFitHeightDestination()
59     {
60         super();
61         array.growToSize(3);
62         array.setName( 1, TYPE );
63         
64     }
65     
66     /**
67      * Constructor from an existing destination array.
68      *
69      * @param arr The destination array.
70      */
71     public PDPageFitHeightDestination( COSArray arr )
72     {
73         super( arr );
74     }
75     
76     /**
77      * Get the left x coordinate. A return value of -1 implies that the current x-coordinate
78      * will be used.
79      *
80      * @return The left x coordinate.
81      */
82     public int getLeft()
83     {
84         return array.getInt( 2 );
85     }
86     
87     /**
88      * Set the left x-coordinate, a value of -1 implies that the current x-coordinate
89      * will be used.
90      * @param x The left x coordinate.
91      */
92     public void setLeft( int x )
93     {
94         array.growToSize( 3 );
95         if( x == -1 )
96         {
97             array.set( 2, (COSBase)null );
98         }
99         else
100         {
101             array.setInt( 2, x );
102         }
103     }
104     
105     /**
106      * A flag indicating if this page destination should just fit bounding box of the PDF.
107      *
108      * @return true If the destination should fit just the bounding box.
109      */
110     public boolean fitBoundingBox()
111     {
112         return TYPE_BOUNDED.equals( array.getName( 1 ) );
113     }
114     
115     /**
116      * Set if this page destination should just fit the bounding box. The default is false.
117      *
118      * @param fitBoundingBox A flag indicating if this should fit the bounding box.
119      */
120     public void setFitBoundingBox( boolean fitBoundingBox )
121     {
122         array.growToSize( 2 );
123         if( fitBoundingBox )
124         {
125             array.setName( 1, TYPE_BOUNDED );
126         }
127         else
128         {
129             array.setName( 1, TYPE );
130         }
131     }
132 }
133
Popular Tags