01: /**
02: * Copyright (c) 2004, www.pdfbox.org
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * 1. Redistributions of source code must retain the above copyright notice,
09: * 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: */package org.pdfbox.pdmodel.interactive.action.type;
31:
32: import java.io.IOException;
33:
34: import org.pdfbox.cos.COSDictionary;
35: import org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination;
36:
37: /**
38: * This represents a go-to action that can be executed in a PDF document.
39: *
40: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
41: * @author Panagiotis Toumasis (ptoumasis@mail.gr)
42: * @version $Revision: 1.2 $
43: */
44: public class PDActionGoTo extends PDAction {
45: /**
46: * This type of action this object represents.
47: */
48: public static final String SUB_TYPE = "GoTo";
49:
50: /**
51: * Default constructor.
52: */
53: public PDActionGoTo() {
54: super ();
55: setSubType(SUB_TYPE);
56: }
57:
58: /**
59: * Constructor.
60: *
61: * @param a The action dictionary.
62: */
63: public PDActionGoTo(COSDictionary a) {
64: super (a);
65: }
66:
67: /**
68: * This will get the destination to jump to.
69: *
70: * @return The D entry of the specific go-to action dictionary.
71: *
72: * @throws IOException If there is an error creating the destination.
73: */
74: public PDDestination getDestination() throws IOException {
75: return PDDestination.create(getCOSDictionary()
76: .getDictionaryObject("D"));
77: }
78:
79: /**
80: * This will set the destination to jump to.
81: *
82: * @param d The destination.
83: */
84: public void setDestination(PDDestination d) {
85: getCOSDictionary().setItem("D", d);
86: }
87: }
|