org.icepdf.core.pobjects.annotations
Class SquareAnnotation

java.lang.Object
  org.icepdf.core.pobjects.Dictionary
      org.icepdf.core.pobjects.annotations.Annotation
          org.icepdf.core.pobjects.annotations.MarkupAnnotation
              org.icepdf.core.pobjects.annotations.SquareAnnotation

public class SquareAnnotation
extends MarkupAnnotation

Square annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. When opened, they shall display a pop-up window containing the text of the associated note. The rectangle or ellipse shall be inscribed within the annotation rectangle defined by the annotation dictionary’s Rect entry (see Table 168).

Figure 63 shows two annotations, each with a border width of 18 points. Despite the names square and circle, the width and height of the annotation rectangle need not be equal. Table 177 shows the annotation dictionary entries specific to these types of annotations.

Since:

5.0

Field Summary

static Name

IC_KEY (Optional; PDF 1.4) An array of numbers in the range 0.0 to 1.0 specifying the interior color that shall be used to fill the annotation’s line endings (see Table 176).

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

CA_KEY, CREATION_DATE_KEY, creationDate, EX_DATA_KEY, inReplyToAnnotation, intent, IRT_KEY, IT_KEY, opacity, POPUP_KEY, popupAnnotation, RC_KEY, replyToRelation, richText, RT_KEY, SUBJ_KEY, subject, T_KEY, titleText

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

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

Method Summary

java.awt.Color	getFillColor()
static SquareAnnotation	getInstance(Library library, java.awt.Rectangle rect) Gets an instance of a SquareAnnotation that has valid Object Reference.
java.awt.Rectangle	getRectangle()
void	init() Initiate the Dictionary.
boolean	isFillColor()
void	resetAppearanceStream(double dx, double dy, java.awt.geom.AffineTransform pageTransform) Resets the annotations appearance stream.
void	setFillColor(boolean fillColor)
void	setFillColor(java.awt.Color fillColor)
void	setRectangle(java.awt.Rectangle rectangle)

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

getCreationDate, getInReplyToAnnotation, getIntent, getOpacity, getPopupAnnotation, getReplyToRelation, getRichText, getSubject, getTitleText, setCreationDate, setInReplyToAnnotation, setPopupAnnotation, setRichText, setSubject, setTitleText, toString

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, renderAppearanceStream, renderBorder, renderBorderTabSelected, resetAppearanceStream, setBBox, setBorderStyle, setColor, setCompressAppearanceStream, setContents, setFlag, setModifiedDate, setSubtype, setUserSpaceRectangle, syncBBoxToUserSpaceRectangle, 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

IC_KEY

public static final Name IC_KEY

(Optional; PDF 1.4) An array of numbers in the range 0.0 to 1.0 specifying the interior color that shall be used to fill the annotation’s line endings (see Table 176). The number of array elements shall determine the colour space in which the colour is defined: 0 - No colour; transparent 1 - DeviceGray 3 - DeviceRGB 4 - DeviceCMYK

Constructor Detail

SquareAnnotation

public SquareAnnotation(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 MarkupAnnotation

getInstance

public static SquareAnnotation getInstance(Library library,
                                           java.awt.Rectangle rect)

Gets an instance of a SquareAnnotation that has valid Object Reference.

Parameters:

library - document library

rect - bounding rectangle in user space

Returns:

new SquareAnnotation Instance.

resetAppearanceStream

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

Resets the annotations appearance stream.

Specified by:

resetAppearanceStream in class Annotation

getFillColor

public java.awt.Color getFillColor()

setFillColor

public void setFillColor(java.awt.Color fillColor)

getRectangle

public java.awt.Rectangle getRectangle()

setRectangle

public void setRectangle(java.awt.Rectangle rectangle)

isFillColor

public boolean isFillColor()

setFillColor

public void setFillColor(boolean fillColor)