001: /**
002: * Copyright (c) 2004-2005, 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.type;
031:
032: import java.io.IOException;
033:
034: import org.pdfbox.cos.COSDictionary;
035:
036: import org.pdfbox.pdmodel.common.filespecification.PDFileSpecification;
037:
038: /**
039: * This represents a launch action that can be executed in a PDF document.
040: *
041: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
042: * @author Panagiotis Toumasis (ptoumasis@mail.gr)
043: * @version $Revision: 1.5 $
044: */
045: public class PDActionLaunch extends PDAction {
046:
047: /**
048: * This type of action this object represents.
049: */
050: public static final String SUB_TYPE = "Launch";
051:
052: /**
053: * Default constructor.
054: */
055: public PDActionLaunch() {
056: super ();
057: setSubType(SUB_TYPE);
058: }
059:
060: /**
061: * Constructor.
062: *
063: * @param a The action dictionary.
064: */
065: public PDActionLaunch(COSDictionary a) {
066: super (a);
067: }
068:
069: /**
070: * This will get the application to be launched or the document
071: * to be opened or printed. It is required if none of the entries
072: * Win, Mac or Unix is present. If this entry is absent and the
073: * viewer application does not understand any of the alternative
074: * entries it should do nothing.
075: *
076: * @return The F entry of the specific launch action dictionary.
077: *
078: * @throws IOException If there is an error creating the file spec.
079: */
080: public PDFileSpecification getFile() throws IOException {
081: return PDFileSpecification.createFS(getCOSDictionary()
082: .getDictionaryObject("F"));
083: }
084:
085: /**
086: * This will set the application to be launched or the document
087: * to be opened or printed. It is required if none of the entries
088: * Win, Mac or Unix is present. If this entry is absent and the
089: * viewer application does not understand any of the alternative
090: * entries it should do nothing.
091: *
092: * @param fs The file specification.
093: */
094: public void setFile(PDFileSpecification fs) {
095: getCOSDictionary().setItem("F", fs);
096: }
097:
098: /**
099: * This will get a dictionary containing Windows-specific launch parameters.
100: *
101: * @return The Win entry of of the specific launch action dictionary.
102: */
103: public PDWindowsLaunchParams getWinLaunchParams() {
104: COSDictionary win = (COSDictionary) action
105: .getDictionaryObject("Win");
106: PDWindowsLaunchParams retval = null;
107: if (win != null) {
108: retval = new PDWindowsLaunchParams(win);
109: }
110: return retval;
111: }
112:
113: /**
114: * This will set a dictionary containing Windows-specific launch parameters.
115: *
116: * @param win The action to be performed.
117: */
118: public void setWinLaunchParams(PDWindowsLaunchParams win) {
119: action.setItem("Win", win);
120: }
121:
122: /**
123: * This will get the file name to be launched or the document to be opened
124: * or printed, in standard Windows pathname format. If the name string includes
125: * a backslash character (\), the backslash must itself be preceded by a backslash.
126: * This value must be a single string; it is not a file specification.
127: *
128: * @return The F entry of the specific Windows launch parameter dictionary.
129: */
130: public String getF() {
131: return action.getString("F");
132: }
133:
134: /**
135: * This will set the file name to be launched or the document to be opened
136: * or printed, in standard Windows pathname format. If the name string includes
137: * a backslash character (\), the backslash must itself be preceded by a backslash.
138: * This value must be a single string; it is not a file specification.
139: *
140: * @param f The file name to be launched.
141: */
142: public void setF(String f) {
143: action.setString("F", f);
144: }
145:
146: /**
147: * This will get the string specifying the default directory in standard DOS syntax.
148: *
149: * @return The D entry of the specific Windows launch parameter dictionary.
150: */
151: public String getD() {
152: return action.getString("D");
153: }
154:
155: /**
156: * This will set the string specifying the default directory in standard DOS syntax.
157: *
158: * @param d The default directory.
159: */
160: public void setD(String d) {
161: action.setString("D", d);
162: }
163:
164: /**
165: * This will get the string specifying the operation to perform:
166: * open to open a document
167: * print to print a document
168: * If the F entry designates an application instead of a document, this entry
169: * is ignored and the application is launched. Default value: open.
170: *
171: * @return The O entry of the specific Windows launch parameter dictionary.
172: */
173: public String getO() {
174: return action.getString("O");
175: }
176:
177: /**
178: * This will set the string specifying the operation to perform:
179: * open to open a document
180: * print to print a document
181: * If the F entry designates an application instead of a document, this entry
182: * is ignored and the application is launched. Default value: open.
183: *
184: * @param o The operation to perform.
185: */
186: public void setO(String o) {
187: action.setString("O", o);
188: }
189:
190: /**
191: * This will get a parameter string to be passed to the application designated by the F entry.
192: * This entry should be omitted if F designates a document.
193: *
194: * @return The P entry of the specific Windows launch parameter dictionary.
195: */
196: public String getP() {
197: return action.getString("P");
198: }
199:
200: /**
201: * This will set a parameter string to be passed to the application designated by the F entry.
202: * This entry should be omitted if F designates a document.
203: *
204: * @param p The parameter string.
205: */
206: public void setP(String p) {
207: action.setString("P", p);
208: }
209:
210: /**
211: * This will specify whether to open the destination document in a new window.
212: * If this flag is false, the destination document will replace the current
213: * document in the same window. If this entry is absent, the viewer application
214: * should behave in accordance with the current user preference. This entry is
215: * ignored if the file designated by the F entry is not a PDF document.
216: *
217: * @return A flag specifying whether to open the destination document in a new window.
218: */
219: public boolean shouldOpenInNewWindow() {
220: return action.getBoolean("NewWindow", true);
221: }
222:
223: /**
224: * This will specify the destination document to open in a new window.
225: *
226: * @param value The flag value.
227: */
228: public void setOpenInNewWindow(boolean value) {
229: action.setBoolean("NewWindow", value);
230: }
231: }
|