COSObjectable
public class PDAnnotationSquareCircle extends PDAnnotationMarkup
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SUB_TYPE_CIRCLE |
Constant for an Eliptical type of annotation.
|
static java.lang.String |
SUB_TYPE_SQUARE |
Constant for a Rectangular type of annotation.
|
FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINTED, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
Constructor | Description |
---|---|
PDAnnotationSquareCircle(java.lang.String subType) |
Creates a Circle or Square annotation of the specified sub type.
|
PDAnnotationSquareCircle(COSDictionary field) |
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
|
Modifier and Type | Method | Description |
---|---|---|
PDBorderEffectDictionary |
getBorderEffect() |
This will retrieve the border effect dictionary, specifying effects to be
applied used in drawing the line.
|
PDBorderStyleDictionary |
getBorderStyle() |
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
|
PDGamma |
getInteriorColour() |
This will retrieve the interior colour of the drawn area
Colour is in DeviceRGB colourspace.
|
PDRectangle |
getRectDifference() |
This will get the rectangle difference rectangle.
|
java.lang.String |
getSubtype() |
This will retrieve the sub type (and hence appearance, AP taking precedence)
For this annotation.
|
void |
setBorderEffect(PDBorderEffectDictionary be) |
This will set the border effect dictionary, specifying effects to be applied
when drawing the line.
|
void |
setBorderStyle(PDBorderStyleDictionary bs) |
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
|
void |
setInteriorColour(PDGamma ic) |
This will set interior colour of the drawn area
Colour is in DeviceRGB colourspace.
|
void |
setRectDifference(PDRectangle rd) |
This will set the rectangle difference rectangle.
|
void |
setSubtype(java.lang.String subType) |
This will set the sub type (and hence appearance, AP taking precedence) For
this annotation.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getColour, getContents, getCOSObject, getDictionary, getModifiedDate, getPage, getRectangle, getStructParent, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup
public static final java.lang.String SUB_TYPE_SQUARE
public static final java.lang.String SUB_TYPE_CIRCLE
public PDAnnotationSquareCircle(java.lang.String subType)
subType
- the subtype the annotation represents.public PDAnnotationSquareCircle(COSDictionary field)
field
- the PDF objet to represent as a field.public void setInteriorColour(PDGamma ic)
ic
- colour in the DeviceRGB colourspace.public PDGamma getInteriorColour()
public void setBorderEffect(PDBorderEffectDictionary be)
be
- The border effect dictionary to set.public PDBorderEffectDictionary getBorderEffect()
public void setRectDifference(PDRectangle rd)
rd
- the rectangle differencepublic PDRectangle getRectDifference()
public void setSubtype(java.lang.String subType)
subType
- The subtype of the annotationpublic java.lang.String getSubtype()
getSubtype
in class PDAnnotation
public void setBorderStyle(PDBorderStyleDictionary bs)
bs
- the border style dictionary to set.
TODO not all annotations may have a BS entrypublic PDBorderStyleDictionary getBorderStyle()