org.icepdf.core.pobjects.annotations

Class ChoiceWidgetAnnotation

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.annotations.Annotation

org.icepdf.core.pobjects.annotations.AbstractWidgetAnnotation<ChoiceFieldDictionary>

org.icepdf.core.pobjects.annotations.ChoiceWidgetAnnotation

public class ChoiceWidgetAnnotation
extends AbstractWidgetAnnotation<ChoiceFieldDictionary>

Represents a Acroform Choice widget and manages the appearance streams for the various appearance states. This class can generate a postscript stream that represents it current state.

Since:

5.1

Field Summary

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

HIGHLIGHT_NONE, highlightAlpha, highlightColor, 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, 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_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
ChoiceWidgetAnnotation(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildChoiceComboContents(java.lang.String currentContentStream)
java.lang.String	buildChoiceListContents(java.lang.String currentContentStream)
java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption>	generateChoices() Some choices lists are lacking the /opt key so we need to do our best to generate the list from the shapes.
ChoiceFieldDictionary	getFieldDictionary()
void	reset()
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageTransform) Resets the appearance stream for this instance using the current state.

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

checkAppearance, encodeLiteralString, findBoundRectangle, findRectangle, findSelectionRectangle, generateRectangle, getFontSize, getLineHeight, isEnableHighlightedWidget, parseRectanglePoints, renderAppearanceStream, setEnableHighlightedWidget, setHighlightAlpha, setHighlightColor

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, init, isBorder, isSupportedAnnotationType, render, 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

Constructor Detail

ChoiceWidgetAnnotation

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

Method Detail

generateChoices

public java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption> generateChoices()

Some choices lists are lacking the /opt key so we need to do our best to generate the list from the shapes.

Returns:

list of potential options.

resetAppearanceStream

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

Resets the appearance stream for this instance using the current state. The mark content section of the stream is found and the edit it make to best of our ability.

Specified by:

resetAppearanceStream in class AbstractWidgetAnnotation<ChoiceFieldDictionary>

Parameters:

dx - x offset of the annotation

dy - y offset of the annotation

pageTransform - current page transform.

reset

public void reset()

Specified by:

reset in class AbstractWidgetAnnotation<ChoiceFieldDictionary>

getFieldDictionary

public ChoiceFieldDictionary getFieldDictionary()

Specified by:

getFieldDictionary in class AbstractWidgetAnnotation<ChoiceFieldDictionary>

buildChoiceComboContents

public java.lang.String buildChoiceComboContents(java.lang.String currentContentStream)

buildChoiceListContents

public java.lang.String buildChoiceListContents(java.lang.String currentContentStream)