Package | Description |
---|---|
com.itextpdf.kernel.pdf | |
com.itextpdf.kernel.pdf.action | |
com.itextpdf.kernel.pdf.annot |
Modifier and Type | Method and Description |
---|---|
void |
PdfOutline.addAction(PdfAction action)
Adds
PdfAction for the outline, A key. |
PdfCatalog |
PdfCatalog.setAdditionalAction(PdfName key,
PdfAction action)
The actions that shall be taken in response to various trigger events affecting the document as a whole.
|
PdfPage |
PdfPage.setAdditionalAction(PdfName key,
PdfAction action)
Helper method to add an additional action to this page.
|
PdfCatalog |
PdfCatalog.setOpenAction(PdfAction action)
A value specifying an action that shall be performed when the document is opened.
|
Modifier and Type | Method and Description |
---|---|
static PdfAction |
PdfAction.createGoTo(PdfDestination destination)
Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given destination.
|
static PdfAction |
PdfAction.createGoTo(String destination)
Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given
PdfStringDestination name. |
static PdfAction |
PdfAction.createGoToE(PdfDestination destination,
boolean newWindow,
PdfTarget targetDictionary)
Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToE(PdfFileSpec fileSpec,
PdfDestination destination,
boolean newWindow,
PdfTarget targetDictionary)
Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(PdfFileSpec fileSpec,
PdfDestination destination)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(PdfFileSpec fileSpec,
PdfDestination destination,
boolean newWindow)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(String filename,
int pageNum)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(String filename,
int pageNum,
boolean newWindow)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(String filename,
String destination)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createGoToR(String filename,
String destination,
boolean newWindow)
Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createHide(PdfAnnotation[] annotations,
boolean hidden)
Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
|
static PdfAction |
PdfAction.createHide(PdfAnnotation annotation,
boolean hidden)
Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
|
static PdfAction |
PdfAction.createHide(String[] text,
boolean hidden)
Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
|
static PdfAction |
PdfAction.createHide(String text,
boolean hidden)
Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
|
static PdfAction |
PdfAction.createJavaScript(String javaScript)
Creates a JavaScript action (section 12.6.4.16 of ISO 32000-1).
|
static PdfAction |
PdfAction.createLaunch(PdfFileSpec fileSpec)
Creates a Launch action (section 12.6.4.5 of ISO 32000-1).
|
static PdfAction |
PdfAction.createLaunch(PdfFileSpec fileSpec,
boolean newWindow)
Creates a Launch action (section 12.6.4.5 of ISO 32000-1).
|
static PdfAction |
PdfAction.createMovie(PdfAnnotation annotation,
String title,
PdfName operation)
Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1).
|
static PdfAction |
PdfAction.createNamed(PdfName namedAction)
Creates a Named action (section 12.6.4.11 of ISO 32000-1).
|
static PdfAction |
PdfAction.createRendition(String file,
PdfFileSpec fileSpec,
String mimeType,
PdfAnnotation screenAnnotation)
Creates a Rendition action (section 12.6.4.13 of ISO 32000-1).
|
static PdfAction |
PdfAction.createResetForm(Object[] names,
int flags)
Creates a Reset-Form Action (section 12.7.5.3 of ISO 32000-1).
|
static PdfAction |
PdfAction.createSetOcgState(List<PdfActionOcgState> states)
Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).
|
static PdfAction |
PdfAction.createSetOcgState(List<PdfActionOcgState> states,
boolean preserveRb)
Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).
|
static PdfAction |
PdfAction.createSound(PdfStream sound)
Creates a Sound action (section 12.6.4.8 of ISO 32000-1).
|
static PdfAction |
PdfAction.createSound(PdfStream sound,
float volume,
boolean synchronous,
boolean repeat,
boolean mix)
Creates a Sound action (section 12.6.4.8 of ISO 32000-1).
|
static PdfAction |
PdfAction.createSubmitForm(String file,
Object[] names,
int flags)
Creates a Submit-Form Action (section 12.7.5.2 of ISO 32000-1).
|
static PdfAction |
PdfAction.createThread(PdfFileSpec fileSpec)
Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
|
static PdfAction |
PdfAction.createThread(PdfFileSpec fileSpec,
PdfObject destinationThread,
PdfObject bead)
Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
|
static PdfAction |
PdfAction.createURI(String uri)
Creates a URI action (section 12.6.4.7 of ISO 32000-1).
|
static PdfAction |
PdfAction.createURI(String uri,
boolean isMap)
Creates a URI action (section 12.6.4.7 of ISO 32000-1).
|
PdfAction |
PdfAnnotationAdditionalActions.getOnEnter()
Returns the
PdfAction for the OnEnter event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnExit()
Returns the
PdfAction for the OnExit event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnFocus()
Returns the
PdfAction for the OnFocus event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnLostFocus()
Returns the
PdfAction for the OnLostFocus event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnMouseDown()
Returns the
PdfAction for the OnMouseDown event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnMouseUp()
Returns the
PdfAction for the OnMouseUp event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnPageClosed()
Returns the
PdfAction for the OnPageClosed event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnPageLostView()
Returns the
PdfAction for the OnPageLostView event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnPageOpened()
Returns the
PdfAction for the OnPageOpened event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getOnPageVisible()
Returns the
PdfAction for the OnPageVisible event if there is any, or null. |
PdfAction |
PdfAnnotationAdditionalActions.getPdfActionForEvent(PdfName eventName)
If exists, returns the
PdfAction for this event, otherwise returns null. |
PdfAction |
PdfAction.put(PdfName key,
PdfObject value)
Inserts the value into the underlying object of this
PdfAction and associates it with the specified key. |
Modifier and Type | Method and Description |
---|---|
List<PdfAction> |
PdfAnnotationAdditionalActions.getAllKnownActions()
Lists every
PdfAction for all documented events for an annotation's additional actions. |
Modifier and Type | Method and Description |
---|---|
void |
PdfAction.next(PdfAction nextAction)
Adds a chained action.
|
static void |
PdfAction.setAdditionalAction(PdfObjectWrapper<PdfDictionary> wrapper,
PdfName key,
PdfAction action)
Adds an additional action to the provided
PdfObjectWrapper <PdfDictionary > wrapper. |
void |
PdfAnnotationAdditionalActions.setOnEnter(PdfAction action)
Sets the
PdfAction to perform on the OnEnter event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnExit(PdfAction action)
Sets the
PdfAction to perform on the OnExit event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnFocus(PdfAction action)
Sets the
PdfAction to perform on the OnFocus event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnLostFocus(PdfAction action)
Sets the
PdfAction to perform on the OnLostFocus event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnMouseDown(PdfAction action)
Sets the
PdfAction to perform on the OnMouseDown event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnMouseUp(PdfAction action)
Sets the
PdfAction to perform on the OnMouseUp event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnPageClosed(PdfAction action)
Sets the
PdfAction to perform on the OnPageClosed event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnPageLostView(PdfAction action)
Sets the
PdfAction to perform on the OnPageLostView event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnPageOpened(PdfAction action)
Sets the
PdfAction to perform on the OnPageOpened event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setOnPageVisible(PdfAction action)
Sets the
PdfAction to perform on the OnPageVisible event, or removes it when action is null. |
void |
PdfAnnotationAdditionalActions.setPdfActionForEvent(PdfName event,
PdfAction action)
Sets the action for an event, or removes it when the action is null.
|
Modifier and Type | Method and Description |
---|---|
PdfLinkAnnotation |
PdfLinkAnnotation.setAction(PdfAction action)
Sets a
PdfAction to this annotation which will be performed when the annotation is activated. |
PdfWidgetAnnotation |
PdfWidgetAnnotation.setAction(PdfAction action)
Sets a
PdfAction to this annotation which will be performed when the annotation is activated. |
PdfScreenAnnotation |
PdfScreenAnnotation.setAction(PdfAction action)
Sets a
PdfAction to this annotation which will be performed when the annotation is activated. |
PdfWidgetAnnotation |
PdfWidgetAnnotation.setAdditionalAction(PdfName key,
PdfAction action)
Sets an additional
PdfAction to this annotation which will be performed in response to
the specific trigger event defined by key . |
PdfScreenAnnotation |
PdfScreenAnnotation.setAdditionalAction(PdfName key,
PdfAction action)
Sets an additional
PdfAction to this annotation which will be performed in response to
the specific trigger event defined by key . |
PdfLinkAnnotation |
PdfLinkAnnotation.setUriAction(PdfAction action)
Sets the annotation URI action as
PdfAction instance. |
Copyright © 1998–2023 Apryse Group NV. All rights reserved.