Package com.inductiveautomation.rm.pdf.writer

Class PDFOutput

  • Direct Known Subclasses:
    PDFBuffer, PDFOutputStream
    public abstract class PDFOutput
extends java.lang.Object
    A PDF Output destination. The child classes are responsible for the implementation, but the PDFOutputStream is currently the preferred option to prevent large PDFs from residing in memory unnecessarily.

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFOutput()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      PDFOutput append​(byte[] theBytes)
      Appends an arbitrary byte array.
      abstract PDFOutput append​(byte[] theBytes, int anOffset, int aLength)
      Appends an arbitrary byte array with the given offset and length.
      abstract PDFOutput append​(char aChar)
      Adds a character to the pdf buffer.
      PDFOutput append​(double aDouble)
      Adds a double and newline to the pdf buffer.
      PDFOutput append​(int anInt)
      Adds an int to the pdf buffer.
      PDFOutput append​(RMRect aRect)
      Writes a rect to the pdf buffer.
      PDFOutput append​(RMColor aColor)
      Writes a color.
      PDFOutput append​(java.lang.String aString)
      Adds a string to the pdf buffer.
      PDFOutput appendDigits​(int anInt, int aPad)
      Appends digits of a whole number (recursively), padded by zeros on the left to the given number of pad digits.
      PDFOutput appendln()
      Adds a newline to the pdf buffer.
      PDFOutput appendln​(java.lang.String aString)
      Adds a string and newline to the pdf buffer.
      void curveTo​(float x1, float y1, float x2, float y2, float x3, float y3)
      Writes a curveto operator.
      abstract long length()
      Returns the current length of the output.
      void lineTo​(float x, float y)
      Writes a lineto operator.
      void moveTo​(float x, float y)
      Writes a moveto operator.
      void printPDFString​(java.lang.String aString)
      Adds a string object ( a string enclosed in parentheses ) to the buffer.
      void quadTo​(float lastX, float lastY, float x1, float y1, float x2, float y2)
      Writes a quadto operator.
      void transform​(double a, double b, double c, double d, double tx, double ty)
      Writes a transform to pdf buffer.
      void transform​(RMTransform aTransform)
      Writes a transform to pdf buffer.
      void writePath​(java.awt.Shape aShape)
      Writes a given path to PDF file.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PDFOutput

        public PDFOutput()

    • Method Detail

      • length

        public abstract long length()
        Returns the current length of the output.

      • append

        public abstract PDFOutput append​(char aChar)
        Adds a character to the pdf buffer.

      • append

        public abstract PDFOutput append​(byte[] theBytes,
                                 int anOffset,
                                 int aLength)
        Appends an arbitrary byte array with the given offset and length.

      • append

        public PDFOutput append​(java.lang.String aString)
        Adds a string to the pdf buffer.

      • append

        public PDFOutput append​(int anInt)
        Adds an int to the pdf buffer.

      • append

        public PDFOutput append​(double aDouble)
        Adds a double and newline to the pdf buffer.

      • append

        public PDFOutput append​(RMRect aRect)
        Writes a rect to the pdf buffer.

      • append

        public PDFOutput append​(byte[] theBytes)
        Appends an arbitrary byte array.

      • appendln

        public PDFOutput appendln()
        Adds a newline to the pdf buffer.

      • appendln

        public PDFOutput appendln​(java.lang.String aString)
        Adds a string and newline to the pdf buffer.

      • appendDigits

        public PDFOutput appendDigits​(int anInt,
                              int aPad)
        Appends digits of a whole number (recursively), padded by zeros on the left to the given number of pad digits.

      • printPDFString

        public void printPDFString​(java.lang.String aString)
        Adds a string object ( a string enclosed in parentheses ) to the buffer. All chars above the seven bit range are represented by an octal version of the form '\ddd'. The characters '(', ')' and '\' are escaped with backslash.

      • transform

        public void transform​(RMTransform aTransform)
        Writes a transform to pdf buffer.

      • transform

        public void transform​(double a,
                      double b,
                      double c,
                      double d,
                      double tx,
                      double ty)
        Writes a transform to pdf buffer.

      • writePath

        public void writePath​(java.awt.Shape aShape)
        Writes a given path to PDF file.

      • moveTo

        public void moveTo​(float x,
                   float y)
        Writes a moveto operator.

      • lineTo

        public void lineTo​(float x,
                   float y)
        Writes a lineto operator.

      • quadTo

        public void quadTo​(float lastX,
                   float lastY,
                   float x1,
                   float y1,
                   float x2,
                   float y2)
        Writes a quadto operator.

      • curveTo

        public void curveTo​(float x1,
                    float y1,
                    float x2,
                    float y2,
                    float x3,
                    float y3)
        Writes a curveto operator.