Uses of Class
org.apache.pdfbox.pdmodel.interactive.action.type.PDAction

Packages that use PDAction
Package
Description
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
This package represents actions that can be performed in a PDF document.
This package contains all of the available PDF action types.
The annotation package contains classes that work with PDF annotation elements.
The outline package allows for a PDF outline(bookmarks) to be created.
  • Uses of PDAction in org.apache.pdfbox.pdmodel.fdf

    Modifier and Type
    Method
    Description
    FDFField.getAction()
    This will get the action that is associated with this field.
    Methods in org.apache.pdfbox.pdmodel.fdf with parameters of type PDAction
    Modifier and Type
    Method
    Description
    void
    FDFField.setAction(PDAction a)
    This will set the action that is associated with this field.
  • Uses of PDAction in org.apache.pdfbox.pdmodel.interactive.action

    Modifier and Type
    Method
    Description
    static PDAction
    PDActionFactory.createAction(COSDictionary action)
    This will create the correct type of action based on the type specified in the dictionary.
    PDAnnotationAdditionalActions.getBl()
    This will get an action to be performed when the annotation loses the input focus.
    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.
    PDPageAdditionalActions.getC()
    This will get an action to be performed when the page is closed.
    PDAnnotationAdditionalActions.getD()
    This will get an action to be performed when the mouse button is pressed inside the annotation's active area.
    PDDocumentCatalogAdditionalActions.getDP()
    This will get a JavaScript action to be performed after printing a document.
    PDDocumentCatalogAdditionalActions.getDS()
    This will get a JavaScript action to be performed after saving a document.
    PDAnnotationAdditionalActions.getE()
    This will get an action to be performed when the cursor enters the annotation's active area.
    PDAdditionalActions.getF()
    Get the F action.
    PDFormFieldAdditionalActions.getF()
    This will get a JavaScript action to be performed before the field is formatted to display its current value.
    PDAnnotationAdditionalActions.getFo()
    This will get an action to be performed when the annotation receives the input focus.
    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.
    PDPageAdditionalActions.getO()
    This will get an action to be performed when the page is opened.
    PDAnnotationAdditionalActions.getPC()
    This will get an action to be performed when the page containing the annotation is closed.
    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.
    PDAnnotationAdditionalActions.getPO()
    This will get an action to be performed when the page containing the annotation is opened.
    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.
    PDAnnotationAdditionalActions.getU()
    This will get an action to be performed when the mouse button is released inside the annotation's active area.
    PDFormFieldAdditionalActions.getV()
    This will get a JavaScript action to be performed when the field's value is changed.
    PDDocumentCatalogAdditionalActions.getWC()
    This will get a JavaScript action to be performed before closing a document.
    PDDocumentCatalogAdditionalActions.getWP()
    This will get a JavaScript action to be performed before printing a document.
    PDDocumentCatalogAdditionalActions.getWS()
    This will get a JavaScript action to be performed before saving a document.
    PDAnnotationAdditionalActions.getX()
    This will get an action to be performed when the cursor exits the annotation's active area.
    Methods in org.apache.pdfbox.pdmodel.interactive.action with parameters of type PDAction
    Modifier and Type
    Method
    Description
    void
    PDAnnotationAdditionalActions.setBl(PDAction bl)
    This will set an action to be performed when the annotation loses the input focus.
    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
    PDPageAdditionalActions.setC(PDAction c)
    This will set an action to be performed when the page is closed.
    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
    PDAdditionalActions.setF(PDAction action)
    Set the F action.
    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
    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.
  • Uses of PDAction in org.apache.pdfbox.pdmodel.interactive.action.type

    Modifier and Type
    Class
    Description
    class 
    This represents a go-to action that can be executed in a PDF document.
    class 
    This represents a JavaScript action.
    class 
    This represents a launch action that can be executed in a PDF document.
    class 
    This represents a named action in a PDF document.
    class 
    This represents a remote go-to action that can be executed in a PDF document.
    class 
    This represents a URI action that can be executed in a PDF document.
  • Uses of PDAction in org.apache.pdfbox.pdmodel.interactive.annotation

    Modifier and Type
    Method
    Description
    PDAnnotationLink.getAction()
    Get the action to be performed when this annotation is to be activated.
    PDAnnotationWidget.getAction()
    Get the action to be performed when this annotation is to be activated.
    Modifier and Type
    Method
    Description
    void
    PDAnnotationLink.setAction(PDAction action)
    Set the annotation action.
    void
    PDAnnotationWidget.setAction(PDAction action)
    Set the annotation action.
  • Uses of PDAction in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline

    Modifier and Type
    Method
    Description
    PDOutlineItem.getAction()
    Get the action of this node.
    Modifier and Type
    Method
    Description
    void
    PDOutlineItem.setAction(PDAction action)
    Set the action for this node.