org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationPopup
- COSObjectable
public class PDAnnotationPopup
This is the class that represents a popup annotation.
Introduced in PDF 1.3 specification
static String | SUB_TYPE - The type of annotation.
|
boolean | getOpen() - This will retrieve the initial state of the annotation, open Or closed
(default closed).
|
PDAnnotationMarkup | getParent() - This will retrieve the markup annotation which this popup relates to.
|
void | setOpen(boolean open) - This will set inital state of the annotation, open or closed.
|
void | setParent(PDAnnotationMarkup annot) - This will set the markup annotation which this popup relates to.
|
createAnnotation , getAction , getActions , getAnnotationFlags , getAnnotationName , getAppearance , getAppearanceStream , getBoderStyle , getCOSObject , getColour , getContents , getDictionary , getModifiedDate , getRectangle , isHidden , isInvisible , isLocked , isNoRotate , isNoView , isNoZoom , isPrinted , isReadOnly , isToggleNoView , setAction , setActions , setAnnotationFlags , setAnnotationName , setAppearance , setAppearanceStream , setBorderStyle , setColour , setContents , setHidden , setInvisible , setLocked , setModifiedDate , setNoRotate , setNoView , setNoZoom , setPrinted , setReadOnly , setRectangle , setToggleNoView |
SUB_TYPE
public static final String SUB_TYPE
The type of annotation.
PDAnnotationPopup
public PDAnnotationPopup()
Constructor.
PDAnnotationPopup
public PDAnnotationPopup(COSDictionary field)
Creates a popup annotation from a COSDictionary, expected to be a correct
object definition.
field
- the PDF objet to represent as a field.
getOpen
public boolean getOpen()
This will retrieve the initial state of the annotation, open Or closed
(default closed).
- The initial state, true = open false = closed.
getParent
public PDAnnotationMarkup getParent()
This will retrieve the markup annotation which this popup relates to.
- The parent markup annotation.
setOpen
public void setOpen(boolean open)
This will set inital state of the annotation, open or closed.
open
- Boolean value, true = open false = closed.
setParent
public void setParent(PDAnnotationMarkup annot)
This will set the markup annotation which this popup relates to.
annot
- the markup annotation.