org.icepdf.core.pobjects.annotations

Class PopupAnnotation

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.annotations.Annotation

org.icepdf.core.pobjects.annotations.PopupAnnotation

public class PopupAnnotation
extends Annotation

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent’s text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent’s annotation dictionary (see Table 174). Table 183 shows the annotation dictionary entries specific to this type of annotation.A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent’s text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent’s annotation dictionary (see Table 174). Table 183 shows the annotation dictionary entries specific to this type of annotation.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	open
static Name	OPEN_KEY (Optional) A flag specifying whether the pop-up annotation shall initially be displayed open.
protected MarkupAnnotation	parent
static Name	PARENT_KEY (Optional; shall be an indirect reference) The parent annotation with which this pop-up annotation shall be associated.

Fields inherited from class org.icepdf.core.pobjects.annotations.Annotation

ACTION_KEY, APPEARANCE_STATE_KEY, APPEARANCE_STREAM_DOWN_KEY, APPEARANCE_STREAM_KEY, APPEARANCE_STREAM_NORMAL_KEY, APPEARANCE_STREAM_ROLLOVER_KEY, appearances, BBOX_VALUE, border, BORDER_DASH, BORDER_HORIZONTAL_CORNER_RADIUS, BORDER_KEY, BORDER_STYLE_KEY, BORDER_VERTICAL_CORNER_RADIUS, BORDER_WIDTH, borderStyle, canDrawBorder, changeSupport, color, COLOR_KEY, compressAppearanceStream, content, CONTENTS_KEY, currentAppearance, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_KEY, FLAG_LOCKED, FLAG_LOCKED_CONTENTS, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINT, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW, hasBlendingMode, INVISIBLE_RECTANGLE, M_KEY, modifiedDate, NM_KEY, PARENT_PAGE_KEY, RECTANGLE_KEY, RESOURCES_VALUE, securityManager, subtype, SUBTYPE_CIRCLE, SUBTYPE_FREE_TEXT, SUBTYPE_HIGHLIGHT, SUBTYPE_INK, SUBTYPE_LINE, SUBTYPE_LINK, SUBTYPE_POLYGON, SUBTYPE_POLYLINE, SUBTYPE_POPUP, SUBTYPE_SQUARE, SUBTYPE_TEXT, SUBTYPE_WIDGET, TYPE, TYPE_VALUE, userSpaceRectangle, VISIBLE_RECTANGLE

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
PopupAnnotation(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
static PopupAnnotation	getInstance(Library library, java.awt.Rectangle rect) Gets an instance of a PopupAnnotation that has valid Object Reference.
MarkupAnnotation	getParent()
void	init() Initiate the Dictionary.
boolean	isOpen()
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageTransform)
void	setOpen(boolean open)
void	setParent(MarkupAnnotation parent)

Methods inherited from class org.icepdf.core.pobjects.annotations.Annotation

addAction, addPropertyChangeListener, allowAlterProperties, allowPrintNormalMode, allowScreenDownMode, allowScreenNormalMode, allowScreenOrPrintRenderingOrInteraction, allowScreenRolloverMode, buildAnnotation, deleteAction, deriveDrawingRectangle, getAction, getAppearances, getAppearanceStream, getBbox, getBorder, getBorderStyle, getBorderStyleStroke, getBorderType, getColor, getContents, getCurrentAppearance, getFlagHidden, getFlagInvisible, getFlagLocked, getFlagLockedContents, getFlagNoRotate, getFlagNoView, getFlagNoZoom, getFlagPrint, getFlagReadOnly, getFlagToggleNoView, getLineStyle, getLineThickness, getOrGenerateAppearanceForm, getPage, getParentAnnotation, getShapes, getSubType, getUserSpaceRectangle, hasAppearanceStream, isBorder, isSupportedAnnotationType, render, renderAppearanceStream, renderBorder, renderBorderTabSelected, resetAppearanceStream, resetNullAppearanceStream, setBBox, setBorderStyle, setColor, setCompressAppearanceStream, setContents, setCurrentAppearance, setFlag, setModifiedDate, setSubtype, setUserSpaceRectangle, syncBBoxToUserSpaceRectangle, toString, updateAction

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, isDeleted, isNew, setDeleted, setNew, setPObjectReference

Methods inherited from class java.lang.Object

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

Field Detail

PARENT_KEY

public static final Name PARENT_KEY

(Optional; shall be an indirect reference) The parent annotation with which this pop-up annotation shall be associated.

If this entry is present, the parent annotation’s Contents, M, C, and T entries (see Table 168) shall override those of the pop-up annotation itself.

OPEN_KEY

public static final Name OPEN_KEY

(Optional) A flag specifying whether the pop-up annotation shall initially be displayed open. Default value: false (closed).

open

protected boolean open

parent

protected MarkupAnnotation parent

Constructor Detail

PopupAnnotation

public PopupAnnotation(Library l,
                       java.util.HashMap h)

Method Detail

init

public void init()

Description copied from class: Dictionary

Initiate the Dictionary. Retrieve any needed attributes.

Overrides:

init in class Annotation

getInstance

public static PopupAnnotation getInstance(Library library,
                                          java.awt.Rectangle rect)

Gets an instance of a PopupAnnotation that has valid Object Reference.

Parameters:

library - document library

rect - bounding rectangle in user space

Returns:

new PopupAnnotation Instance.

resetAppearanceStream

public void resetAppearanceStream(double dx,
                                  double dy,
                                  java.awt.geom.AffineTransform pageTransform)

Specified by:

resetAppearanceStream in class Annotation

isOpen

public boolean isOpen()

setOpen

public void setOpen(boolean open)

getParent

public MarkupAnnotation getParent()

setParent

public void setParent(MarkupAnnotation parent)