org.icepdf.core.pobjects.annotations

Class AbstractWidgetAnnotation<T extends FieldDictionary>

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.annotations.Annotation

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

Direct Known Subclasses:

ButtonWidgetAnnotation, ChoiceWidgetAnnotation, TextWidgetAnnotation, WidgetAnnotation

public abstract class AbstractWidgetAnnotation<T extends FieldDictionary>
extends Annotation

Abstract base class for Widget annotations types, button, choice and text.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
static Name	HIGHLIGHT_NONE Indicates that the annotation has no highlight effect.
protected static float	highlightAlpha Transparency value used to simulate text highlighting.
protected static java.awt.Color	highlightColor
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, 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
AbstractWidgetAnnotation(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkAppearance(java.lang.String appearance) Utility to try and determine if the appearance is valid.
protected java.lang.StringBuilder	encodeLiteralString(java.lang.StringBuilder content, java.lang.String contents)
protected java.awt.geom.Rectangle2D.Float	findBoundRectangle(java.lang.String markedContent) Generally immediately after the BMC there is a rectangle that defines the actual size of the annotation.
protected java.awt.geom.Rectangle2D.Float	findRectangle(java.lang.String markedContent) Finds a rectangle in the marked content.
protected java.awt.geom.Rectangle2D.Float	findSelectionRectangle(java.lang.String markedContent) The selection rectangle if present will help define the line height of the text.
protected java.lang.String	generateRectangle(java.awt.geom.Rectangle2D.Float rect) Simple utility to write Rectangle2D.Float in postscript.
abstract T	getFieldDictionary()
protected double	getFontSize(java.lang.String content)
protected double	getLineHeight(java.lang.String defaultAppearance) Get the line height as specified by Th or the font size.
boolean	isEnableHighlightedWidget() Is enable highlight enabled.
protected float[]	parseRectanglePoints(java.lang.String potentialNumbers) Converts a given string of four numbers into an array of floats.
protected void	renderAppearanceStream(java.awt.Graphics2D g)
abstract void	reset()
abstract void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageSpace)
void	setEnableHighlightedWidget(boolean enableHighlightedWidget) Set enable highlight on an individual widget.
static void	setHighlightAlpha(float highlightAlpha) Set the static alpha value uses to paint a color over a widget annotation.
static void	setHighlightColor(java.awt.Color highlightColor) Set the static highlight color used to highlight widget annotations.

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

HIGHLIGHT_NONE

public static final Name HIGHLIGHT_NONE

Indicates that the annotation has no highlight effect.

highlightAlpha

protected static float highlightAlpha

Transparency value used to simulate text highlighting.

highlightColor

protected static java.awt.Color highlightColor

highlightMode

protected Name highlightMode

Constructor Detail

AbstractWidgetAnnotation

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

Method Detail

reset

public abstract void reset()

resetAppearanceStream

public abstract 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

getFieldDictionary

public abstract T getFieldDictionary()

findBoundRectangle

protected java.awt.geom.Rectangle2D.Float findBoundRectangle(java.lang.String markedContent)

Generally immediately after the BMC there is a rectangle that defines the actual size of the annotation. If found we can use this to make many assumptions and regenerate the content stream.

Parameters:

markedContent - content stream of the marked content.

Returns:

a rectangle either way, if the q # # # # re isn't found then we use the bbox as a potential bound.

findRectangle

protected java.awt.geom.Rectangle2D.Float findRectangle(java.lang.String markedContent)

Finds a rectangle in the marked content.

Parameters:

markedContent - content to search for a rectangle.

Returns:

rectangle if found, otherwise bbox is used.

getLineHeight

protected double getLineHeight(java.lang.String defaultAppearance)

Get the line height as specified by Th or the font size.

Parameters:

defaultAppearance - searchable stream

Returns:

line height, or 13.87 if no reasonable approximation can be found.

getFontSize

protected double getFontSize(java.lang.String content)

encodeLiteralString

protected java.lang.StringBuilder encodeLiteralString(java.lang.StringBuilder content,
                                                      java.lang.String contents)

checkAppearance

protected boolean checkAppearance(java.lang.String appearance)

Utility to try and determine if the appearance is valid.

Parameters:

appearance - appearance ot test.

Returns:

true if valid, false otherwise.

findSelectionRectangle

protected java.awt.geom.Rectangle2D.Float findSelectionRectangle(java.lang.String markedContent)

The selection rectangle if present will help define the line height of the text. If not present we can use the default value 13.87 later which seems to be very common in the samples.

Parameters:

markedContent - content to look for "rg # # # # re".

Returns:

selection rectangle, null if not found.

generateRectangle

protected java.lang.String generateRectangle(java.awt.geom.Rectangle2D.Float rect)

Simple utility to write Rectangle2D.Float in postscript.

Parameters:

rect - Rectangle2D.Float to convert to postscript. Null value with throw null pointer exception.

Returns:

postscript representation of the rect.

parseRectanglePoints

protected float[] parseRectanglePoints(java.lang.String potentialNumbers)

Converts a given string of four numbers into an array of floats. If a conversion error is encountered null value is returned.

Parameters:

potentialNumbers - space separated string of four numbers.

Returns:

list of four numbers, null if string can not be converted.

setHighlightColor

public static void setHighlightColor(java.awt.Color highlightColor)

Set the static highlight color used to highlight widget annotations.

Parameters:

highlightColor - colour of

setEnableHighlightedWidget

public void setEnableHighlightedWidget(boolean enableHighlightedWidget)

Set enable highlight on an individual widget.

Parameters:

enableHighlightedWidget - true to enable highlight mode, otherwise false.

setHighlightAlpha

public static void setHighlightAlpha(float highlightAlpha)

Set the static alpha value uses to paint a color over a widget annotation.

Parameters:

highlightAlpha -

isEnableHighlightedWidget

public boolean isEnableHighlightedWidget()

Is enable highlight enabled.

Returns:

return true if highlight is enabled, false otherwise.