KickJava   Java API By Example, From Geeks To Geeks.

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


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 y location and the width 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 PDPageFitWidthDestination extends PDPageDestination
44 {
45     
46     /**
47      * The type of this destination.
48      */
49     protected static final String JavaDoc TYPE = "FitH";
50     /**
51      * The type of this destination.
52      */
53     protected static final String JavaDoc TYPE_BOUNDED = "FitBH";
54     
55     /**
56      * Default constructor.
57      *
58      */
59     public PDPageFitWidthDestination()
60     {
61         super();
62         array.growToSize(3);
63         array.setName( 1, TYPE );
64         
65     }
66     
67     /**
68      * Constructor from an existing destination array.
69      *
70      * @param arr The destination array.
71      */
72     public PDPageFitWidthDestination( COSArray arr )
73     {
74         super( arr );
75     }
76     
77     
78     /**
79      * Get the top y coordinate. A return value of -1 implies that the current y-coordinate
80      * will be used.
81      *
82      * @return The top y coordinate.
83      */
84     public int getTop()
85     {
86         return array.getInt( 2 );
87     }
88     
89     /**
90      * Set the top y-coordinate, a value of -1 implies that the current y-coordinate
91      * will be used.
92      * @param y The top ycoordinate.
93      */
94     public void setTop( int y )
95     {
96         array.growToSize( 3 );
97         if( y == -1 )
98         {
99             array.set( 2, (COSBase)null );
100         }
101         else
102         {
103             array.setInt( 2, y );
104         }
105     }
106     
107     /**
108      * A flag indicating if this page destination should just fit bounding box of the PDF.
109      *
110      * @return true If the destination should fit just the bounding box.
111      */
112     public boolean fitBoundingBox()
113     {
114         return TYPE_BOUNDED.equals( array.getName( 1 ) );
115     }
116     
117     /**
118      * Set if this page destination should just fit the bounding box. The default is false.
119      *
120      * @param fitBoundingBox A flag indicating if this should fit the bounding box.
121      */
122     public void setFitBoundingBox( boolean fitBoundingBox )
123     {
124         array.growToSize( 2 );
125         if( fitBoundingBox )
126         {
127             array.setName( 1, TYPE_BOUNDED );
128         }
129         else
130         {
131             array.setName( 1, TYPE );
132         }
133     }
134 }
135
Popular Tags