KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > fdf > FDFNamedPageReference


1 /**
2  * Copyright (c) 2004, 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.fdf;
32
33 import java.io.IOException JavaDoc;
34
35 import org.pdfbox.cos.COSBase;
36 import org.pdfbox.cos.COSDictionary;
37
38 import org.pdfbox.pdmodel.common.COSObjectable;
39
40 import org.pdfbox.pdmodel.common.filespecification.PDFileSpecification;
41
42 /**
43  * This represents an FDF named page reference that is part of the FDF field.
44  *
45  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
46  * @version $Revision: 1.3 $
47  */
48 public class FDFNamedPageReference implements COSObjectable
49 {
50     private COSDictionary ref;
51
52     /**
53      * Default constructor.
54      */
55     public FDFNamedPageReference()
56     {
57         ref = new COSDictionary();
58     }
59
60     /**
61      * Constructor.
62      *
63      * @param r The FDF named page reference dictionary.
64      */
65     public FDFNamedPageReference( COSDictionary r )
66     {
67         ref = r;
68     }
69
70     /**
71      * Convert this standard java object to a COS object.
72      *
73      * @return The cos object that matches this Java object.
74      */
75     public COSBase getCOSObject()
76     {
77         return ref;
78     }
79
80     /**
81      * Convert this standard java object to a COS object.
82      *
83      * @return The cos object that matches this Java object.
84      */
85     public COSDictionary getCOSDictionary()
86     {
87         return ref;
88     }
89
90     /**
91      * This will get the name of the referenced page. A required parameter.
92      *
93      * @return The name of the referenced page.
94      */
95     public String JavaDoc getName()
96     {
97         return ref.getString( "Name" );
98     }
99
100     /**
101      * This will set the name of the referenced page.
102      *
103      * @param name The referenced page name.
104      */
105     public void setName( String JavaDoc name )
106     {
107         ref.setString( "Name", name );
108     }
109
110     /**
111      * This will get the file specification of this reference. An optional parameter.
112      *
113      * @return The F entry for this dictionary.
114      *
115      * @throws IOException If there is an error creating the file spec.
116      */
117     public PDFileSpecification getFileSpecification() throws IOException JavaDoc
118     {
119         return PDFileSpecification.createFS( ref.getDictionaryObject( "F" ) );
120     }
121
122     /**
123      * This will set the file specification for this named page reference.
124      *
125      * @param fs The file specification to set.
126      */
127     public void setFileSpecification( PDFileSpecification fs )
128     {
129         ref.setItem( "F", fs );
130     }
131 }
Popular Tags