KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > documentinterchange > logicalstructure > PDStructureElement


1 /**
2  * Copyright (c) 2003-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.documentinterchange.logicalstructure;
32
33 import org.pdfbox.cos.COSBase;
34 import org.pdfbox.cos.COSDictionary;
35 import org.pdfbox.cos.COSName;
36 import org.pdfbox.pdmodel.common.COSObjectable;
37
38 /**
39  * A structure element.
40  *
41  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
42  * @version $Revision: 1.3 $
43  */
44 public class PDStructureElement implements COSObjectable
45 {
46     private COSDictionary dictionary;
47     
48     /**
49      * Default Constructor.
50      *
51      */
52     public PDStructureElement()
53     {
54         dictionary = new COSDictionary();
55         dictionary.setName( COSName.TYPE, "StructElem" );
56     }
57     
58     /**
59      * Constructor for an existing structure element.
60      *
61      * @param dic The existing dictionary.
62      */
63     public PDStructureElement( COSDictionary dic )
64     {
65         dictionary = dic;
66     }
67     
68     /**
69      * Convert this standard java object to a COS object.
70      *
71      * @return The cos object that matches this Java object.
72      */
73     public COSBase getCOSObject()
74     {
75         return dictionary;
76     }
77     
78     /**
79      * Get the low level dictionary that this object wraps.
80      *
81      * @return The cos dictionary that matches this Java object.
82      */
83     public COSDictionary getCOSDictionary()
84     {
85         return dictionary;
86     }
87 }
88
Popular Tags