Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch Detail: |
public String getD() {
return action.getString( "D" );
}
This will get the string specifying the default directory in standard DOS syntax. |
public String getF() {
return action.getString( "F" );
}
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 {
return PDFileSpecification.createFS( getCOSDictionary().getDictionaryObject( "F" ) );
}
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() {
return action.getString( "O" );
}
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() {
return action.getString( "P" );
}
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() {
COSDictionary win = (COSDictionary)action.getDictionaryObject( "Win" );
PDWindowsLaunchParams retval = null;
if( win != null )
{
retval = new PDWindowsLaunchParams( win );
}
return retval;
}
This will get a dictionary containing Windows-specific launch parameters. |
public void setD(String d) {
action.setString( "D", d );
}
This will set the string specifying the default directory in standard DOS syntax. |
public void setF(String f) {
action.setString( "F", 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) {
getCOSDictionary().setItem( "F", 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) {
action.setString( "O", 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) {
action.setBoolean( "NewWindow", value );
}
This will specify the destination document to open in a new window. |
public void setP(String p) {
action.setString( "P", 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) {
action.setItem( "Win", win );
}
This will set a dictionary containing Windows-specific launch parameters. |
public boolean shouldOpenInNewWindow() {
return action.getBoolean( "NewWindow", true );
}
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. |