Class PDAnnotationSquareCircle
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
- All Implemented Interfaces:
COSObjectable
This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PDAppearanceHandler
static final String
Constant for an elliptical type of annotation.static final String
Constant for a Rectangular type of annotation.Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
IT_FREE_TEXT, IT_FREE_TEXT_CALLOUT, IT_FREE_TEXT_TYPE_WRITER, RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
-
Constructor Summary
ConstructorsConstructorDescriptionPDAnnotationSquareCircle
(String subType) Creates a Circle or Square annotation of the specified sub type.Creates a Line annotation from a COSDictionary, expected to be a correct object definition. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Create the appearance entry for this annotation.void
constructAppearances
(PDDocument document) Create the appearance entry for this annotation.This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.This will retrieve the interior color of the drawn area color is in DeviceRGB color space.This will get the rectangle difference rectangle.float[]
This will get the differences between the annotations "outer" rectangle defined by /Rect and the border.This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.void
This will set the border effect dictionary, specifying effects to be applied when drawing the line.void
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.void
setCustomAppearanceHandler
(PDAppearanceHandler appearanceHandler) Set a custom appearance handler for generating the annotations appearance streams.void
This will set interior color of the drawn area color is in DeviceRGB colo rspace.void
This will set the rectangle difference rectangle.void
setRectDifferences
(float difference) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.void
setRectDifferences
(float differenceLeft, float differenceTop, float differenceRight, float differenceBottom) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.void
setSubtype
(String subType) This will set the sub type (and hence appearance, AP taking precedence) For this annotation.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
getCallout, getConstantOpacity, getCreationDate, getDefaultAppearance, getDefaultStyleString, getEndPointEndingStyle, getExternalData, getInkList, getInReplyTo, getIntent, getLineEndingStyle, getPath, getPopup, getQ, getReplyType, getRichContents, getStartPointEndingStyle, getSubject, getTitlePopup, getVertices, setCallout, setConstantOpacity, setCreationDate, setDefaultAppearance, setDefaultStyleString, setEndPointEndingStyle, setExternalData, setInkList, setInReplyTo, setIntent, setLineEndingStyle, setPopup, setQ, setReplyType, setRichContents, setStartPointEndingStyle, setSubject, setTitlePopup, setVertices
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, hashCode, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
-
Field Details
-
SUB_TYPE_SQUARE
Constant for a Rectangular type of annotation.- See Also:
-
SUB_TYPE_CIRCLE
Constant for an elliptical type of annotation.- See Also:
-
customAppearanceHandler
-
-
Constructor Details
-
PDAnnotationSquareCircle
Creates a Circle or Square annotation of the specified sub type.- Parameters:
subType
- the subtype the annotation represents.
-
PDAnnotationSquareCircle
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.- Parameters:
field
- the PDF object to represent as a field.
-
-
Method Details
-
setInteriorColor
This will set interior color of the drawn area color is in DeviceRGB colo rspace.- Overrides:
setInteriorColor
in classPDAnnotationMarkup
- Parameters:
ic
- color in the DeviceRGB color space.
-
getInteriorColor
This will retrieve the interior color of the drawn area color is in DeviceRGB color space.- Overrides:
getInteriorColor
in classPDAnnotationMarkup
- Returns:
- object representing the color.
-
setBorderEffect
This will set the border effect dictionary, specifying effects to be applied when drawing the line.- Overrides:
setBorderEffect
in classPDAnnotationMarkup
- Parameters:
be
- The border effect dictionary to set.
-
getBorderEffect
This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.- Overrides:
getBorderEffect
in classPDAnnotationMarkup
- Returns:
- The border effect dictionary
-
setRectDifference
This will set the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry forexample)- Overrides:
setRectDifference
in classPDAnnotationMarkup
- Parameters:
rd
- the rectangle difference
-
getRectDifference
This will get the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry forexample)- Overrides:
getRectDifference
in classPDAnnotationMarkup
- Returns:
- the rectangle difference
-
setSubtype
This will set the sub type (and hence appearance, AP taking precedence) For this annotation. See the SUB_TYPE_XXX constants for valid values.- Parameters:
subType
- The subtype of the annotation
-
getSubtype
This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.- Overrides:
getSubtype
in classPDAnnotation
- Returns:
- The subtype of this annotation, see the SUB_TYPE_XXX constants.
-
setBorderStyle
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.- Overrides:
setBorderStyle
in classPDAnnotationMarkup
- Parameters:
bs
- the border style dictionary to set. TODO not all annotations may have a BS entry
-
getBorderStyle
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.- Overrides:
getBorderStyle
in classPDAnnotationMarkup
- Returns:
- the border style dictionary. TODO not all annotations may have a BS entry
-
setRectDifferences
public void setRectDifferences(float difference) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.This will set an equal difference for all sides
- Overrides:
setRectDifferences
in classPDAnnotationMarkup
- Parameters:
difference
- from the annotations /Rect entry
-
setRectDifferences
public void setRectDifferences(float differenceLeft, float differenceTop, float differenceRight, float differenceBottom) This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.- Overrides:
setRectDifferences
in classPDAnnotationMarkup
- Parameters:
differenceLeft
- left difference from the annotations /Rect entrydifferenceTop
- top difference from the annotations /Rect entrydifferenceRight
- right difference from the annotations /Rect entrydifferenceBottom
- bottom difference from the annotations /Rect entry
-
getRectDifferences
public float[] getRectDifferences()This will get the differences between the annotations "outer" rectangle defined by /Rect and the border.- Overrides:
getRectDifferences
in classPDAnnotationMarkup
- Returns:
- the differences. If the entry hasn't been set am empty array is returned.
-
setCustomAppearanceHandler
Set a custom appearance handler for generating the annotations appearance streams.- Overrides:
setCustomAppearanceHandler
in classPDAnnotationMarkup
- Parameters:
appearanceHandler
-
-
constructAppearances
public void constructAppearances()Description copied from class:PDAnnotation
Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.- Overrides:
constructAppearances
in classPDAnnotationMarkup
-
constructAppearances
Description copied from class:PDAnnotation
Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.- Overrides:
constructAppearances
in classPDAnnotationMarkup
-