Class Annotation

java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.Annotation
All Implemented Interfaces:
Element, MarkupAttributes

public class Annotation extends Object implements Element, MarkupAttributes
An Annotation is a little note that can be added to a page on a document.
See Also:
  • Field Details

    • TEXT

      public static final int TEXT
      This is a possible annotation type.
      See Also:
    • URL_NET

      public static final int URL_NET
      This is a possible annotation type.
      See Also:
    • URL_AS_STRING

      public static final int URL_AS_STRING
      This is a possible annotation type.
      See Also:
    • FILE_DEST

      public static final int FILE_DEST
      This is a possible annotation type.
      See Also:
    • FILE_PAGE

      public static final int FILE_PAGE
      This is a possible annotation type.
      See Also:
    • NAMED_DEST

      public static final int NAMED_DEST
      This is a possible annotation type.
      See Also:
    • LAUNCH

      public static final int LAUNCH
      This is a possible annotation type.
      See Also:
    • SCREEN

      public static final int SCREEN
      This is a possible annotation type.
      See Also:
    • TITLE

      public static String TITLE
      This is a possible attribute.
    • CONTENT

      public static String CONTENT
      This is a possible attribute.
    • URL

      public static String URL
      This is a possible attribute.
    • FILE

      public static String FILE
      This is a possible attribute.
    • DESTINATION

      public static String DESTINATION
      This is a possible attribute.
    • PAGE

      public static String PAGE
      This is a possible attribute.
    • NAMED

      public static String NAMED
      This is a possible attribute.
    • APPLICATION

      public static String APPLICATION
      This is a possible attribute.
    • PARAMETERS

      public static String PARAMETERS
      This is a possible attribute.
    • OPERATION

      public static String OPERATION
      This is a possible attribute.
    • DEFAULTDIR

      public static String DEFAULTDIR
      This is a possible attribute.
    • LLX

      public static String LLX
      This is a possible attribute.
    • LLY

      public static String LLY
      This is a possible attribute.
    • URX

      public static String URX
      This is a possible attribute.
    • URY

      public static String URY
      This is a possible attribute.
    • MIMETYPE

      public static String MIMETYPE
      This is a possible attribute.
    • annotationtype

      protected int annotationtype
      This is the type of annotation.
    • annotationAttributes

      protected HashMap annotationAttributes
      This is the title of the Annotation.
    • markupAttributes

      protected Properties markupAttributes
      Contains extra markupAttributes
    • llx

      protected float llx
      This is the lower left x-value
    • lly

      protected float lly
      This is the lower left y-value
    • urx

      protected float urx
      This is the upper right x-value
    • ury

      protected float ury
      This is the upper right y-value
  • Constructor Details

    • Annotation

      private Annotation(float llx, float lly, float urx, float ury)
      Constructs an Annotation with a certain title and some text.
      Parameters:
      llx - lower left x coordinate
      lly - lower left y coordinate
      urx - upper right x coordinate
      ury - upper right y coordinate
    • Annotation

      public Annotation(Annotation an)
    • Annotation

      public Annotation(String title, String text)
      Constructs an Annotation with a certain title and some text.
      Parameters:
      title - the title of the annotation
      text - the content of the annotation
    • Annotation

      public Annotation(String title, String text, float llx, float lly, float urx, float ury)
      Constructs an Annotation with a certain title and some text.
      Parameters:
      title - the title of the annotation
      text - the content of the annotation
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, URL url)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      url - the external reference
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, String url)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      url - the external reference
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, String file, String dest)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      file - an external PDF file
      dest - the destination in this file
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, String moviePath, String mimeType, boolean showOnDisplay)
      Creates a Screen anotation to embed media clips
      Parameters:
      llx -
      lly -
      urx -
      ury -
      moviePath - path to the media clip file
      mimeType - mime type of the media
      showOnDisplay - if true play on display of the page
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, String file, int page)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      file - an external PDF file
      page - a page number in this file
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, int named)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      named - a named destination in this file
    • Annotation

      public Annotation(float llx, float lly, float urx, float ury, String application, String parameters, String operation, String defaultdir)
      Constructs an Annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
      application - an external application
      parameters - parameters to pass to this application
      operation - the operation to pass to this application
      defaultdir - the default directory to run this application in
    • Annotation

      public Annotation(Properties attributes)
      Returns an Annotation that has been constructed taking in account the value of some attributes .
      Parameters:
      attributes - Some attributes
  • Method Details

    • type

      public int type()
      Gets the type of the text element.
      Specified by:
      type in interface Element
      Returns:
      a type
    • process

      public boolean process(ElementListener listener)
      Processes the element by adding it (or the different parts) to an ElementListener.
      Specified by:
      process in interface Element
      Parameters:
      listener - an ElementListener
      Returns:
      true if the element was processed successfully
    • getChunks

      public ArrayList getChunks()
      Gets all the chunks in this element.
      Specified by:
      getChunks in interface Element
      Returns:
      an ArrayList
    • setDimensions

      public void setDimensions(float llx, float lly, float urx, float ury)
      Sets the dimensions of this annotation.
      Parameters:
      llx - the lower left x-value
      lly - the lower left y-value
      urx - the upper right x-value
      ury - the upper right y-value
    • llx

      public float llx()
      Returns the lower left x-value.
      Returns:
      a value
    • lly

      public float lly()
      Returns the lower left y-value.
      Returns:
      a value
    • urx

      public float urx()
      Returns the uppper right x-value.
      Returns:
      a value
    • ury

      public float ury()
      Returns the uppper right y-value.
      Returns:
      a value
    • llx

      public float llx(float def)
      Returns the lower left x-value.
      Parameters:
      def - the default value
      Returns:
      a value
    • lly

      public float lly(float def)
      Returns the lower left y-value.
      Parameters:
      def - the default value
      Returns:
      a value
    • urx

      public float urx(float def)
      Returns the upper right x-value.
      Parameters:
      def - the default value
      Returns:
      a value
    • ury

      public float ury(float def)
      Returns the upper right y-value.
      Parameters:
      def - the default value
      Returns:
      a value
    • annotationType

      public int annotationType()
      Returns the type of this Annotation.
      Returns:
      a type
    • title

      public String title()
      Returns the title of this Annotation.
      Returns:
      a name
    • content

      public String content()
      Gets the content of this Annotation.
      Returns:
      a reference
    • attributes

      public HashMap attributes()
      Gets the content of this Annotation.
      Returns:
      a reference
    • isTag

      public static boolean isTag(String tag)
      Checks if a given tag corresponds with this object.
      Parameters:
      tag - the given tag
      Returns:
      true if the tag corresponds
    • setMarkupAttribute

      public void setMarkupAttribute(String name, String value)
      Description copied from interface: MarkupAttributes
      Sets the specified attribute.
      Specified by:
      setMarkupAttribute in interface MarkupAttributes
      Parameters:
      name - String attribute name.
      value - String attribute value.
      See Also:
    • setMarkupAttributes

      public void setMarkupAttributes(Properties markupAttributes)
      Description copied from interface: MarkupAttributes
      Sets the markupAttributes.
      Specified by:
      setMarkupAttributes in interface MarkupAttributes
      Parameters:
      markupAttributes - a Properties-object containing markupattributes
      See Also:
    • getMarkupAttribute

      public String getMarkupAttribute(String name)
      Description copied from interface: MarkupAttributes
      Returns the value of the specified attribute.
      Specified by:
      getMarkupAttribute in interface MarkupAttributes
      Parameters:
      name - String attribute name.
      Returns:
      String.
      See Also:
    • getMarkupAttributeNames

      public Set getMarkupAttributeNames()
      Description copied from interface: MarkupAttributes
      Returns a Set of String attribute names for the MarkupAttributes implementor.
      Specified by:
      getMarkupAttributeNames in interface MarkupAttributes
      Returns:
      Set.
      See Also:
    • getMarkupAttributes

      public Properties getMarkupAttributes()
      Description copied from interface: MarkupAttributes
      Return a Properties-object containing all the markupAttributes.
      Specified by:
      getMarkupAttributes in interface MarkupAttributes
      Returns:
      Properties
      See Also: