Package | Description |
---|---|
org.apache.pdfbox.pdmodel.fdf |
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
|
org.apache.pdfbox.pdmodel.interactive.action |
This package represents actions that can be performed in a PDF document.
|
org.apache.pdfbox.pdmodel.interactive.annotation |
The annotation package contains classes that work with PDF annotation elements.
|
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline |
The outline package allows for a PDF outline(bookmarks) to be created.
|
Modifier and Type | Method and Description |
---|---|
PDAction |
FDFField.getAction()
This will get the action that is associated with this field.
|
Modifier and Type | Method and Description |
---|---|
void |
FDFField.setAction(PDAction a)
This will set the action that is associated with this field.
|
Modifier and Type | Class and Description |
---|---|
class |
PDActionEmbeddedGoTo
This represents a embedded go-to action that can be executed in a PDF document.
|
class |
PDActionGoTo
This represents a go-to action that can be executed in a PDF document.
|
class |
PDActionHide
This represents a thread action that can be executed in a PDF document.
|
class |
PDActionImportData |
class |
PDActionJavaScript
This represents a JavaScript action.
|
class |
PDActionLaunch
This represents a launch action that can be executed in a PDF document.
|
class |
PDActionMovie |
class |
PDActionNamed
This represents a named action in a PDF document.
|
class |
PDActionRemoteGoTo
This represents a remote go-to action that can be executed in a PDF document.
|
class |
PDActionResetForm |
class |
PDActionSound
This represents a Sound action that can be executed in a PDF document
|
class |
PDActionSubmitForm
This represents a Submit-Form action that can be executed in a PDF document.
|
class |
PDActionThread
This represents a thread action that can be executed in a PDF document.
|
class |
PDActionURI
This represents a URI action that can be executed in a PDF document.
|
Modifier and Type | Method and Description |
---|---|
static PDAction |
PDActionFactory.createAction(COSDictionary action)
This will create the correct type of action based on the type specified
in the dictionary.
|
PDAction |
PDAnnotationAdditionalActions.getBl()
This will get an action to be performed when the annotation
loses the input focus.
|
PDAction |
PDPageAdditionalActions.getC()
This will get an action to be performed when the page
is closed.
|
PDAction |
PDFormFieldAdditionalActions.getC()
This will get a JavaScript action to be performed in order to recalculate
the value of this field when that of another field changes.
|
PDAction |
PDAnnotationAdditionalActions.getD()
This will get an action to be performed when the mouse button
is pressed inside the annotation's active area.
|
PDAction |
PDDocumentCatalogAdditionalActions.getDP()
This will get a JavaScript action to be performed
after printing a document.
|
PDAction |
PDDocumentCatalogAdditionalActions.getDS()
This will get a JavaScript action to be performed
after saving a document.
|
PDAction |
PDAnnotationAdditionalActions.getE()
This will get an action to be performed when the cursor
enters the annotation's active area.
|
PDAction |
PDFormFieldAdditionalActions.getF()
This will get a JavaScript action to be performed before
the field is formatted to display its current value.
|
PDAction |
PDAdditionalActions.getF()
Get the F action.
|
PDAction |
PDAnnotationAdditionalActions.getFo()
This will get an action to be performed when the annotation
receives the input focus.
|
PDAction |
PDFormFieldAdditionalActions.getK()
This will get a JavaScript action to be performed when the user
types a keystroke into a text field or combo box or modifies the
selection in a scrollable list box.
|
PDAction |
PDPageAdditionalActions.getO()
This will get an action to be performed when the page
is opened.
|
PDAction |
PDAnnotationAdditionalActions.getPC()
This will get an action to be performed when the page containing
the annotation is closed.
|
PDAction |
PDAnnotationAdditionalActions.getPI()
This will get an action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
|
PDAction |
PDAnnotationAdditionalActions.getPO()
This will get an action to be performed when the page containing
the annotation is opened.
|
PDAction |
PDAnnotationAdditionalActions.getPV()
This will get an action to be performed when the page containing
the annotation becomes visible in the viewer application's user interface.
|
PDAction |
PDAnnotationAdditionalActions.getU()
This will get an action to be performed when the mouse button
is released inside the annotation's active area.
|
PDAction |
PDFormFieldAdditionalActions.getV()
This will get a JavaScript action to be performed
when the field's value is changed.
|
PDAction |
PDDocumentCatalogAdditionalActions.getWC()
This will get a JavaScript action to be performed
before closing a document.
|
PDAction |
PDDocumentCatalogAdditionalActions.getWP()
This will get a JavaScript action to be performed
before printing a document.
|
PDAction |
PDDocumentCatalogAdditionalActions.getWS()
This will get a JavaScript action to be performed
before saving a document.
|
PDAction |
PDAnnotationAdditionalActions.getX()
This will get an action to be performed when the cursor
exits the annotation's active area.
|
Modifier and Type | Method and Description |
---|---|
List<PDAction> |
PDAction.getNext()
This will get the next action, or sequence of actions, to be performed after this one.
|
Modifier and Type | Method and Description |
---|---|
void |
PDAnnotationAdditionalActions.setBl(PDAction bl)
This will set an action to be performed when the annotation
loses the input focus.
|
void |
PDPageAdditionalActions.setC(PDAction c)
This will set an action to be performed when the page
is closed.
|
void |
PDFormFieldAdditionalActions.setC(PDAction c)
This will set a JavaScript action to be performed in order to recalculate
the value of this field when that of another field changes.
|
void |
PDAnnotationAdditionalActions.setD(PDAction d)
This will set an action to be performed when the mouse button
is pressed inside the annotation's active area.
|
void |
PDDocumentCatalogAdditionalActions.setDP(PDAction dp)
This will set a JavaScript action to be performed
after printing a document.
|
void |
PDDocumentCatalogAdditionalActions.setDS(PDAction ds)
This will set a JavaScript action to be performed
after saving a document.
|
void |
PDAnnotationAdditionalActions.setE(PDAction e)
This will set an action to be performed when the cursor
enters the annotation's active area.
|
void |
PDFormFieldAdditionalActions.setF(PDAction f)
This will set a JavaScript action to be performed before
the field is formatted to display its current value.
|
void |
PDAdditionalActions.setF(PDAction action)
Set the F action.
|
void |
PDAnnotationAdditionalActions.setFo(PDAction fo)
This will set an action to be performed when the annotation
receives the input focus.
|
void |
PDFormFieldAdditionalActions.setK(PDAction k)
This will set a JavaScript action to be performed when the user
types a keystroke into a text field or combo box or modifies the
selection in a scrollable list box.
|
void |
PDPageAdditionalActions.setO(PDAction o)
This will set an action to be performed when the page
is opened.
|
void |
PDAnnotationAdditionalActions.setPC(PDAction pc)
This will set an action to be performed when the page containing
the annotation is closed.
|
void |
PDAnnotationAdditionalActions.setPI(PDAction pi)
This will set an action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
|
void |
PDAnnotationAdditionalActions.setPO(PDAction po)
This will set an action to be performed when the page containing
the annotation is opened.
|
void |
PDAnnotationAdditionalActions.setPV(PDAction pv)
This will set an action to be performed when the page containing
the annotation becomes visible in the viewer application's user interface.
|
void |
PDAnnotationAdditionalActions.setU(PDAction u)
This will set an action to be performed when the mouse button
is released inside the annotation's active area.
|
void |
PDFormFieldAdditionalActions.setV(PDAction v)
This will set a JavaScript action to be performed
when the field's value is changed.
|
void |
PDDocumentCatalogAdditionalActions.setWC(PDAction wc)
This will set a JavaScript action to be performed
before closing a document.
|
void |
PDDocumentCatalogAdditionalActions.setWP(PDAction wp)
This will set a JavaScript action to be performed
before printing a document.
|
void |
PDDocumentCatalogAdditionalActions.setWS(PDAction ws)
This will set a JavaScript action to be performed
before saving a document.
|
void |
PDAnnotationAdditionalActions.setX(PDAction x)
This will set an action to be performed when the cursor
exits the annotation's active area.
|
Modifier and Type | Method and Description |
---|---|
PDAction |
PDAnnotationWidget.getAction()
Get the action to be performed when this annotation is to be activated.
|
PDAction |
PDAnnotationLink.getAction()
Get the action to be performed when this annotation is to be activated.
|
Modifier and Type | Method and Description |
---|---|
void |
PDAnnotationWidget.setAction(PDAction action)
Set the annotation action.
|
void |
PDAnnotationLink.setAction(PDAction action)
Set the annotation action.
|
Modifier and Type | Method and Description |
---|---|
PDAction |
PDOutlineItem.getAction()
Get the action of this node.
|
Modifier and Type | Method and Description |
---|---|
void |
PDOutlineItem.setAction(PDAction action)
Set the action for this node.
|
Copyright © 2002–2018 The Apache Software Foundation. All rights reserved.