Package org.knowm.xchart

Class PdfboxGraphicsEncoder

  • public class PdfboxGraphicsEncoder
extends java.lang.Object
    A helper class with static methods for saving Charts as a PDF file

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String PDF_FILE_EXTENSION  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private PdfboxGraphicsEncoder()
      Constructor - Private constructor to prevent instantiation

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.lang.String addFileExtension​(java.lang.String fileName)
      Only adds the extension of the ".pdf" to the filename if the filename doesn't already have it.
      static void savePdfboxGraphics​(java.util.List<? extends Chart> charts, java.io.File file)
      Write multiple charts to a file
      static void savePdfboxGraphics​(java.util.List<? extends Chart> charts, java.io.OutputStream os)
      Write multiple charts to an OutputStream
      static void savePdfboxGraphics​(java.util.List<? extends Chart> charts, java.lang.String fileName)
      Write multiple charts to a file
      static void savePdfboxGraphics​(Chart chart, java.io.File file)
      Write a chart to a file
      static void savePdfboxGraphics​(Chart chart, java.io.OutputStream os)
      Write a chart to an OutputStream
      static void savePdfboxGraphics​(Chart chart, java.lang.String fileName)
      Write a chart to a file

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • PDF_FILE_EXTENSION

        private static final java.lang.String PDF_FILE_EXTENSION
        See Also:
        Constant Field Values

    • Constructor Detail

      • PdfboxGraphicsEncoder

        private PdfboxGraphicsEncoder()
        Constructor - Private constructor to prevent instantiation

    • Method Detail

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(Chart chart,
                                      java.lang.String fileName)
                               throws java.io.IOException
        Write a chart to a file
        Parameters:
        chart - Chart
        fileName - file name path
        Throws:
        java.io.IOException

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(Chart chart,
                                      java.io.File file)
                               throws java.io.IOException
        Write a chart to a file
        Parameters:
        chart - Chart
        file - File
        Throws:
        java.io.IOException

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(Chart chart,
                                      java.io.OutputStream os)
                               throws java.io.IOException
        Write a chart to an OutputStream
        Parameters:
        chart - Chart
        os - OutputStream
        Throws:
        java.io.IOException

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(java.util.List<? extends Chart> charts,
                                      java.lang.String fileName)
                               throws java.io.IOException
        Write multiple charts to a file
        Parameters:
        charts - List<? extends Chart>
        fileName - file name path
        Throws:
        java.io.IOException

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(java.util.List<? extends Chart> charts,
                                      java.io.File file)
                               throws java.io.IOException
        Write multiple charts to a file
        Parameters:
        charts - List<? extends Chart>
        file - File
        Throws:
        java.io.IOException

      • savePdfboxGraphics

        public static void savePdfboxGraphics​(java.util.List<? extends Chart> charts,
                                      java.io.OutputStream os)
                               throws java.io.IOException
        Write multiple charts to an OutputStream
        Parameters:
        charts - List<? extends Chart>
        os - OutputStream
        Throws:
        java.io.IOException

      • addFileExtension

        private static java.lang.String addFileExtension​(java.lang.String fileName)
        Only adds the extension of the ".pdf" to the filename if the filename doesn't already have it.
        Parameters:
        fileName -
        Returns:
        filename (if extension already exists), otherwise;: filename + ".pdf"