KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > pagenavigation > PDThread


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.pagenavigation;
32
33 import org.pdfbox.cos.COSBase;
34 import org.pdfbox.cos.COSDictionary;
35
36 import org.pdfbox.pdmodel.PDDocumentInformation;
37 import org.pdfbox.pdmodel.common.COSObjectable;
38
39 /**
40  * This a single thread in a PDF document.
41  *
42  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
43  * @version $Revision: 1.2 $
44  */
45 public class PDThread implements COSObjectable
46 {
47     
48     
49     private COSDictionary thread;
50
51     /**
52      * Constructor that is used for a preexisting dictionary.
53      *
54      * @param t The underlying dictionary.
55      */
56     public PDThread( COSDictionary t )
57     {
58         thread = t;
59     }
60     
61     /**
62      * Default constructor.
63      *
64      */
65     public PDThread()
66     {
67         thread = new COSDictionary();
68         thread.setName( "Type", "Thread" );
69     }
70
71     /**
72      * This will get the underlying dictionary that this object wraps.
73      *
74      * @return The underlying info dictionary.
75      */
76     public COSDictionary getDictionary()
77     {
78         return thread;
79     }
80     
81     /**
82      * Convert this standard java object to a COS object.
83      *
84      * @return The cos object that matches this Java object.
85      */
86     public COSBase getCOSObject()
87     {
88         return thread;
89     }
90     
91     /**
92      * Get info about the thread, or null if there is nothing.
93      *
94      * @return The thread information.
95      */
96     public PDDocumentInformation getThreadInfo()
97     {
98         PDDocumentInformation retval = null;
99         COSDictionary info = (COSDictionary)thread.getDictionaryObject( "I" );
100         if( info != null )
101         {
102             retval = new PDDocumentInformation( info );
103         }
104         
105         return retval;
106     }
107     
108     /**
109      * Set the thread info, can be null.
110      *
111      * @param info The info dictionary about this thread.
112      */
113     public void setThreadInfo( PDDocumentInformation info )
114     {
115         thread.setItem( "I", info );
116     }
117     
118     /**
119      * Get the first bead in the thread, or null if it has not been set yet. This
120      * is a required field for this object.
121      *
122      * @return The first bead in the thread.
123      */
124     public PDThreadBead getFirstBead()
125     {
126         PDThreadBead retval = null;
127         COSDictionary bead = (COSDictionary)thread.getDictionaryObject( "F" );
128         if( bead != null )
129         {
130             retval = new PDThreadBead( bead );
131         }
132         
133         return retval;
134     }
135     
136     /**
137      * This will set the first bead in the thread. When this is set it will
138      * also set the thread property of the bead object.
139      *
140      * @param bead The first bead in the thread.
141      */
142     public void setFirstBead( PDThreadBead bead )
143     {
144         if( bead != null )
145         {
146             bead.setThread( this );
147         }
148         thread.setItem( "F", bead );
149     }
150     
151     
152 }
Popular Tags