org.icepdf.core.pobjects.annotations
Class WidgetAnnotation

java.lang.Object
  org.icepdf.core.pobjects.Dictionary
      org.icepdf.core.pobjects.annotations.Annotation
          org.icepdf.core.pobjects.annotations.WidgetAnnotation

public class WidgetAnnotation
extends Annotation

Interactive forms (see 12.7, “Interactive Forms�) use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions. As a convenience, when a field has only a single associated widget annotation, the contents of the field dictionary (12.7.3, “Field Dictionaries�) and the annotation dictionary may be merged into a single dictionary containing entries that pertain to both a field and an annotation.

Since:

5.0

Field Summary

protected FieldDictionary	fieldDictionary
static Name	HIGHLIGHT_NONE Indicates that the annotation has no highlight effect.
protected Name	highlightMode

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, bbox, BBOX_VALUE, border, BORDER_DASH, BORDER_HORIZONTAL_CORNER_RADIUS, BORDER_KEY, BORDER_STYLE_KEY, BORDER_VERTICAL_CORNER_RADIUS, BORDER_WIDTH, borderStyle, canDrawBorder, color, COLOR_KEY, compressAppearanceStream, content, CONTENTS_KEY, 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, matrix, modifiedDate, NM_KEY, PARENT_KEY, PARENT_PAGE_KEY, RECTANGLE_KEY, RESOURCES_VALUE, securityManager, shapes, 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

WidgetAnnotation(Library l, java.util.HashMap h)

Method Summary

static WidgetAnnotation	getInstance(Library library, java.awt.Rectangle rect) Gets an instance of a PopupAnnotation that has valid Object Reference.
void	init() Initiate the Dictionary.
protected void	renderAppearanceStream(java.awt.Graphics2D g)
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageSpace)

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

addAction, allowAlterProperties, allowPrintNormalMode, allowScreenDownMode, allowScreenNormalMode, allowScreenOrPrintRenderingOrInteraction, allowScreenRolloverMode, buildAnnotation, deleteAction, deriveDrawingRectangle, getAction, getAppearanceStream, getBbox, getBorder, getBorderStyle, getBorderStyleStroke, getBorderType, getColor, getContents, getFlagHidden, getFlagInvisible, getFlagLocked, getFlagLockedContents, getFlagNoRotate, getFlagNoView, getFlagNoZoom, getFlagPrint, getFlagReadOnly, getFlagToggleNoView, getLineStyle, getLineThickness, getPage, getParentAnnotation, getShapes, getSubType, getUserSpaceRectangle, hasAppearanceStream, isBorder, isSupportedAnnotationType, render, renderBorder, renderBorderTabSelected, resetAppearanceStream, setBBox, setBorderStyle, setColor, setCompressAppearanceStream, setContents, 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

HIGHLIGHT_NONE

public static final Name HIGHLIGHT_NONE

Indicates that the annotation has no highlight effect.

fieldDictionary

protected FieldDictionary fieldDictionary

highlightMode

protected Name highlightMode

Constructor Detail

WidgetAnnotation

public WidgetAnnotation(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 WidgetAnnotation 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 pageSpace)

Specified by:

resetAppearanceStream in class Annotation

renderAppearanceStream

protected void renderAppearanceStream(java.awt.Graphics2D g)

Overrides:

renderAppearanceStream in class Annotation