Package com.itextpdf.kernel.pdf.annot

Class PdfPopupAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfPopupAnnotation

public class PdfPopupAnnotation
extends PdfAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

PdfAnnotation.PdfUnknownAnnotation

Field Summary

Fields

Modifier and Type	Field	Description
protected PdfAnnotation	parent

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Modifier	Constructor	Description
	PdfPopupAnnotation(Rectangle rect)
protected	PdfPopupAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfPopupAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Method Summary

Modifier and Type	Method	Description
boolean	getOpen()	A flag specifying whether the annotation shall initially be displayed open.
PdfAnnotation	getParent()
PdfDictionary	getParentObject()
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfPopupAnnotation	setOpen(boolean open)	Sets a flag specifying whether the annotation shall initially be displayed open.
PdfPopupAnnotation	setParent(PdfAnnotation parent)

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parent

protected PdfAnnotation parent

Constructor Detail

PdfPopupAnnotation

public PdfPopupAnnotation(Rectangle rect)

PdfPopupAnnotation

protected PdfPopupAnnotation(PdfDictionary pdfObject)

Instantiates a new PdfPopupAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Parameters:

pdfObject - the PdfDictionary representing annotation object

See Also:

PdfAnnotation.makeAnnotation(PdfObject)

Method Detail

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

getParentObject

public PdfDictionary getParentObject()

getParent

public PdfAnnotation getParent()

setParent

public PdfPopupAnnotation setParent(PdfAnnotation parent)

getOpen

public boolean getOpen()

A flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.

Returns:

true if annotation is initially open, false - if closed.

setOpen

public PdfPopupAnnotation setOpen(boolean open)

Sets a flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.

Parameters:

open - true if annotation shall initially be open, false - if closed.

Returns:

this PdfPopupAnnotation instance.