From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001 From: tknall Date: Fri, 1 Dec 2006 12:20:24 +0000 Subject: Initial import of release 2.2. git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c --- .../interactive/action/type/PDActionLaunch.java | 244 +++++++++++++++++++++ 1 file changed, 244 insertions(+) create mode 100644 src/main/java/org/pdfbox/pdmodel/interactive/action/type/PDActionLaunch.java (limited to 'src/main/java/org/pdfbox/pdmodel/interactive/action/type/PDActionLaunch.java') diff --git a/src/main/java/org/pdfbox/pdmodel/interactive/action/type/PDActionLaunch.java b/src/main/java/org/pdfbox/pdmodel/interactive/action/type/PDActionLaunch.java new file mode 100644 index 0000000..3c2ef74 --- /dev/null +++ b/src/main/java/org/pdfbox/pdmodel/interactive/action/type/PDActionLaunch.java @@ -0,0 +1,244 @@ +/** + * Copyright (c) 2004-2005, www.pdfbox.org + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of pdfbox; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://www.pdfbox.org + * + */ +package org.pdfbox.pdmodel.interactive.action.type; + +import org.pdfbox.cos.COSDictionary; + +import org.pdfbox.pdmodel.common.filespecification.PDFileSpecification; + +/** + * This represents a launch action that can be executed in a PDF document. + * + * @author Ben Litchfield (ben@benlitchfield.com) + * @author Panagiotis Toumasis (ptoumasis@mail.gr) + * @version $Revision: 1.3 $ + */ +public class PDActionLaunch extends PDAction +{ + + /** + * This type of action this object represents. + */ + public static final String SUB_TYPE = "Launch"; + + /** + * Default constructor. + */ + public PDActionLaunch() + { + super(); + setSubType( SUB_TYPE ); + } + + /** + * Constructor. + * + * @param a The action dictionary. + */ + public PDActionLaunch( COSDictionary a ) + { + super( a ); + } + + /** + * This will get the application to be launched or the document + * to be opened or printed. It is required if none of the entries + * Win, Mac or Unix is present. If this entry is absent and the + * viewer application does not understand any of the alternative + * entries it should do nothing. + * + * @return The F entry of the specific launch action dictionary. + */ + public PDFileSpecification getFile() + { + return PDFileSpecification.createFS( getCOSDictionary().getDictionaryObject( "F" ) ); + } + + /** + * This will set the application to be launched or the document + * to be opened or printed. It is required if none of the entries + * Win, Mac or Unix is present. If this entry is absent and the + * viewer application does not understand any of the alternative + * entries it should do nothing. + * + * @param fs The file specification. + */ + public void setFile( PDFileSpecification fs ) + { + getCOSDictionary().setItem( "F", fs ); + } + + /** + * This will get a dictionary containing Windows-specific launch parameters. + * + * @return The Win entry of of the specific launch action dictionary. + */ + public PDWindowsLaunchParams getWinLaunchParams() + { + COSDictionary win = (COSDictionary)action.getDictionaryObject( "Win" ); + PDWindowsLaunchParams retval = null; + if( win != null ) + { + retval = new PDWindowsLaunchParams( win ); + } + return retval; + } + + /** + * This will set a dictionary containing Windows-specific launch parameters. + * + * @param win The action to be performed. + */ + public void setWinLaunchParams( PDWindowsLaunchParams win ) + { + action.setItem( "Win", win ); + } + + /** + * This will get the file name to be launched or the document to be opened + * or printed, in standard Windows pathname format. If the name string includes + * a backslash character (\), the backslash must itself be preceded by a backslash. + * This value must be a single string; it is not a file specification. + * + * @return The F entry of the specific Windows launch parameter dictionary. + */ + public String getF() + { + return action.getString( "F" ); + } + + /** + * This will set the file name to be launched or the document to be opened + * or printed, in standard Windows pathname format. If the name string includes + * a backslash character (\), the backslash must itself be preceded by a backslash. + * This value must be a single string; it is not a file specification. + * + * @param f The file name to be launched. + */ + public void setF( String f ) + { + action.setString( "F", f ); + } + + /** + * This will get the string specifying the default directory in standard DOS syntax. + * + * @return The D entry of the specific Windows launch parameter dictionary. + */ + public String getD() + { + return action.getString( "D" ); + } + + /** + * This will set the string specifying the default directory in standard DOS syntax. + * + * @param d The default directory. + */ + public void setD( String d ) + { + action.setString( "D", d ); + } + + /** + * This will get the string specifying the operation to perform: + * open to open a document + * print to print a document + * If the F entry designates an application instead of a document, this entry + * is ignored and the application is launched. Default value: open. + * + * @return The O entry of the specific Windows launch parameter dictionary. + */ + public String getO() + { + return action.getString( "O" ); + } + + /** + * This will set the string specifying the operation to perform: + * open to open a document + * print to print a document + * If the F entry designates an application instead of a document, this entry + * is ignored and the application is launched. Default value: open. + * + * @param o The operation to perform. + */ + public void setO( String o ) + { + action.setString( "O", o ); + } + + /** + * This will get a parameter string to be passed to the application designated by the F entry. + * This entry should be omitted if F designates a document. + * + * @return The P entry of the specific Windows launch parameter dictionary. + */ + public String getP() + { + return action.getString( "P" ); + } + + /** + * This will set a parameter string to be passed to the application designated by the F entry. + * This entry should be omitted if F designates a document. + * + * @param p The parameter string. + */ + public void setP( String p ) + { + action.setString( "P", p ); + } + + /** + * This will specify whether to open the destination document in a new window. + * If this flag is false, the destination document will replace the current + * document in the same window. If this entry is absent, the viewer application + * should behave in accordance with the current user preference. This entry is + * ignored if the file designated by the F entry is not a PDF document. + * + * @return A flag specifying whether to open the destination document in a new window. + */ + public boolean shouldOpenInNewWindow() + { + return action.getBoolean( "NewWindow", true ); + } + + /** + * This will specify the destination document to open in a new window. + * + * @param value The flag value. + */ + public void setOpenInNewWindow( boolean value ) + { + action.setBoolean( "NewWindow", value ); + } +} \ No newline at end of file -- cgit v1.2.3