Class PDAnnotationSquareCircle

  • All Implemented Interfaces:
    COSObjectable

    public class PDAnnotationSquareCircle
    extends PDAnnotationMarkup
    This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
    Author:
    Paul King
    • Field Detail

      • SUB_TYPE_SQUARE

        public static final java.lang.String SUB_TYPE_SQUARE
        Constant for a Rectangular type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_CIRCLE

        public static final java.lang.String SUB_TYPE_CIRCLE
        Constant for an elliptical type of annotation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PDAnnotationSquareCircle

        public PDAnnotationSquareCircle​(java.lang.String subType)
        Creates a Circle or Square annotation of the specified sub type.
        Parameters:
        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.
        Parameters:
        field - the PDF object to represent as a field.
    • Method Detail

      • setInteriorColor

        public void setInteriorColor​(PDColor ic)
        This will set interior color of the drawn area color is in DeviceRGB colo rspace.
        Parameters:
        ic - color in the DeviceRGB color space.
      • getInteriorColor

        public PDColor getInteriorColor()
        This will retrieve the interior color of the drawn area color is in DeviceRGB color space.
        Returns:
        object representing the color.
      • setBorderEffect

        public void setBorderEffect​(PDBorderEffectDictionary be)
        This will set the border effect dictionary, specifying effects to be applied when drawing the line.
        Parameters:
        be - The border effect dictionary to set.
      • getBorderEffect

        public PDBorderEffectDictionary getBorderEffect()
        This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
        Returns:
        The border effect dictionary
      • 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)
        Parameters:
        rd - the rectangle difference
      • 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)
        Returns:
        the rectangle difference
      • setSubtype

        public void setSubtype​(java.lang.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.
        Parameters:
        subType - The subtype of the annotation
      • getSubtype

        public java.lang.String getSubtype()
        This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
        Overrides:
        getSubtype in class PDAnnotation
        Returns:
        The subtype of this annotation, see the SUB_TYPE_XXX constants.
      • setBorderStyle

        public void setBorderStyle​(PDBorderStyleDictionary bs)
        This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
        Overrides:
        setBorderStyle in class PDAnnotationMarkup
        Parameters:
        bs - the border style dictionary to set. TODO not all annotations may have a BS entry
      • getBorderStyle

        public PDBorderStyleDictionary getBorderStyle()
        This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
        Overrides:
        getBorderStyle in class PDAnnotationMarkup
        Returns:
        the border style dictionary. TODO not all annotations may have a BS entry