org.icepdf.core.pobjects.annotations

Class ButtonWidgetAnnotation

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.annotations.Annotation

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

org.icepdf.core.pobjects.annotations.ButtonWidgetAnnotation

public class ButtonWidgetAnnotation
extends AbstractWidgetAnnotation<ButtonFieldDictionary>

Represents a Acroform Button widget and manages the appearance streams for the various appearance states.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
protected Name	originalAppearance

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
ButtonWidgetAnnotation(Annotation widgetAnnotation)
ButtonWidgetAnnotation(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
ButtonFieldDictionary	getFieldDictionary()
boolean	isOn()
void	reset()
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageSpace) Button appearance streams are fixed, all that is done in this method is appearance selected state is set and the change persisted to the StateManager.
Name	toggle()
void	turnOff()
void	turnOn()

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

Field Detail

originalAppearance

protected Name originalAppearance

Constructor Detail

ButtonWidgetAnnotation

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

ButtonWidgetAnnotation

public ButtonWidgetAnnotation(Annotation widgetAnnotation)

Method Detail

resetAppearanceStream

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

Button appearance streams are fixed, all that is done in this method is appearance selected state is set and the change persisted to the StateManager.

Specified by:

resetAppearanceStream in class AbstractWidgetAnnotation<ButtonFieldDictionary>

Parameters:

dx - current location of the annotation

dy - current location of the annotation

pageSpace - current page space.

reset

public void reset()

Specified by:

reset in class AbstractWidgetAnnotation<ButtonFieldDictionary>

turnOff

public void turnOff()

isOn

public boolean isOn()

toggle

public Name toggle()

turnOn

public void turnOn()

getFieldDictionary

public ButtonFieldDictionary getFieldDictionary()

Specified by:

getFieldDictionary in class AbstractWidgetAnnotation<ButtonFieldDictionary>