Class PDAnnotationAdditionalActions
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
- All Implemented Interfaces:
COSObjectable
This class represents an annotation's dictionary of actions
that occur due to events.
- Version:
- $Revision: 1.2 $
- Author:
- Ben Litchfield, Panagiotis Toumasis (ptoumasis@mail.gr)
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetBl()
This will get an action to be performed when the annotation loses the input focus.Convert this standard java object to a COS object.Convert this standard java object to a COS object.getD()
This will get an action to be performed when the mouse button is pressed inside the annotation's active area.getE()
This will get an action to be performed when the cursor enters the annotation's active area.getFo()
This will get an action to be performed when the annotation receives the input focus.getPC()
This will get an action to be performed when the page containing the annotation is closed.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.getPO()
This will get an action to be performed when the page containing the annotation is opened.getPV()
This will get an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.getU()
This will get an action to be performed when the mouse button is released inside the annotation's active area.getX()
This will get an action to be performed when the cursor exits the annotation's active area.void
This will set an action to be performed when the annotation loses the input focus.void
This will set an action to be performed when the mouse button is pressed inside the annotation's active area.void
This will set an action to be performed when the cursor enters the annotation's active area.void
This will set an action to be performed when the annotation receives the input focus.void
This will set an action to be performed when the page containing the annotation is closed.void
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.void
This will set an action to be performed when the page containing the annotation is opened.void
This will set an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.void
This will set an action to be performed when the mouse button is released inside the annotation's active area.void
This will set an action to be performed when the cursor exits the annotation's active area.
-
Constructor Details
-
PDAnnotationAdditionalActions
public PDAnnotationAdditionalActions()Default constructor. -
PDAnnotationAdditionalActions
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.
-
getCOSDictionary
Convert this standard java object to a COS object.- Returns:
- The cos object that matches this Java object.
-
getE
This will get an action to be performed when the cursor enters the annotation's active area.- Returns:
- The E entry of annotation's additional actions dictionary.
-
setE
This will set an action to be performed when the cursor enters the annotation's active area.- Parameters:
e
- The action to be performed.
-
getX
This will get an action to be performed when the cursor exits the annotation's active area.- Returns:
- The X entry of annotation's additional actions dictionary.
-
setX
This will set an action to be performed when the cursor exits the annotation's active area.- Parameters:
x
- The action to be performed.
-
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:
- The d entry of annotation's additional actions dictionary.
-
setD
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
- The action to be performed.
-
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:
- The U entry of annotation's additional actions dictionary.
-
setU
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
- The action to be performed.
-
getFo
This will get an action to be performed when the annotation receives the input focus.- Returns:
- The Fo entry of annotation's additional actions dictionary.
-
setFo
This will set an action to be performed when the annotation receives the input focus.- Parameters:
fo
- The action to be performed.
-
getBl
This will get an action to be performed when the annotation loses the input focus. The name Bl stands for "blurred".- Returns:
- The Bl entry of annotation's additional actions dictionary.
-
setBl
This will set an action to be performed when the annotation loses the input focus. The name Bl stands for "blurred".- Parameters:
bl
- The action to be performed.
-
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:
- The PO entry of annotation's additional actions dictionary.
-
setPO
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
- The action to be performed.
-
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:
- The PC entry of annotation's additional actions dictionary.
-
setPC
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
- The action to be performed.
-
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:
- The PV entry of annotation's additional actions dictionary.
-
setPV
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
- The action to be performed.
-
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:
- The PI entry of annotation's additional actions dictionary.
-
setPI
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
- The action to be performed.
-