Class Annotation

java.lang.Object
com.lowagie.text.Annotation
All Implemented Interfaces:
Element

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

  • 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)
      Copy constructor.
      Parameters:
      an - an object of type Annotation that will be copied
    • 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 annotation to embed media clips
      Parameters:
      llx - llx
      lly - lly
      urx - urx
      ury - 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
  • 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<Element> 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 upper right x-value.
      Returns:
      a value
    • ury

      public float ury()
      Returns the upper 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
    • getAttributes

      public Map<String,Object> getAttributes()
      Gets the content of this Annotation.
      Returns:
      a reference
    • isContent

      public boolean isContent()
      Description copied from interface: Element
      Checks if this element is a content object. If not, it's a metadata object.
      Specified by:
      isContent in interface Element
      Returns:
      true if this is a 'content' element; false if this is a 'metadata' element
      Since:
      iText 2.0.8
      See Also:
    • isNestable

      public boolean isNestable()
      Description copied from interface: Element
      Checks if this element is nestable.
      Specified by:
      isNestable in interface Element
      Returns:
      true if this element can be nested inside other elements.
      Since:
      iText 2.0.8
      See Also: