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

public Class PDAnnotationPopup

extends PDAnnotation
Class Inheritance
Imports
java.io.IOException, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSDictionary, .COSName
This is the class that represents a popup annotation. Introduced in PDF 1.3 specification
Author
Paul King

Field Summary

Modifier and TypeField and Description
private static final Log
LOG

Hides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.LOG.

public static final String
SUB_TYPE

The type of annotation.

Constructor Summary

AccessConstructor and Description
public
PDAnnotationPopup()

Constructor.

public
PDAnnotationPopup(COSDictionary
the PDF object to represent as a field.
field)

Creates a popup annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

The initial state, true = open false = closed.
getOpen()

This will retrieve the initial state of the annotation, open Or closed (default closed).

public PDAnnotationMarkup

Returns:

The parent markup annotation.
getParent()

This will retrieve the markup annotation which this popup relates to.

public void
setOpen(boolean
Boolean value, true = open false = closed.
open)

This will set the initial state of the annotation, open or closed.

public void
setParent(PDAnnotationMarkup
the markup annotation.
annot)

This will set the markup annotation which this popup relates to.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
constructAppearancesconstructAppearancescreateAnnotationequalsgetAnnotationFlagsgetAnnotationNamegetAppearancegetAppearanceStategetBordergetColorgetColorgetContentsgetCOSObjectgetModifiedDategetNormalAppearanceStreamgetOptionalContentgetPagegetRectanglegetStructParentgetSubtypehashCodeisHiddenisInvisibleisLockedisLockedContentsisNoRotateisNoViewisNoZoomisPrintedisReadOnlyisToggleNoViewsetAnnotationFlagssetAnnotationNamesetAppearancesetAppearanceStatesetBordersetColorsetContentssetHiddensetInvisiblesetLockedsetLockedContentssetModifiedDatesetModifiedDatesetNoRotatesetNoViewsetNoZoomsetOptionalContentsetPagesetPrintedsetReadOnlysetRectanglesetStructParentsetSubtypesetToggleNoView

Field Detail

LOGback to summary
private static final Log LOG

Hides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.LOG.

SUB_TYPEback to summary
public static final String SUB_TYPE

The type of annotation.

Constructor Detail

PDAnnotationPopupback to summary
public PDAnnotationPopup()

Constructor.

PDAnnotationPopupback to summary
public PDAnnotationPopup(COSDictionary field)

Creates a popup annotation from a COSDictionary, expected to be a correct object definition.

Parameters
field:COSDictionary

the PDF object to represent as a field.

Method Detail

getOpenback to summary
public boolean getOpen()

This will retrieve the initial state of the annotation, open Or closed (default closed).

Returns:boolean

The initial state, true = open false = closed.

getParentback to summary
public PDAnnotationMarkup getParent()

This will retrieve the markup annotation which this popup relates to.

Returns:PDAnnotationMarkup

The parent markup annotation.

setOpenback to summary
public void setOpen(boolean open)

This will set the initial state of the annotation, open or closed.

Parameters
open:boolean

Boolean value, true = open false = closed.

setParentback to summary
public void setParent(PDAnnotationMarkup annot)

This will set the markup annotation which this popup relates to.

Parameters
annot:PDAnnotationMarkup

the markup annotation.