Class PDAnnotationText

  • All Implemented Interfaces:
    COSObjectable

    public class PDAnnotationText
    extends PDAnnotationMarkup
    This is the class that represents a text annotation.
    Version:
    $Revision: 1.1 $
    Author:
    Paul King
    • Field Detail

      • NAME_COMMENT

        public static final java.lang.String NAME_COMMENT
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_KEY

        public static final java.lang.String NAME_KEY
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_NOTE

        public static final java.lang.String NAME_NOTE
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_HELP

        public static final java.lang.String NAME_HELP
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_NEW_PARAGRAPH

        public static final java.lang.String NAME_NEW_PARAGRAPH
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_PARAGRAPH

        public static final java.lang.String NAME_PARAGRAPH
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • NAME_INSERT

        public static final java.lang.String NAME_INSERT
        Constant for the name of a text annotation.
        See Also:
        Constant Field Values
      • SUB_TYPE

        public static final java.lang.String SUB_TYPE
        The type of annotation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PDAnnotationText

        public PDAnnotationText()
        Constructor.
      • PDAnnotationText

        public PDAnnotationText​(COSDictionary field)
        Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
        Parameters:
        field - the PDF object to represent as a field.
    • Method Detail

      • setOpen

        public void setOpen​(boolean open)
        This will set initial state of the annotation, open or closed.
        Parameters:
        open - Boolean value, true = open false = closed
      • getOpen

        public boolean getOpen()
        This will retrieve the initial state of the annotation, open Or closed (default closed).
        Returns:
        The initial state, true = open false = closed
      • setName

        public void setName​(java.lang.String name)
        This will set the name (and hence appearance, AP taking precedence) For this annotation. See the NAME_XXX constants for valid values.
        Parameters:
        name - The name of the annotation
      • getName

        public java.lang.String getName()
        This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is NOTE.
        Returns:
        The name of this annotation, see the NAME_XXX constants.
      • getState

        public java.lang.String getState()
        This will retrieve the annotation state.
        Returns:
        the annotation state
      • setState

        public void setState​(java.lang.String state)
        This will set the annotation state.
        Parameters:
        state - the annotation state
      • getStateModel

        public java.lang.String getStateModel()
        This will retrieve the annotation state model.
        Returns:
        the annotation state model
      • setStateModel

        public void setStateModel​(java.lang.String stateModel)
        This will set the annotation state model. Allowed values are "Marked" and "Review"
        Parameters:
        stateModel - the annotation state model