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

public Class PDPageAdditionalActions

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 page object'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
PDPageAdditionalActions()

Default constructor.

public
PDPageAdditionalActions(COSDictionary
The action dictionary.
a)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDAction

Returns:

The C entry of page object's additional actions dictionary.
getC()

This will get an action to be performed when the page is closed.

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 O entry of page object's additional actions dictionary.
getO()

This will get an action to be performed when the page is opened.

public void
setC(PDAction
The action to be performed.
c)

This will set an action to be performed when the page is closed.

public void
setO(PDAction
The action to be performed.
o)

This will set an action to be performed when the page is opened.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actionsback to summary
private final COSDictionary actions

Constructor Detail

PDPageAdditionalActionsback to summary
public PDPageAdditionalActions()

Default constructor.

PDPageAdditionalActionsback to summary
public PDPageAdditionalActions(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getCback to summary
public PDAction getC()

This will get an action to be performed when the page is closed. This action applies to the page being closed, and is executed before any other page opened.

Returns:PDAction

The C entry of page object's additional actions dictionary.

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
getOback to summary
public PDAction getO()

This will get an action to be performed when the page is opened. This action is independent of any that may be defined by the OpenAction entry in the document catalog, and is executed after such an action.

Returns:PDAction

The O entry of page object's additional actions dictionary.

setCback to summary
public void setC(PDAction c)

This will set an action to be performed when the page is closed. This action applies to the page being closed, and is executed before any other page opened.

Parameters
c:PDAction

The action to be performed.

setOback to summary
public void setO(PDAction o)

This will set an action to be performed when the page is opened. This action is independent of any that may be defined by the OpenAction entry in the document catalog, and is executed after such an action.

Parameters
o:PDAction

The action to be performed.