Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.action

public Class PDDocumentCatalogAdditionalActions

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable
This class represents a document catalog's dictionary of actions that occur due to events.
Authors
Ben Litchfield, Panagiotis Toumasis

Field Summary

Modifier and TypeField and Description
private final COSDictionary
actions

Constructor Summary

AccessConstructor and Description
public
PDDocumentCatalogAdditionalActions()

Default constructor.

public
PDDocumentCatalogAdditionalActions(COSDictionary
The action dictionary.
a)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public PDAction

Returns:

The DP entry of document catalog's additional actions dictionary.
getDP()

This will get a JavaScript action to be performed after printing a document.

public PDAction

Returns:

The DS entry of document catalog's additional actions dictionary.
getDS()

This will get a JavaScript action to be performed after saving a document.

public PDAction

Returns:

The WC entry of document catalog's additional actions dictionary.
getWC()

This will get a JavaScript action to be performed before closing a document.

public PDAction

Returns:

The WP entry of document catalog's additional actions dictionary.
getWP()

This will get a JavaScript action to be performed before printing a document.

public PDAction

Returns:

The WS entry of document catalog's additional actions dictionary.
getWS()

This will get a JavaScript action to be performed before saving a document.

public void
setDP(PDAction
The action to be performed.
dp)

This will set a JavaScript action to be performed after printing a document.

public void
setDS(PDAction
The action to be performed.
ds)

This will set a JavaScript action to be performed after saving a document.

public void
setWC(PDAction
The action to be performed.
wc)

This will set a JavaScript action to be performed before closing a document.

public void
setWP(PDAction
The action to be performed.
wp)

This will set a JavaScript action to be performed before printing a document.

public void
setWS(PDAction
The action to be performed.
ws)

This will set a JavaScript action to be performed before saving a document.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actionsback to summary
private final COSDictionary actions

Constructor Detail

PDDocumentCatalogAdditionalActionsback to summary
public PDDocumentCatalogAdditionalActions()

Default constructor.

PDDocumentCatalogAdditionalActionsback to summary
public PDDocumentCatalogAdditionalActions(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getDPback to summary
public PDAction getDP()

This will get a JavaScript action to be performed after printing a document. The name DP stands for "did print".

Returns:PDAction

The DP entry of document catalog's additional actions dictionary.

getDSback to summary
public PDAction getDS()

This will get a JavaScript action to be performed after saving a document. The name DS stands for "did save".

Returns:PDAction

The DS entry of document catalog's additional actions dictionary.

getWCback to summary
public PDAction getWC()

This will get a JavaScript action to be performed before closing a document. The name WC stands for "will close".

Returns:PDAction

The WC entry of document catalog's additional actions dictionary.

getWPback to summary
public PDAction getWP()

This will get a JavaScript action to be performed before printing a document. The name WP stands for "will print".

Returns:PDAction

The WP entry of document catalog's additional actions dictionary.

getWSback to summary
public PDAction getWS()

This will get a JavaScript action to be performed before saving a document. The name WS stands for "will save".

Returns:PDAction

The WS entry of document catalog's additional actions dictionary.

setDPback to summary
public void setDP(PDAction dp)

This will set a JavaScript action to be performed after printing a document. The name DP stands for "did print".

Parameters
dp:PDAction

The action to be performed.

setDSback to summary
public void setDS(PDAction ds)

This will set a JavaScript action to be performed after saving a document. The name DS stands for "did save".

Parameters
ds:PDAction

The action to be performed.

setWCback to summary
public void setWC(PDAction wc)

This will set a JavaScript action to be performed before closing a document. The name WC stands for "will close".

Parameters
wc:PDAction

The action to be performed.

setWPback to summary
public void setWP(PDAction wp)

This will set a JavaScript action to be performed before printing a document. The name WP stands for "will print".

Parameters
wp:PDAction

The action to be performed.

setWSback to summary
public void setWS(PDAction ws)

This will set a JavaScript action to be performed before saving a document. The name WS stands for "will save".

Parameters
ws:PDAction

The action to be performed.