Class PDAnnotationMarkup

    • Field Detail

      • SUB_TYPE_FREETEXT

        public static final java.lang.String SUB_TYPE_FREETEXT
        Constant for a FreeText type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_POLYGON

        public static final java.lang.String SUB_TYPE_POLYGON
        Constant for an Polygon type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_POLYLINE

        public static final java.lang.String SUB_TYPE_POLYLINE
        Constant for an PolyLine type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_CARET

        public static final java.lang.String SUB_TYPE_CARET
        Constant for an Caret type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_INK

        public static final java.lang.String SUB_TYPE_INK
        Constant for an Ink type of annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE_SOUND

        public static final java.lang.String SUB_TYPE_SOUND
        Constant for an Sound type of annotation.
        See Also:
        Constant Field Values
      • RT_REPLY

        public static final java.lang.String RT_REPLY
        Constant for an annotation reply type.
        See Also:
        Constant Field Values
      • RT_GROUP

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

      • PDAnnotationMarkup

        public PDAnnotationMarkup()
        Constructor.
      • PDAnnotationMarkup

        public PDAnnotationMarkup​(COSDictionary dict)
        Constructor.
        Parameters:
        dict - The annotations dictionary.
    • Method Detail

      • getTitlePopup

        public java.lang.String getTitlePopup()
        Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
        Returns:
        The title of the popup.
      • setTitlePopup

        public void setTitlePopup​(java.lang.String t)
        Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
        Parameters:
        t - The title of the popup.
      • getPopup

        public PDAnnotationPopup getPopup()
        This will retrieve the popup annotation used for entering/editing the text for this annotation.
        Returns:
        the popup annotation.
      • setPopup

        public void setPopup​(PDAnnotationPopup popup)
        This will set the popup annotation used for entering/editing the text for this annotation.
        Parameters:
        popup - the popup annotation.
      • getConstantOpacity

        public float getConstantOpacity()
        This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
        Returns:
        the constant opacity value.
      • setConstantOpacity

        public void setConstantOpacity​(float ca)
        This will set the constant opacity value used when rendering the annotation (excluing any popup).
        Parameters:
        ca - the constant opacity value.
      • getRichContents

        public java.lang.String getRichContents()
        This will retrieve the rich text stream which is displayed in the popup window.
        Returns:
        the rich text stream.
      • setRichContents

        public void setRichContents​(java.lang.String rc)
        This will set the rich text stream which is displayed in the popup window.
        Parameters:
        rc - the rich text stream.
      • getCreationDate

        public java.util.Calendar getCreationDate()
                                           throws java.io.IOException
        This will retrieve the date and time the annotation was created.
        Returns:
        the creation date/time.
        Throws:
        java.io.IOException - if there is a format problem when converting the date.
      • setCreationDate

        public void setCreationDate​(java.util.Calendar creationDate)
        This will set the date and time the annotation was created.
        Parameters:
        creationDate - the date and time the annotation was created.
      • getInReplyTo

        public PDAnnotation getInReplyTo()
                                  throws java.io.IOException
        This will retrieve the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
        Returns:
        the other annotation or null if there is none.
        Throws:
        java.io.IOException - if there is an error creating the other annotation.
      • setInReplyTo

        public void setInReplyTo​(PDAnnotation irt)
        This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
        Parameters:
        irt - the annotation this one is "In Reply To".
      • getSubject

        public java.lang.String getSubject()
        This will retrieve the short description of the subject of the annotation.
        Returns:
        the subject.
      • setSubject

        public void setSubject​(java.lang.String subj)
        This will set the short description of the subject of the annotation.
        Parameters:
        subj - short description of the subject.
      • getReplyType

        public java.lang.String getReplyType()
        This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
        Returns:
        the relationship.
      • setReplyType

        public void setReplyType​(java.lang.String rt)
        This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
        Parameters:
        rt - the reply type.
      • getIntent

        public java.lang.String getIntent()
        This will retrieve the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
        Returns:
        the intent
      • setIntent

        public void setIntent​(java.lang.String it)
        This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
        Parameters:
        it - the intent
      • getExternalData

        public PDExternalDataDictionary getExternalData()
        This will return the external data dictionary.
        Returns:
        the external data dictionary
      • setExternalData

        public void setExternalData​(PDExternalDataDictionary externalData)
        This will set the external data dictionary.
        Parameters:
        externalData - the external data dictionary
      • setBorderStyle

        public void setBorderStyle​(PDBorderStyleDictionary bs)
        This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
        Parameters:
        bs - the border style dictionary to set.
      • getBorderStyle

        public PDBorderStyleDictionary getBorderStyle()
        This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
        Returns:
        the border style dictionary.