|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.interactive.action.type.PDAction
org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
public class PDActionLaunch
This represents a launch action that can be executed in a PDF document.
Field Summary | |
---|---|
static java.lang.String |
SUB_TYPE
This type of action this object represents. |
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction |
---|
action, TYPE |
Constructor Summary | |
---|---|
PDActionLaunch()
Default constructor. |
|
PDActionLaunch(COSDictionary a)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
getD()
This will get the string specifying the default directory in standard DOS syntax. |
java.lang.String |
getF()
This will get the file name to be launched or the document to be opened or printed, in standard Windows pathname format. |
PDFileSpecification |
getFile()
This will get the application to be launched or the document to be opened or printed. |
java.lang.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. |
java.lang.String |
getP()
This will get a parameter string to be passed to the application designated by the F entry. |
PDWindowsLaunchParams |
getWinLaunchParams()
This will get a dictionary containing Windows-specific launch parameters. |
void |
setD(java.lang.String d)
This will set the string specifying the default directory in standard DOS syntax. |
void |
setF(java.lang.String f)
This will set the file name to be launched or the document to be opened or printed, in standard Windows pathname format. |
void |
setFile(PDFileSpecification fs)
This will set the application to be launched or the document to be opened or printed. |
void |
setO(java.lang.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. |
void |
setOpenInNewWindow(boolean value)
This will specify the destination document to open in a new window. |
void |
setP(java.lang.String p)
This will set a parameter string to be passed to the application designated by the F entry. |
void |
setWinLaunchParams(PDWindowsLaunchParams win)
This will set a dictionary containing Windows-specific launch parameters. |
boolean |
shouldOpenInNewWindow()
This will specify whether to open the destination document in a new window. |
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction |
---|
getCOSDictionary, getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SUB_TYPE
Constructor Detail |
---|
public PDActionLaunch()
public PDActionLaunch(COSDictionary a)
a
- The action dictionary.Method Detail |
---|
public PDFileSpecification getFile() throws java.io.IOException
java.io.IOException
- If there is an error creating the file spec.public void setFile(PDFileSpecification fs)
fs
- The file specification.public PDWindowsLaunchParams getWinLaunchParams()
public void setWinLaunchParams(PDWindowsLaunchParams win)
win
- The action to be performed.public java.lang.String getF()
public void setF(java.lang.String f)
f
- The file name to be launched.public java.lang.String getD()
public void setD(java.lang.String d)
d
- The default directory.public java.lang.String getO()
public void setO(java.lang.String o)
o
- The operation to perform.public java.lang.String getP()
public void setP(java.lang.String p)
p
- The parameter string.public boolean shouldOpenInNewWindow()
public void setOpenInNewWindow(boolean value)
value
- The flag value.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |