KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > action > type > PDActionGoTo


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.interactive.action.type;
32
33 import java.io.IOException JavaDoc;
34
35 import org.pdfbox.cos.COSDictionary;
36 import org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination;
37
38 /**
39  * This represents a go-to action that can be executed in a PDF document.
40  *
41  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
42  * @author Panagiotis Toumasis (ptoumasis@mail.gr)
43  * @version $Revision: 1.2 $
44  */
45 public class PDActionGoTo extends PDAction
46 {
47     /**
48      * This type of action this object represents.
49      */
50     public static final String JavaDoc SUB_TYPE = "GoTo";
51
52     /**
53      * Default constructor.
54      */
55     public PDActionGoTo()
56     {
57         super();
58         setSubType( SUB_TYPE );
59     }
60
61     /**
62      * Constructor.
63      *
64      * @param a The action dictionary.
65      */
66     public PDActionGoTo( COSDictionary a )
67     {
68         super( a );
69     }
70
71     /**
72      * This will get the destination to jump to.
73      *
74      * @return The D entry of the specific go-to action dictionary.
75      *
76      * @throws IOException If there is an error creating the destination.
77      */
78     public PDDestination getDestination() throws IOException JavaDoc
79     {
80         return PDDestination.create( getCOSDictionary().getDictionaryObject( "D" ) );
81     }
82
83     /**
84      * This will set the destination to jump to.
85      *
86      * @param d The destination.
87      */
88     public void setDestination( PDDestination d )
89     {
90         getCOSDictionary().setItem( "D", d );
91     }
92 }
Popular Tags