com.lowagie.text.pdf
public class PdfAction extends PdfDictionary
PdfAction
defines an action that can be triggered from a PDF file.
See Also: PdfDictionary
Field Summary | |
---|---|
static int | FIRSTPAGE A named action to go to the first page. |
static int | LASTPAGE A named action to go to the last page. |
static int | NEXTPAGE A named action to go to the next page. |
static int | PREVPAGE A named action to go to the previous page. |
static int | PRINTDIALOG A named action to open a print dialog. |
static int | RESET_EXCLUDE a possible submitvalue |
static int | SUBMIT_CANONICAL_FORMAT a possible submitvalue |
static int | SUBMIT_COORDINATES a possible submitvalue |
static int | SUBMIT_EMBED_FORM a possible submitvalue |
static int | SUBMIT_EXCLUDE a possible submitvalue |
static int | SUBMIT_EXCL_F_KEY a possible submitvalue |
static int | SUBMIT_EXCL_NON_USER_ANNOTS a possible submitvalue |
static int | SUBMIT_HTML_FORMAT a possible submitvalue |
static int | SUBMIT_HTML_GET a possible submitvalue |
static int | SUBMIT_INCLUDE_ANNOTATIONS a possible submitvalue |
static int | SUBMIT_INCLUDE_APPEND_SAVES a possible submitvalue |
static int | SUBMIT_INCLUDE_NO_VALUE_FIELDS a possible submitvalue |
static int | SUBMIT_PDF a possible submitvalue |
static int | SUBMIT_XFDF a possible submitvalue |
Constructor Summary | |
---|---|
PdfAction() Create an empty action. | |
PdfAction(URL url)
Constructs a new PdfAction of Subtype URI.
| |
PdfAction(URL url, boolean isMap)
Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked. | |
PdfAction(String url)
Constructs a new PdfAction of Subtype URI.
| |
PdfAction(String url, boolean isMap)
Construct a new PdfAction of Subtype URI that accepts the x and y coordinate of the position that was clicked. | |
PdfAction(PdfIndirectReference destination)
Constructs a new PdfAction of Subtype GoTo. | |
PdfAction(String filename, String name)
Constructs a new PdfAction of Subtype GoToR. | |
PdfAction(String filename, int page)
Constructs a new PdfAction of Subtype GoToR. | |
PdfAction(int named) Implements name actions. | |
PdfAction(String application, String parameters, String operation, String defaultDir) Launches an application or a document. |
Method Summary | |
---|---|
static PdfArray | buildArray(Object[] names) |
static PdfAction | createHide(PdfObject obj, boolean hide)
A Hide action hides or shows an object. |
static PdfAction | createHide(PdfAnnotation annot, boolean hide)
A Hide action hides or shows an annotation. |
static PdfAction | createHide(String name, boolean hide)
A Hide action hides or shows an annotation. |
static PdfAction | createHide(Object[] names, boolean hide)
A Hide action hides or shows objects. |
static PdfAction | createImportData(String file)
Creates an Import field. |
static PdfAction | createLaunch(String application, String parameters, String operation, String defaultDir) Launches an application or a document. |
static PdfAction | createResetForm(Object[] names, int flags)
Creates a resetform. |
static PdfAction | createSubmitForm(String file, Object[] names, int flags)
Creates a submit form. |
static PdfAction | gotoEmbedded(String filename, PdfTargetDictionary target, String dest, boolean isName, boolean newWindow)
Creates a GoToE action to an embedded file. |
static PdfAction | gotoEmbedded(String filename, PdfTargetDictionary target, PdfObject dest, boolean newWindow)
Creates a GoToE action to an embedded file. |
static PdfAction | gotoLocalPage(int page, PdfDestination dest, PdfWriter writer) Creates a GoTo action to an internal page. |
static PdfAction | gotoLocalPage(String dest, boolean isName)
Creates a GoTo action to a named destination. |
static PdfAction | gotoRemotePage(String filename, String dest, boolean isName, boolean newWindow)
Creates a GoToR action to a named destination. |
static PdfAction | javaScript(String code, PdfWriter writer, boolean unicode) Creates a JavaScript action. |
static PdfAction | javaScript(String code, PdfWriter writer) Creates a JavaScript action. |
void | next(PdfAction na) Add a chained action. |
static PdfAction | rendition(String file, PdfFileSpecification fs, String mimeType, PdfIndirectReference ref) Creates a Rendition action |
static PdfAction | setOCGstate(ArrayList state, boolean preserveRB)
A set-OCG-state action (PDF 1.5) sets the state of one or more optional content
groups. |
PdfAction
of Subtype URI.
Parameters: url the Url to go to
PdfAction
of Subtype URI that accepts the x and y coordinate of the position that was clicked.Parameters: url isMap
PdfAction
of Subtype URI.
Parameters: url the url to go to
PdfAction
of Subtype URI that accepts the x and y coordinate of the position that was clicked.Parameters: url isMap
PdfAction
of Subtype GoTo.Parameters: destination the destination to go to
PdfAction
of Subtype GoToR.Parameters: filename the file name to go to name the named destination to go to
PdfAction
of Subtype GoToR.Parameters: filename the file name to go to page the page destination to go to
Parameters: named the named action
Parameters: application the application to be launched or the document to be opened or printed. parameters (Windows-specific) A parameter string to be passed to the application.
It can be null
. operation (Windows-specific) the operation to perform: "open" - Open a document,
"print" - Print a document.
It can be null
. defaultDir (Windows-specific) the default directory in standard DOS syntax.
It can be null
.
Parameters: obj object to hide or show hide true is hide, false is show
Returns: a Hide Action
Parameters: annot hide
Returns: A Hide Action
Parameters: name hide
Returns: A Hide Action
Parameters: names hide
Returns: A Hide Action
Parameters: file
Returns: A PdfAction
Parameters: application the application to be launched or the document to be opened or printed. parameters (Windows-specific) A parameter string to be passed to the application.
It can be null
. operation (Windows-specific) the operation to perform: "open" - Open a document,
"print" - Print a document.
It can be null
. defaultDir (Windows-specific) the default directory in standard DOS syntax.
It can be null
.
Returns: a Launch action
Parameters: names the objects to reset flags submit properties
Returns: A PdfAction
Parameters: file the URI to submit the form to names the objects to submit flags submit properties
Returns: A PdfAction
Parameters: filename the root document of the target (null if the target is in the same document) dest the named destination isName if true sets the destination as a name, if false sets it as a String
Returns: a GoToE action
Parameters: filename the root document of the target (null if the target is in the same document) target a path to the target document of this action dest the destination inside the target document, can be of type PdfDestination, PdfName, or PdfString newWindow if true, the destination document should be opened in a new window
Returns: a GoToE action
Parameters: page the page to go. First page is 1 dest the destination for the page writer the writer for this action
Returns: a GoTo action
Parameters: dest the named destination isName if true sets the destination as a name, if false sets it as a String
Returns: a GoTo action
Parameters: filename the file name to go to dest the destination name isName if true sets the destination as a name, if false sets it as a String newWindow open the document in a new window if true
, if false the current document is replaced by the new document.
Returns: a GoToR action
Parameters: code the JavaScript code writer the writer for this action unicode select JavaScript unicode. Note that the internal Acrobat JavaScript engine does not support unicode, so this may or may not work for you
Returns: the JavaScript action
Parameters: code the JavaScript code writer the writer for this action
Returns: the JavaScript action
Parameters: na the next action
Parameters: file fs mimeType ref
Returns: a Media Clip action
Throws: IOException
Parameters: state an array consisting of any number of sequences beginning with a PdfName
or String
(ON, OFF, or Toggle) followed by one or more optional content group dictionaries
PdfLayer
or a PdfIndirectReference
to a PdfLayer
.
The array elements are processed from left to right; each name is applied
to the subsequent groups until the next name is encountered:
preserveRB if true
, indicates that radio-button state relationships between optional
content groups (as specified by the RBGroups entry in the current configuration
dictionary) should be preserved when the states in the
state
array are applied. That is, if a group is set to ON (either by ON or Toggle) during
processing of the state
array, any other groups belong to the same radio-button
group are turned OFF. If a group is set to OFF, there is no effect on other groups.
If false
, radio-button state relationships, if any, are ignored
Returns: the action