001: /**
002: * Copyright (c) 2004, www.pdfbox.org
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * 1. Redistributions of source code must retain the above copyright notice,
009: * this list of conditions and the following disclaimer.
010: * 2. Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: * 3. Neither the name of pdfbox; nor the names of its
014: * contributors may be used to endorse or promote products derived from this
015: * software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
020: * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
021: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
024: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027: *
028: * http://www.pdfbox.org
029: *
030: */package org.pdfbox.pdmodel.interactive.action;
031:
032: import org.pdfbox.cos.COSBase;
033: import org.pdfbox.cos.COSDictionary;
034:
035: import org.pdfbox.pdmodel.common.COSObjectable;
036: import org.pdfbox.pdmodel.interactive.action.type.PDAction;
037:
038: /**
039: * This class represents a document catalog's dictionary of actions
040: * that occur due to events.
041: *
042: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
043: * @author Panagiotis Toumasis (ptoumasis@mail.gr)
044: * @version $Revision: 1.2 $
045: */
046: public class PDDocumentCatalogAdditionalActions implements
047: COSObjectable {
048: private COSDictionary actions;
049:
050: /**
051: * Default constructor.
052: */
053: public PDDocumentCatalogAdditionalActions() {
054: actions = new COSDictionary();
055: }
056:
057: /**
058: * Constructor.
059: *
060: * @param a The action dictionary.
061: */
062: public PDDocumentCatalogAdditionalActions(COSDictionary a) {
063: actions = a;
064: }
065:
066: /**
067: * Convert this standard java object to a COS object.
068: *
069: * @return The cos object that matches this Java object.
070: */
071: public COSBase getCOSObject() {
072: return actions;
073: }
074:
075: /**
076: * Convert this standard java object to a COS object.
077: *
078: * @return The cos object that matches this Java object.
079: */
080: public COSDictionary getCOSDictionary() {
081: return actions;
082: }
083:
084: /**
085: * This will get a JavaScript action to be performed
086: * before closing a document.
087: * The name WC stands for "will close".
088: *
089: * @return The WC entry of document catalog's additional actions dictionary.
090: */
091: public PDAction getWC() {
092: COSDictionary wc = (COSDictionary) actions
093: .getDictionaryObject("WC");
094: PDAction retval = null;
095: if (wc != null) {
096: retval = PDActionFactory.createAction(wc);
097: }
098: return retval;
099: }
100:
101: /**
102: * This will set a JavaScript action to be performed
103: * before closing a document.
104: * The name WC stands for "will close".
105: *
106: * @param wc The action to be performed.
107: */
108: public void setWC(PDAction wc) {
109: actions.setItem("WC", wc);
110: }
111:
112: /**
113: * This will get a JavaScript action to be performed
114: * before saving a document.
115: * The name WS stands for "will save".
116: *
117: * @return The WS entry of document catalog's additional actions dictionary.
118: */
119: public PDAction getWS() {
120: COSDictionary ws = (COSDictionary) actions
121: .getDictionaryObject("WS");
122: PDAction retval = null;
123: if (ws != null) {
124: retval = PDActionFactory.createAction(ws);
125: }
126: return retval;
127: }
128:
129: /**
130: * This will set a JavaScript action to be performed
131: * before saving a document.
132: * The name WS stands for "will save".
133: *
134: * @param ws The action to be performed.
135: */
136: public void setWS(PDAction ws) {
137: actions.setItem("WS", ws);
138: }
139:
140: /**
141: * This will get a JavaScript action to be performed
142: * after saving a document.
143: * The name DS stands for "did save".
144: *
145: * @return The DS entry of document catalog's additional actions dictionary.
146: */
147: public PDAction getDS() {
148: COSDictionary ds = (COSDictionary) actions
149: .getDictionaryObject("DS");
150: PDAction retval = null;
151: if (ds != null) {
152: retval = PDActionFactory.createAction(ds);
153: }
154: return retval;
155: }
156:
157: /**
158: * This will set a JavaScript action to be performed
159: * after saving a document.
160: * The name DS stands for "did save".
161: *
162: * @param ds The action to be performed.
163: */
164: public void setDS(PDAction ds) {
165: actions.setItem("DS", ds);
166: }
167:
168: /**
169: * This will get a JavaScript action to be performed
170: * before printing a document.
171: * The name WP stands for "will print".
172: *
173: * @return The WP entry of document catalog's additional actions dictionary.
174: */
175: public PDAction getWP() {
176: COSDictionary wp = (COSDictionary) actions
177: .getDictionaryObject("WP");
178: PDAction retval = null;
179: if (wp != null) {
180: retval = PDActionFactory.createAction(wp);
181: }
182: return retval;
183: }
184:
185: /**
186: * This will set a JavaScript action to be performed
187: * before printing a document.
188: * The name WP stands for "will print".
189: *
190: * @param wp The action to be performed.
191: */
192: public void setWP(PDAction wp) {
193: actions.setItem("WP", wp);
194: }
195:
196: /**
197: * This will get a JavaScript action to be performed
198: * after printing a document.
199: * The name DP stands for "did print".
200: *
201: * @return The DP entry of document catalog's additional actions dictionary.
202: */
203: public PDAction getDP() {
204: COSDictionary dp = (COSDictionary) actions
205: .getDictionaryObject("DP");
206: PDAction retval = null;
207: if (dp != null) {
208: retval = PDActionFactory.createAction(dp);
209: }
210: return retval;
211: }
212:
213: /**
214: * This will set a JavaScript action to be performed
215: * after printing a document.
216: * The name DP stands for "did print".
217: *
218: * @param dp The action to be performed.
219: */
220: public void setDP(PDAction dp) {
221: actions.setItem("DP", dp);
222: }
223: }
|