KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > action > PDAdditionalActions


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;
32
33 import org.pdfbox.cos.COSBase;
34 import org.pdfbox.cos.COSDictionary;
35
36 import org.pdfbox.pdmodel.common.COSObjectable;
37 import org.pdfbox.pdmodel.interactive.action.type.PDAction;
38
39 /**
40  * This represents a dictionary of actions that occur due to events.
41  *
42  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
43  * @version $Revision: 1.4 $
44  */
45 public class PDAdditionalActions implements COSObjectable
46 {
47     private COSDictionary actions;
48
49     /**
50      * Default constructor.
51      */
52     public PDAdditionalActions()
53     {
54         actions = new COSDictionary();
55     }
56
57     /**
58      * Constructor.
59      *
60      * @param a The action dictionary.
61      */
62     public PDAdditionalActions( COSDictionary a )
63     {
64         actions = a;
65     }
66
67     /**
68      * Convert this standard java object to a COS object.
69      *
70      * @return The cos object that matches this Java object.
71      */
72     public COSBase getCOSObject()
73     {
74         return actions;
75     }
76
77     /**
78      * Convert this standard java object to a COS object.
79      *
80      * @return The cos object that matches this Java object.
81      */
82     public COSDictionary getCOSDictionary()
83     {
84         return actions;
85     }
86     
87     /**
88      * Get the F action.
89      *
90      * @return The F action.
91      */
92     public PDAction getF()
93     {
94         return PDActionFactory.createAction( (COSDictionary)actions.getDictionaryObject("F" ) );
95     }
96     
97     /**
98      * Set the F action.
99      *
100      * @param action Get the F action.
101      */
102     public void setF( PDAction action )
103     {
104         actions.setItem( "F", action );
105     }
106 }
Popular Tags