KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > graphics > xobject > PDXObjectForm


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.graphics.xobject;
32
33 import org.pdfbox.cos.COSDictionary;
34 import org.pdfbox.cos.COSName;
35 import org.pdfbox.cos.COSStream;
36
37 import org.pdfbox.pdmodel.PDResources;
38 import org.pdfbox.pdmodel.common.PDStream;
39
40 /**
41  * A form xobject.
42  *
43  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44  * @version $Revision: 1.5 $
45  */
46 public class PDXObjectForm extends PDXObject
47 {
48     /**
49      * The XObject subtype.
50      */
51     public static final String JavaDoc SUB_TYPE = "Form";
52     
53     /**
54      * Standard constuctor.
55      *
56      * @param formStream The XObject is passed as a COSStream.
57      */
58     public PDXObjectForm(PDStream formStream)
59     {
60         super( formStream );
61     }
62     
63     /**
64      * Standard constuctor.
65      *
66      * @param formStream The XObject is passed as a COSStream.
67      */
68     public PDXObjectForm(COSStream formStream)
69     {
70         super( formStream );
71     }
72     
73     /**
74      * This will get the form type, currently 1 is the only form type.
75      *
76      * @return The form type.
77      */
78     public int getFormType()
79     {
80         return getCOSStream().getInt( "FormType",1 );
81     }
82     
83     /**
84      * Set the form type.
85      *
86      * @param formType The new form type.
87      */
88     public void setFormType( int formType )
89     {
90         getCOSStream().setInt( "FormType", formType );
91     }
92     
93     /**
94      * This will get the resources at this page and not look up the hierarchy.
95      * This attribute is inheritable, and findResources() should probably used.
96      * This will return null if no resources are available at this level.
97      *
98      * @return The resources at this level in the hierarchy.
99      */
100     public PDResources getResources()
101     {
102         PDResources retval = null;
103         COSDictionary resources = (COSDictionary)getCOSStream().getDictionaryObject( COSName.RESOURCES );
104         if( resources != null )
105         {
106             retval = new PDResources( resources );
107         }
108         return retval;
109     }
110     
111     /**
112      * This will set the resources for this page.
113      *
114      * @param resources The new resources for this page.
115      */
116     public void setResources( PDResources resources )
117     {
118         getCOSStream().setItem( COSName.RESOURCES, resources );
119     }
120 }
121
Popular Tags