Class PDDocumentCatalogAdditionalActions
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
- All Implemented Interfaces:
COSObjectable
This class represents a document catalog's dictionary of actions
that occur due to events.
- Author:
- Ben Litchfield, Panagiotis Toumasis
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.getDP()
This will get a JavaScript action to be performed after printing a document.getDS()
This will get a JavaScript action to be performed after saving a document.getWC()
This will get a JavaScript action to be performed before closing a document.getWP()
This will get a JavaScript action to be performed before printing a document.getWS()
This will get a JavaScript action to be performed before saving a document.void
This will set a JavaScript action to be performed after printing a document.void
This will set a JavaScript action to be performed after saving a document.void
This will set a JavaScript action to be performed before closing a document.void
This will set a JavaScript action to be performed before printing a document.void
This will set a JavaScript action to be performed before saving a document.
-
Constructor Details
-
PDDocumentCatalogAdditionalActions
public PDDocumentCatalogAdditionalActions()Default constructor. -
PDDocumentCatalogAdditionalActions
Constructor.- Parameters:
a
- The action dictionary.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getWC
This will get a JavaScript action to be performed before closing a document. The name WC stands for "will close".- Returns:
- The WC entry of document catalog's additional actions dictionary.
-
setWC
This will set a JavaScript action to be performed before closing a document. The name WC stands for "will close".- Parameters:
wc
- The action to be performed.
-
getWS
This will get a JavaScript action to be performed before saving a document. The name WS stands for "will save".- Returns:
- The WS entry of document catalog's additional actions dictionary.
-
setWS
This will set a JavaScript action to be performed before saving a document. The name WS stands for "will save".- Parameters:
ws
- The action to be performed.
-
getDS
This will get a JavaScript action to be performed after saving a document. The name DS stands for "did save".- Returns:
- The DS entry of document catalog's additional actions dictionary.
-
setDS
This will set a JavaScript action to be performed after saving a document. The name DS stands for "did save".- Parameters:
ds
- The action to be performed.
-
getWP
This will get a JavaScript action to be performed before printing a document. The name WP stands for "will print".- Returns:
- The WP entry of document catalog's additional actions dictionary.
-
setWP
This will set a JavaScript action to be performed before printing a document. The name WP stands for "will print".- Parameters:
wp
- The action to be performed.
-
getDP
This will get a JavaScript action to be performed after printing a document. The name DP stands for "did print".- Returns:
- The DP entry of document catalog's additional actions dictionary.
-
setDP
This will set a JavaScript action to be performed after printing a document. The name DP stands for "did print".- Parameters:
dp
- The action to be performed.
-