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