org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationSquareCircle
- COSObjectable
public class PDAnnotationSquareCircle
This is the class that represents a rectangular or eliptical annotation
Introduced in PDF 1.3 specification .
static String | SUB_TYPE_CIRCLE - Constant for an Eliptical type of annotation.
|
static String | SUB_TYPE_SQUARE - Constant for a Rectangular type of annotation.
|
getConstantOpacity , getCreationDate , getInReplyTo , getIntent , getPopup , getReplyType , getRichContents , getSubject , getTitlePopup , setConstantOpacity , setCreationDate , setInReplyTo , setIntent , setPopup , setReplyType , setRichContents , setSubject , setTitlePopup |
createAnnotation , getAction , getActions , getAnnotationFlags , getAnnotationName , getAppearance , getAppearanceStream , getBoderStyle , getCOSObject , getColour , getContents , getDictionary , getModifiedDate , getRectangle , isHidden , isInvisible , isLocked , isNoRotate , isNoView , isNoZoom , isPrinted , isReadOnly , isToggleNoView , setAction , setActions , setAnnotationFlags , setAnnotationName , setAppearance , setAppearanceStream , setBorderStyle , setColour , setContents , setHidden , setInvisible , setLocked , setModifiedDate , setNoRotate , setNoView , setNoZoom , setPrinted , setReadOnly , setRectangle , setToggleNoView |
SUB_TYPE_CIRCLE
public static final String SUB_TYPE_CIRCLE
Constant for an Eliptical type of annotation.
SUB_TYPE_SQUARE
public static final String SUB_TYPE_SQUARE
Constant for a Rectangular type of annotation.
PDAnnotationSquareCircle
public PDAnnotationSquareCircle(String subType)
Creates a Circle or Square annotation of the specified sub type.
subType
- the subtype the annotation represents.
PDAnnotationSquareCircle
public PDAnnotationSquareCircle(COSDictionary field)
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
field
- the PDF objet to represent as a field.
getBorderEffect
public PDBorderEffectDictionary getBorderEffect()
This will retrieve the border effect dictionary, specifying effects to be
applied used in drawing the line.
- The border effect dictionary
getInteriorColour
public PDGamma getInteriorColour()
This will retrieve the interior colour of the drawn area
Colour is in DeviceRGB colourspace.
- PDGamma object representing the colour.
getRectDifference
public PDRectangle 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)
getSubtype
public String getSubtype()
This will retrieve the sub type (and hence appearance, AP taking precedence)
For this annotation.
- The subtype of this annotation, see the SUB_TYPE_XXX constants.
setBorderEffect
public void setBorderEffect(PDBorderEffectDictionary be)
This will set the border effect dictionary, specifying effects to be applied
when drawing the line.
be
- The border effect dictionary to set.
setInteriorColour
public void setInteriorColour(PDGamma ic)
This will set interior colour of the drawn area
Colour is in DeviceRGB colourspace.
ic
- colour in the DeviceRGB colourspace.
setRectDifference
public void setRectDifference(PDRectangle rd)
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)
rd
- the rectangle difference
setSubtype
public void setSubtype(String subType)
This will set the sub type (and hence appearance, AP taking precedence) For
this annotation. See the SUB_TYPE_XXX constants for valid values.
subType
- The subtype of the annotation