Package 

Object Document

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public enum Document.PDFPageFormat

      Available PDF page formats when generating PDF documents.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final static Document INSTANCE

    • Method Summary

      Modifier and Type Method Description
      final static File writePDF(File file, Boolean overwrite, Document.PDFPageFormat pageFormat) This method generates a PDF document from the loaded or scanned pages.
      final static File writePDF(File file, Boolean overwrite) This method generates a PDF document from the loaded or scanned pages.
      final static File writePDF(File file) This method generates a PDF document from the loaded or scanned pages.
      final Boolean loadFile(String path, String password) This method loads a file from the given path.
      final Boolean loadFile(String path) This method loads a file from the given path.
      final Boolean loadFile(ByteArray bytes, String fileExtension, String password) This method loads a file from the given ByteArray.
      final Boolean loadFile(ByteArray bytes, String fileExtension) This method loads a file from the given ByteArray.
      final Boolean loadFile(Uri uri, String password) This method loads a file from the given Uri.
      final Boolean loadFile(Uri uri) This method loads a file from the given Uri.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • writePDF

        @JvmOverloads() final static File writePDF(File file, Boolean overwrite, Document.PDFPageFormat pageFormat)

        This method generates a PDF document from the loaded or scanned pages.

        Parameters:
        file - the File where to save the PDF document.
        overwrite - if file already exist, indicate whether to override it or to append number, e.g.
        pageFormat - the PDF page format, refer to PDFPageFormat.

      • writePDF

        @JvmOverloads() final static File writePDF(File file, Boolean overwrite)

        This method generates a PDF document from the loaded or scanned pages.

        Parameters:
        file - the File where to save the PDF document.
        overwrite - if file already exist, indicate whether to override it or to append number, e.g.

      • writePDF

        @JvmOverloads() final static File writePDF(File file)

        This method generates a PDF document from the loaded or scanned pages.

        Parameters:
        file - the File where to save the PDF document.

      • loadFile

        @JvmOverloads() final Boolean loadFile(String path, String password)

        This method loads a file from the given path.

        Only paths in internal app directory and it's subdirectories are supported.

        Parameters:
        path - the path pointing to the file to be loaded.
        password - the password if file is encrypted.

      • loadFile

        @JvmOverloads() final Boolean loadFile(String path)

        This method loads a file from the given path.

        Only paths in internal app directory and it's subdirectories are supported.

        Parameters:
        path - the path pointing to the file to be loaded.

      • loadFile

        @JvmOverloads() final Boolean loadFile(ByteArray bytes, String fileExtension, String password)

        This method loads a file from the given ByteArray.

        Parameters:
        bytes - the ByteArray of the file to be loaded.
        fileExtension - the extension of the file to be loaded, e.g.
        password - the password if file is encrypted.

      • loadFile

        @JvmOverloads() final Boolean loadFile(ByteArray bytes, String fileExtension)

        This method loads a file from the given ByteArray.

        Parameters:
        bytes - the ByteArray of the file to be loaded.
        fileExtension - the extension of the file to be loaded, e.g.

      • loadFile

        @JvmOverloads() final Boolean loadFile(Uri uri, String password)

        This method loads a file from the given Uri.

        Parameters:
        uri - the content Uri pointing to the file to be loaded.
        password - the password if file is encrypted.

      • loadFile

        @JvmOverloads() final Boolean loadFile(Uri uri)

        This method loads a file from the given Uri.

        Parameters:
        uri - the content Uri pointing to the file to be loaded.