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

All Implemented Interfaces:

Serializable

public class PdfPopupAnnotation
extends PdfAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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

Constructor and Description
PdfPopupAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfPopupAnnotation(Rectangle rect)

Method Summary

Modifier and Type	Method and 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

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getBorderStyle, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setBorderStyle, setBorderStyle, setColor, setColor, setColor, setContents, setContents, setDashPattern, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setPage, setQuadPoints, setRectangle, setRolloverAppearance, setRolloverAppearance, 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

@Deprecated
public PdfPopupAnnotation(PdfDictionary pdfObject)

Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1

Parameters:

pdfObject - object representing this annotation

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.

Overrides:

getOpen in class PdfAnnotation

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.

Overrides:

setOpen in class PdfAnnotation

Parameters:

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

Returns:

this PdfPopupAnnotation instance.