KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > documentnavigation > destination > PDNamedDestination


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.documentnavigation.destination;
32
33 import java.io.IOException JavaDoc;
34
35 import org.pdfbox.cos.COSBase;
36 import org.pdfbox.cos.COSName;
37 import org.pdfbox.cos.COSString;
38
39 /**
40  * This represents a destination to a page by referencing it with a name.
41  *
42  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
43  * @version $Revision: 1.3 $
44  */
45 public class PDNamedDestination extends PDDestination
46 {
47     private COSBase namedDestination;
48     
49     /**
50      * Constructor.
51      *
52      * @param dest The named destination.
53      */
54     public PDNamedDestination( COSString dest )
55     {
56         namedDestination = dest;
57     }
58     
59     /**
60      * Constructor.
61      *
62      * @param dest The named destination.
63      */
64     public PDNamedDestination( COSName dest )
65     {
66         namedDestination = dest;
67     }
68     
69     /**
70      * Default constructor.
71      */
72     public PDNamedDestination()
73     {
74         //default, so do nothing
75 }
76     
77     /**
78      * Default constructor.
79      *
80      * @param dest The named destination.
81      */
82     public PDNamedDestination( String JavaDoc dest )
83     {
84         namedDestination = new COSString( dest );
85     }
86     
87     /**
88      * Convert this standard java object to a COS object.
89      *
90      * @return The cos object that matches this Java object.
91      */
92     public COSBase getCOSObject()
93     {
94         return namedDestination;
95     }
96     
97     /**
98      * This will get the name of the destination.
99      *
100      * @return The name of the destination.
101      */
102     public String JavaDoc getNamedDestination()
103     {
104         String JavaDoc retval = null;
105         if( namedDestination instanceof COSString )
106         {
107             retval = ((COSString)namedDestination).getString();
108         }
109         else if( namedDestination instanceof COSName )
110         {
111             retval = ((COSName)namedDestination).getName();
112         }
113         
114         return retval;
115     }
116     
117     /**
118      * Set the named destination.
119      *
120      * @param dest The new named destination.
121      *
122      * @throws IOException If there is an error setting the named destination.
123      */
124     public void setNamedDestination( String JavaDoc dest ) throws IOException JavaDoc
125     {
126         if( namedDestination instanceof COSString )
127         {
128             COSString string = ((COSString)namedDestination);
129             string.reset();
130             string.append( dest.getBytes() );
131         }
132         else if( dest == null )
133         {
134             namedDestination = null;
135         }
136         else
137         {
138             namedDestination = new COSString( dest );
139         }
140     }
141     
142 }
143
Popular Tags