Class Annotation

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Annotation​(float llx, float lly, float urx, float ury)
      Constructs an Annotation with a certain title and some text.
        Annotation​(float llx, float lly, float urx, float ury, int named)
      Constructs an Annotation.
        Annotation​(float llx, float lly, float urx, float ury, java.lang.String url)
      Constructs an Annotation.
        Annotation​(float llx, float lly, float urx, float ury, java.lang.String file, int page)
      Constructs an Annotation.
        Annotation​(float llx, float lly, float urx, float ury, java.lang.String file, java.lang.String dest)
      Constructs an Annotation.
        Annotation​(float llx, float lly, float urx, float ury, java.lang.String moviePath, java.lang.String mimeType, boolean showOnDisplay)
      Creates a Screen anotation to embed media clips
        Annotation​(float llx, float lly, float urx, float ury, java.lang.String application, java.lang.String parameters, java.lang.String operation, java.lang.String defaultdir)
      Constructs an Annotation.
        Annotation​(float llx, float lly, float urx, float ury, java.net.URL url)
      Constructs an Annotation.
        Annotation​(Annotation an)  
        Annotation​(java.lang.String title, java.lang.String text)
      Constructs an Annotation with a certain title and some text.
        Annotation​(java.lang.String title, java.lang.String text, float llx, float lly, float urx, float ury)
      Constructs an Annotation with a certain title and some text.
        Annotation​(java.util.Properties attributes)
      Returns an Annotation that has been constructed taking in account the value of some attributes .
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int annotationType()
      Returns the type of this Annotation.
      java.util.HashMap attributes()
      Gets the content of this Annotation.
      java.lang.String content()
      Gets the content of this Annotation.
      java.util.ArrayList getChunks()
      Gets all the chunks in this element.
      java.lang.String getMarkupAttribute​(java.lang.String name)
      Returns the value of the specified attribute.
      java.util.Set getMarkupAttributeNames()
      Returns a Set of String attribute names for the MarkupAttributes implementor.
      java.util.Properties getMarkupAttributes()
      Return a Properties-object containing all the markupAttributes.
      static boolean isTag​(java.lang.String tag)
      Checks if a given tag corresponds with this object.
      float llx()
      Returns the lower left x-value.
      float llx​(float def)
      Returns the lower left x-value.
      float lly()
      Returns the lower left y-value.
      float lly​(float def)
      Returns the lower left y-value.
      boolean process​(ElementListener listener)
      Processes the element by adding it (or the different parts) to an ElementListener.
      void setDimensions​(float llx, float lly, float urx, float ury)
      Sets the dimensions of this annotation.
      void setMarkupAttribute​(java.lang.String name, java.lang.String value)
      Sets the specified attribute.
      void setMarkupAttributes​(java.util.Properties markupAttributes)
      Sets the markupAttributes.
      java.lang.String title()
      Returns the title of this Annotation.
      int type()
      Gets the type of the text element.
      float urx()
      Returns the uppper right x-value.
      float urx​(float def)
      Returns the upper right x-value.
      float ury()
      Returns the uppper right y-value.
      float ury​(float def)
      Returns the upper right y-value.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.gitlab.pdftk_java.com.lowagie.text.Element

        toString
    • Field Detail

      • URL_NET

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        protected java.util.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 Detail

      • 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​(java.lang.String title,
                          java.lang.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​(java.lang.String title,
                          java.lang.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,
                          java.net.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,
                          java.lang.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,
                          java.lang.String file,
                          java.lang.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,
                          java.lang.String moviePath,
                          java.lang.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,
                          java.lang.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,
                          java.lang.String application,
                          java.lang.String parameters,
                          java.lang.String operation,
                          java.lang.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​(java.util.Properties attributes)
        Returns an Annotation that has been constructed taking in account the value of some attributes .
        Parameters:
        attributes - Some attributes
    • Method Detail

      • 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 java.util.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 java.lang.String title()
        Returns the title of this Annotation.
        Returns:
        a name
      • content

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

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

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