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

public Class PDAnnotationAdditionalActions

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 an annotation'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
PDAnnotationAdditionalActions()

Default constructor.

public
PDAnnotationAdditionalActions(COSDictionary
The action dictionary.
a)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDAction

Returns:

The Bl entry of annotation's additional actions dictionary.
getBl()

This will get an action to be performed when the annotation loses the input focus.

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 d entry of annotation's additional actions dictionary.
getD()

This will get an action to be performed when the mouse button is pressed inside the annotation's active area.

public PDAction

Returns:

The E entry of annotation's additional actions dictionary.
getE()

This will get an action to be performed when the cursor enters the annotation's active area.

public PDAction

Returns:

The Fo entry of annotation's additional actions dictionary.
getFo()

This will get an action to be performed when the annotation receives the input focus.

public PDAction

Returns:

The PC entry of annotation's additional actions dictionary.
getPC()

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

public PDAction

Returns:

The PI entry of annotation's additional actions dictionary.
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.

public PDAction

Returns:

The PO entry of annotation's additional actions dictionary.
getPO()

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

public PDAction

Returns:

The PV entry of annotation's additional actions dictionary.
getPV()

This will get an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

public PDAction

Returns:

The U entry of annotation's additional actions dictionary.
getU()

This will get an action to be performed when the mouse button is released inside the annotation's active area.

public PDAction

Returns:

The X entry of annotation's additional actions dictionary.
getX()

This will get an action to be performed when the cursor exits the annotation's active area.

public void
setBl(PDAction
The action to be performed.
bl)

This will set an action to be performed when the annotation loses the input focus.

public void
setD(PDAction
The action to be performed.
d)

This will set an action to be performed when the mouse button is pressed inside the annotation's active area.

public void
setE(PDAction
The action to be performed.
e)

This will set an action to be performed when the cursor enters the annotation's active area.

public void
setFo(PDAction
The action to be performed.
fo)

This will set an action to be performed when the annotation receives the input focus.

public void
setPC(PDAction
The action to be performed.
pc)

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

public void
setPI(PDAction
The action to be performed.
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.

public void
setPO(PDAction
The action to be performed.
po)

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

public void
setPV(PDAction
The action to be performed.
pv)

This will set an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

public void
setU(PDAction
The action to be performed.
u)

This will set an action to be performed when the mouse button is released inside the annotation's active area.

public void
setX(PDAction
The action to be performed.
x)

This will set an action to be performed when the cursor exits the annotation's active area.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actionsback to summary
private final COSDictionary actions

Constructor Detail

PDAnnotationAdditionalActionsback to summary
public PDAnnotationAdditionalActions()

Default constructor.

PDAnnotationAdditionalActionsback to summary
public PDAnnotationAdditionalActions(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getBlback to summary
public PDAction getBl()

This will get an action to be performed when the annotation loses the input focus. The name Bl stands for "blurred".

Returns:PDAction

The Bl entry of annotation'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
getDback to summary
public PDAction getD()

This will get an action to be performed when the mouse button is pressed inside the annotation's active area. The name D stands for "down".

Returns:PDAction

The d entry of annotation's additional actions dictionary.

getEback to summary
public PDAction getE()

This will get an action to be performed when the cursor enters the annotation's active area.

Returns:PDAction

The E entry of annotation's additional actions dictionary.

getFoback to summary
public PDAction getFo()

This will get an action to be performed when the annotation receives the input focus.

Returns:PDAction

The Fo entry of annotation's additional actions dictionary.

getPCback to summary
public PDAction getPC()

This will get an action to be performed when the page containing the annotation is closed. The action is executed before the C action in the page's additional actions dictionary, if present.

Returns:PDAction

The PC entry of annotation's additional actions dictionary.

getPIback to summary
public PDAction 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.

Returns:PDAction

The PI entry of annotation's additional actions dictionary.

getPOback to summary
public PDAction getPO()

This will get an action to be performed when the page containing the annotation is opened. The action is executed after the O action in the page's additional actions dictionary and the OpenAction entry in the document catalog, if such actions are present.

Returns:PDAction

The PO entry of annotation's additional actions dictionary.

getPVback to summary
public PDAction getPV()

This will get an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.

Returns:PDAction

The PV entry of annotation's additional actions dictionary.

getUback to summary
public PDAction getU()

This will get an action to be performed when the mouse button is released inside the annotation's active area. The name U stands for "up".

Returns:PDAction

The U entry of annotation's additional actions dictionary.

getXback to summary
public PDAction getX()

This will get an action to be performed when the cursor exits the annotation's active area.

Returns:PDAction

The X entry of annotation's additional actions dictionary.

setBlback to summary
public void setBl(PDAction bl)

This will set an action to be performed when the annotation loses the input focus. The name Bl stands for "blurred".

Parameters
bl:PDAction

The action to be performed.

setDback to summary
public void setD(PDAction d)

This will set an action to be performed when the mouse button is pressed inside the annotation's active area. The name D stands for "down".

Parameters
d:PDAction

The action to be performed.

setEback to summary
public void setE(PDAction e)

This will set an action to be performed when the cursor enters the annotation's active area.

Parameters
e:PDAction

The action to be performed.

setFoback to summary
public void setFo(PDAction fo)

This will set an action to be performed when the annotation receives the input focus.

Parameters
fo:PDAction

The action to be performed.

setPCback to summary
public void setPC(PDAction pc)

This will set an action to be performed when the page containing the annotation is closed. The action is executed before the C action in the page's additional actions dictionary, if present.

Parameters
pc:PDAction

The action to be performed.

setPIback to summary
public void 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.

Parameters
pi:PDAction

The action to be performed.

setPOback to summary
public void setPO(PDAction po)

This will set an action to be performed when the page containing the annotation is opened. The action is executed after the O action in the page's additional actions dictionary and the OpenAction entry in the document catalog, if such actions are present.

Parameters
po:PDAction

The action to be performed.

setPVback to summary
public void 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.

Parameters
pv:PDAction

The action to be performed.

setUback to summary
public void setU(PDAction u)

This will set an action to be performed when the mouse button is released inside the annotation's active area. The name U stands for "up".

Parameters
u:PDAction

The action to be performed.

setXback to summary
public void setX(PDAction x)

This will set an action to be performed when the cursor exits the annotation's active area.

Parameters
x:PDAction

The action to be performed.