Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.action.type » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.action.type
public class: PDActionLaunch [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
      org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch

All Implemented Interfaces:
    PDDestinationOrAction

This represents a launch action that can be executed in a PDF document.
Field Summary
public static final  String SUB_TYPE    This type of action this object represents. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.action.type.PDAction:
TYPE,  action
Constructor:
 public PDActionLaunch() 
 public PDActionLaunch(COSDictionary a) 
    Constructor.
    Parameters:
    a - The action dictionary.
Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch Summary:
getD,   getF,   getFile,   getO,   getP,   getWinLaunchParams,   setD,   setF,   setFile,   setO,   setOpenInNewWindow,   setP,   setWinLaunchParams,   shouldOpenInNewWindow
Methods from org.apache.pdfbox.pdmodel.interactive.action.type.PDAction:
getCOSDictionary,   getCOSObject,   getNext,   getSubType,   getType,   setNext,   setSubType,   setType
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch Detail:
 public String getD() 
    This will get the string specifying the default directory in standard DOS syntax.
 public String getF() 
    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.
 public PDFileSpecification getFile() throws IOException 
    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.
 public String getO() 
    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.
 public String getP() 
    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.
 public PDWindowsLaunchParams getWinLaunchParams() 
    This will get a dictionary containing Windows-specific launch parameters.
 public  void setD(String d) 
    This will set the string specifying the default directory in standard DOS syntax.
 public  void setF(String 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.
 public  void setFile(PDFileSpecification fs) 
    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.
 public  void setO(String 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.
 public  void setOpenInNewWindow(boolean value) 
    This will specify the destination document to open in a new window.
 public  void setP(String 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.
 public  void setWinLaunchParams(PDWindowsLaunchParams win) 
    This will set a dictionary containing Windows-specific launch parameters.
 public boolean shouldOpenInNewWindow() 
    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.