org.icepdf.core.pobjects.annotations

Class TextWidgetAnnotation

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.annotations.Annotation

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

org.icepdf.core.pobjects.annotations.TextWidgetAnnotation

public class TextWidgetAnnotation
extends AbstractWidgetAnnotation<TextFieldDictionary>

Text field (field type Text) is a box or space for text fill-in data typically entered from a keyboard. The text may be restricted to a single line or may be permitted to span multiple lines, depending on the setting of the Multi line flag in the field dictionary’s Ff entry. Table 228 shows the flags pertaining to this type of field. A text field shall have a field type of Text. A conforming PDF file, and a conforming processor shall obey the usage guidelines as defined by the big flags below.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
protected FontFile	fontFile

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildTextWidgetContents(java.lang.String currentContentStream)
java.lang.String	generateDefaultAppearance(java.lang.String content, java.lang.String defaultAppearance)
TextFieldDictionary	getFieldDictionary()
void	reset()
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageTransform)

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

fontFile

protected FontFile fontFile

Constructor Detail

TextWidgetAnnotation

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

Method Detail

resetAppearanceStream

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

Specified by:

resetAppearanceStream in class AbstractWidgetAnnotation<TextFieldDictionary>

buildTextWidgetContents

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

reset

public void reset()

Specified by:

reset in class AbstractWidgetAnnotation<TextFieldDictionary>

getFieldDictionary

public TextFieldDictionary getFieldDictionary()

Specified by:

getFieldDictionary in class AbstractWidgetAnnotation<TextFieldDictionary>

generateDefaultAppearance

public java.lang.String generateDefaultAppearance(java.lang.String content,
                                                  java.lang.String defaultAppearance)