Packages

class PdfDocument extends AnyRef

A PDF document.

This class is intended to be created via PdfDocument.load(...), and its asynchronous methods use the ExecutionContext passed to PdfDocument.load(...).

You must call PdfDocument.close when finished.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PdfDocument
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PdfDocument(path: Path, pdDocument: PDDocument)(implicit ec: ExecutionContext)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def close: Unit

    Releases resources associated with this document.

    Releases resources associated with this document.

    You must call this method when you're done with the object.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val nPages: Int

    The number of pages in the document.

    The number of pages in the document.

    This method will not block or throw an exception.

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def pages: Iterator[Future[PdfPage]]

    Iterates over the pages of the document.

    Iterates over the pages of the document.

    Each returned element has yet to be parsed; that's why iterator.next returns a Future. Here's an example usage:

    val it = pdfDocument.pages def step(result: Seq[String])(implicit ec: ExecutionContext): Future[Seq[String]] = { if (it.hasNext) { it.next // May be a Future.failed[PdfInvalidException] .flatMap { page => step(result :+ page.toText) // May throw PdfInvalidException } } else { Future.successful(result) } } val pageTexts: Seq[String] = step(Seq()) .recover { case ex: PdfInvalidException => ... }

  18. val path: Path
  19. val pdDocument: PDDocument
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. def write(path: Path): Future[Unit]

    Writes the document to a file.

    Writes the document to a file.

    The intended usage is:

    1. Load a PdfDocument. 2. Mutate its pages. 3. Write it to a new location (this method).

Inherited from AnyRef

Inherited from Any

Ungrouped