AdditionalActionsDictionary (ICEpdf API)

java.lang.Object
- org.icepdf.core.pobjects.Dictionary
- - org.icepdf.core.pobjects.acroform.AdditionalActionsDictionary

```
public class AdditionalActionsDictionary
extends Dictionary
```
An annotation, page object, or (beginning with PDF 1.3) interactive form field may include an entry named AA that specifies an additional-actions dictionary (PDF 1.2) that extends the set of events that can trigger the execution of an action. In PDF 1.4, the document catalogue dictionary (see 7.7.2, “Document Catalog”) may also contain an AA entry for trigger events affecting the document as a whole. Tables 194 to 197 show the contents of this type of dictionary.
PDF 1.5 introduces four trigger events in annotation’s additional-actions dictionary to support multimedia presentations:
- The PO and PC entries have a similar function to the O and C entries in the page object’s additional-actions dictionary (see Table 194). However, associating these triggers with annotations allows annotation objects to be self-contained.
- The PV and PI entries allow a distinction between pages that are open and pages that are visible. At any one time, while more than one page may be visible, depending on the page layout.
Since:

5.2

Field Summary

Fields
Modifier and Type	Field and Description
`static Name`	`ANNOTATION_Bl_KEY` (Optional; PDF 1.2; widget annotations only) (Uppercase B, lowercase L) An action that shall be performed when the annotation loses the input focus.
`static Name`	`ANNOTATION_D_KEY` Optional; PDF 1.2) An action that shall be performed when the mouse button is pressed inside the annotation’s active area.
`static Name`	`ANNOTATION_E_KEY` (Optional; PDF 1.2) An action that shall be performed when the cursor enters the annotation’s active area.
`static Name`	`ANNOTATION_FO_KEY` (Optional; PDF 1.2; widget annotations only) An action that shall be performed when the annotation receives the input focus.
`static Name`	`ANNOTATION_PC_KEY` (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is closed.
`static Name`	`ANNOTATION_PI_KEY` (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.
`static Name`	`ANNOTATION_PO_KEY` (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is opened.
`static Name`	`ANNOTATION_PV_KEY` (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation becomes visible.
`static Name`	`ANNOTATION_U_KEY` (Optional; PDF 1.2) An action that shall be performed when the mouse button is released inside the annotation’s active area.
`static Name`	`ANNOTATION_X_KEY` (Optional; PDF 1.2) An action that shall be performed when the cursor exits the annotation’s active area.
`static Name`	`CATALOG_DP_KEY` (Optional; PDF 1.4) A JavaScript action that shall be performed after printing a document.
`static Name`	`CATALOG_DS_KEY` (Optional; PDF 1.4) A JavaScript action that shall be performed after saving a document.
`static Name`	`CATALOG_WC_KEY` (Optional; PDF 1.4) A JavaScript action that shall be performed before closing a document.
`static Name`	`CATALOG_WP_KEY` (Optional; PDF 1.4) A JavaScript action that shall be performed before printing a document.
`static Name`	`CATALOG_WS_KEY` (Optional; PDF 1.4) A JavaScript action that shall be performed before saving a document.
`static Name`	`FORM_C_KEY` (Optional; PDF 1.3) A JavaScript action that shall be performed to recalculate the value of this field when that of another field changes.
`static Name`	`FORM_F_KEY` (Optional; PDF 1.3) A JavaScript action that shall be performed before the field is formatted to display its value.
`static Name`	`FORM_K_KEY` (Optional; PDF 1.3) A JavaScript action that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.
`static Name`	`FORM_V_KEY` (Optional; PDF 1.3) A JavaScript action that shall be performed when the field’s value is changed.
`static Name`	`PAGE_0_KEY` Optional; PDF 1.2) An action that shall be performed when the page is opened (for example, when the user navigates to it from the next or previous page or by means of a link annotation or outline item).
`static Name`	`PAGE_C_KEY` (Optional; PDF 1.2) An action that shall be performed when the page is closed (for example, when the user navigates to the next or previous page or follows a link annotation or an outline item).

Fields inherited from class org.icepdf.core.pobjects.Dictionary
entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors
Constructor and Description

AdditionalActionsDictionary(Library library, java.util.HashMap entries)

Constructors
Constructor and Description
`AdditionalActionsDictionary(Library library, java.util.HashMap entries)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Action`	`getAction(Name actionNameKey)`
`boolean`	`isAnnotationBIValue()`
`boolean`	`isAnnotationDValue()`
`boolean`	`isAnnotationEValue()`
`boolean`	`isAnnotationFOValue()`
`boolean`	`isAnnotationPCValue()`
`boolean`	`isAnnotationPIValue()`
`boolean`	`isAnnotationPOValue()`
`boolean`	`isAnnotationPVValue()`
`boolean`	`isAnnotationUValue()`
`boolean`	`isAnnotationValue(Name actionKey)`
`boolean`	`isAnnotationXValue()`
`boolean`	`isCatalogDPValue()`
`boolean`	`isCatalogDSValue()`
`boolean`	`isCatalogWCValue()`
`boolean`	`isCatalogWPValue()`
`boolean`	`isCatalogWSValue()`
`boolean`	`isFormCValue()`
`boolean`	`isFormFValue()`
`boolean`	`isFormKValue()`
`boolean`	`isFormVValue()`
`boolean`	`isPageCValue()`
`boolean`	`isPageOValue()`

Methods inherited from class org.icepdf.core.pobjects.Dictionary
getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ANNOTATION_E_KEY
```
public static final Name ANNOTATION_E_KEY
```
    (Optional; PDF 1.2) An action that shall be performed when the cursor enters the annotation’s active area. An E (enter) event may occur only when the mouse button is up.
  - ANNOTATION_X_KEY
```
public static final Name ANNOTATION_X_KEY
```
    (Optional; PDF 1.2) An action that shall be performed when the cursor exits the annotation’s active area. An X (exit) event may not occur without a preceding E event.
  - ANNOTATION_D_KEY
```
public static final Name ANNOTATION_D_KEY
```
    Optional; PDF 1.2) An action that shall be performed when the mouse button is pressed inside the annotation’s active area.
  - ANNOTATION_U_KEY
```
public static final Name ANNOTATION_U_KEY
```
    (Optional; PDF 1.2) An action that shall be performed when the mouse button is released inside the annotation’s active area.
    For backward compatibility, the A entry in an annotation dictionary, if present, takes precedence over this entry (see Table 168). A U (up) event may not occur without a preceding E and D event.
  - ANNOTATION_FO_KEY
```
public static final Name ANNOTATION_FO_KEY
```
    (Optional; PDF 1.2; widget annotations only) An action that shall be performed when the annotation receives the input focus.
  - ANNOTATION_Bl_KEY
```
public static final Name ANNOTATION_Bl_KEY
```
    (Optional; PDF 1.2; widget annotations only) (Uppercase B, lowercase L) An action that shall be performed when the annotation loses the input focus.
  - ANNOTATION_PO_KEY
```
public static final Name ANNOTATION_PO_KEY
```
    (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is opened.
    EXAMPLE 1
    When the user navigates to it from the next or previous page or by means of a link annotation or outline item.
    The action shall be executed after the O action in the page’s additional-actions dictionary (see Table 195) and the OpenAction entry in the document Catalog(see Table 28), if such actions are present.
  - ANNOTATION_PC_KEY
```
public static final Name ANNOTATION_PC_KEY
```
    (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is closed.
    EXAMPLE 2
    When the user navigates to the next or previous page, or follows a link annotation or outline item.
    The action shall be executed before the C action in the page’s additional-actions dictionary (see Table 195), if present.
  - ANNOTATION_PV_KEY
```
public static final Name ANNOTATION_PV_KEY
```
    (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation becomes visible.
  - ANNOTATION_PI_KEY
```
public static final Name ANNOTATION_PI_KEY
```
    (Optional; PDF 1.5) An action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.
  - PAGE_0_KEY
```
public static final Name PAGE_0_KEY
```
    Optional; PDF 1.2) An action that shall be performed when the page is opened (for example, when the user navigates to it from the next or previous page or by means of a link annotation or outline item). This action is independent of any that may be defined by the OpenAction entry in the document Catalog (see 7.7.2, “Document Catalog”) and shall be executed after such an action.
  - PAGE_C_KEY
```
public static final Name PAGE_C_KEY
```
    (Optional; PDF 1.2) An action that shall be performed when the page is closed (for example, when the user navigates to the next or previous page or follows a link annotation or an outline item). This action applies to the page being closed and shall be executed before any other page is opened.
  - FORM_K_KEY
```
public static final Name FORM_K_KEY
```
    (Optional; PDF 1.3) A JavaScript action that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box. This action may check the added text for validity and reject or modify it.
  - FORM_F_KEY
```
public static final Name FORM_F_KEY
```
    (Optional; PDF 1.3) A JavaScript action that shall be performed before the field is formatted to display its value. This action may modify the field’s value before formatting.
  - FORM_V_KEY
```
public static final Name FORM_V_KEY
```
    (Optional; PDF 1.3) A JavaScript action that shall be performed when the field’s value is changed. This action may check the new value for validity. (The name V stands for “validate.”)
  - FORM_C_KEY
```
public static final Name FORM_C_KEY
```
    (Optional; PDF 1.3) A JavaScript action that shall be performed to recalculate the value of this field when that of another field changes. (The name C stands for “calculate.”) The order in which the document’s fields are recalculated shall be defined by the CO entry in the interactive form dictionary (see 12.7.2, “Interactive Form Dictionary”).
  - CATALOG_WC_KEY
```
public static final Name CATALOG_WC_KEY
```
    (Optional; PDF 1.4) A JavaScript action that shall be performed before closing a document. (The name WC stands for “will close.”)
  - CATALOG_WS_KEY
```
public static final Name CATALOG_WS_KEY
```
    (Optional; PDF 1.4) A JavaScript action that shall be performed before saving a document. (The name WS stands for “will save.”)
  - CATALOG_DS_KEY
```
public static final Name CATALOG_DS_KEY
```
    (Optional; PDF 1.4) A JavaScript action that shall be performed after saving a document. (The name DS stands for “did save.”)
  - CATALOG_WP_KEY
```
public static final Name CATALOG_WP_KEY
```
    (Optional; PDF 1.4) A JavaScript action that shall be performed before printing a document. (The name WP stands for “will print.”)
  - CATALOG_DP_KEY
```
public static final Name CATALOG_DP_KEY
```
    (Optional; PDF 1.4) A JavaScript action that shall be performed after printing a document. (The name DP stands for “did print.”)
- Constructor Detail
  - AdditionalActionsDictionary
```
public AdditionalActionsDictionary(Library library,
                                   java.util.HashMap entries)
```
- Method Detail
  - getAction
```
public Action getAction(Name actionNameKey)
```
  - isAnnotationValue
```
public boolean isAnnotationValue(Name actionKey)
```
  - isAnnotationBIValue
```
public boolean isAnnotationBIValue()
```
    See Also:
    
    ANNOTATION_Bl_KEY
  - isAnnotationDValue
```
public boolean isAnnotationDValue()
```
    See Also:
    
    ANNOTATION_D_KEY
  - isAnnotationEValue
```
public boolean isAnnotationEValue()
```
    See Also:
    
    ANNOTATION_E_KEY
  - isAnnotationFOValue
```
public boolean isAnnotationFOValue()
```
    See Also:
    
    ANNOTATION_FO_KEY
  - isAnnotationPCValue
```
public boolean isAnnotationPCValue()
```
    See Also:
    
    ANNOTATION_PC_KEY
  - isAnnotationPIValue
```
public boolean isAnnotationPIValue()
```
    See Also:
    
    ANNOTATION_PI_KEY
  - isAnnotationPOValue
```
public boolean isAnnotationPOValue()
```
    See Also:
    
    ANNOTATION_PO_KEY
  - isAnnotationPVValue
```
public boolean isAnnotationPVValue()
```
    See Also:
    
    ANNOTATION_PV_KEY
  - isAnnotationUValue
```
public boolean isAnnotationUValue()
```
    See Also:
    
    ANNOTATION_U_KEY
  - isAnnotationXValue
```
public boolean isAnnotationXValue()
```
    See Also:
    
    ANNOTATION_X_KEY
  - isCatalogDPValue
```
public boolean isCatalogDPValue()
```
    See Also:
    
    CATALOG_DP_KEY
  - isCatalogDSValue
```
public boolean isCatalogDSValue()
```
    See Also:
    
    CATALOG_DS_KEY
  - isCatalogWCValue
```
public boolean isCatalogWCValue()
```
    See Also:
    
    CATALOG_WC_KEY
  - isCatalogWPValue
```
public boolean isCatalogWPValue()
```
    See Also:
    
    CATALOG_WP_KEY
  - isCatalogWSValue
```
public boolean isCatalogWSValue()
```
    See Also:
    
    CATALOG_WS_KEY
  - isFormCValue
```
public boolean isFormCValue()
```
    See Also:
    
    FORM_C_KEY
  - isFormFValue
```
public boolean isFormFValue()
```
    See Also:
    
    FORM_F_KEY
  - isFormKValue
```
public boolean isFormKValue()
```
    See Also:
    
    FORM_K_KEY
  - isFormVValue
```
public boolean isFormVValue()
```
    See Also:
    
    FORM_V_KEY
  - isPageOValue
```
public boolean isPageOValue()
```
    See Also:
    
    PAGE_0_KEY
  - isPageCValue
```
public boolean isPageCValue()
```
    See Also:
    
    PAGE_C_KEY

Class AdditionalActionsDictionary

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Dictionary

Constructor Summary

Method Summary

Methods inherited from class org.icepdf.core.pobjects.Dictionary

Methods inherited from class java.lang.Object

Field Detail

ANNOTATION_E_KEY

ANNOTATION_X_KEY

ANNOTATION_D_KEY

ANNOTATION_U_KEY

ANNOTATION_FO_KEY

ANNOTATION_Bl_KEY

ANNOTATION_PO_KEY

ANNOTATION_PC_KEY

ANNOTATION_PV_KEY

ANNOTATION_PI_KEY

PAGE_0_KEY

PAGE_C_KEY

FORM_K_KEY

FORM_F_KEY

FORM_V_KEY

FORM_C_KEY

CATALOG_WC_KEY

CATALOG_WS_KEY

CATALOG_DS_KEY

CATALOG_WP_KEY

CATALOG_DP_KEY

Constructor Detail

AdditionalActionsDictionary

Method Detail

getAction

isAnnotationValue

isAnnotationBIValue

isAnnotationDValue

isAnnotationEValue

isAnnotationFOValue

isAnnotationPCValue

isAnnotationPIValue

isAnnotationPOValue

isAnnotationPVValue

isAnnotationUValue

isAnnotationXValue

isCatalogDPValue

isCatalogDSValue

isCatalogWCValue

isCatalogWPValue

isCatalogWSValue

isFormCValue

isFormFValue

isFormKValue

isFormVValue

isPageOValue

isPageCValue