KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > annotation > PDAppearanceStream


1 /**
2  * Copyright (c) 2003-2006, 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.annotation;
32
33 import org.pdfbox.cos.COSArray;
34 import org.pdfbox.cos.COSBase;
35 import org.pdfbox.cos.COSDictionary;
36 import org.pdfbox.cos.COSName;
37 import org.pdfbox.cos.COSStream;
38
39 import org.pdfbox.pdmodel.common.PDRectangle;
40 import org.pdfbox.pdmodel.common.COSObjectable;
41
42 import org.pdfbox.pdmodel.PDResources;
43
44
45 /**
46  * This class represents an appearance for an annotation.
47  *
48  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
49  * @version $Revision: 1.4 $
50  */
51 public class PDAppearanceStream implements COSObjectable
52 {
53     private COSStream stream = null;
54
55
56     /**
57      * Constructor.
58      *
59      * @param s The cos stream for this appearance.
60      */
61     public PDAppearanceStream( COSStream s )
62     {
63         stream = s;
64     }
65
66     /**
67      * This will return the underlying stream.
68      *
69      * @return The wrapped stream.
70      */
71     public COSStream getStream()
72     {
73         return stream;
74     }
75
76     /**
77      * {@inheritDoc}
78      */
79     public COSBase getCOSObject()
80     {
81         return stream;
82     }
83
84     /**
85      * Get the bounding box for this appearance. This may return null in which
86      * case the Rectangle from the annotation should be used.
87      *
88      * @return The bounding box for this appearance.
89      */
90     public PDRectangle getBoundingBox()
91     {
92         PDRectangle box = null;
93         COSArray bbox = (COSArray)stream.getDictionaryObject( COSName.getPDFName( "BBox" ) );
94         if( bbox != null )
95         {
96             box = new PDRectangle( bbox );
97         }
98         return box;
99     }
100
101     /**
102      * This will set the bounding box for this appearance stream.
103      *
104      * @param rectangle The new bounding box.
105      */
106     public void setBoundingBox( PDRectangle rectangle )
107     {
108         COSArray array = null;
109         if( rectangle != null )
110         {
111             array = rectangle.getCOSArray();
112         }
113         stream.setItem( COSName.getPDFName( "BBox" ), array );
114     }
115
116     /**
117      * This will get the resources for this appearance stream.
118      *
119      * @return The appearance stream resources.
120      */
121     public PDResources getResources()
122     {
123         PDResources retval = null;
124         COSDictionary dict = (COSDictionary)stream.getDictionaryObject( COSName.RESOURCES );
125         if( dict != null )
126         {
127             retval = new PDResources( dict );
128         }
129         return retval;
130     }
131
132     /**
133      * This will set the new resources.
134      *
135      * @param resources The new resources.
136      */
137     public void setResources( PDResources resources )
138     {
139         COSDictionary dict = null;
140         if( resources != null )
141         {
142             dict = resources.getCOSDictionary();
143         }
144         stream.setItem( COSName.RESOURCES, dict );
145     }
146 }
Popular Tags