org.faceless.pdf2.viewer2

## Interface PDFBackgroundTask

- All Known Implementing Classes:
    BackgroundSignatureVerifier, BackgroundTextExtractor, ThumbnailPanel.ThumbnailSidePanel

      public interface PDFBackgroundTask

  This interface should be implemented by any features in the Viewer that run in a background thread. These features need to be paused when an exclusive lock on the whole PDF is required, such as when the PDF is saved. An example of one of these objects is the SidePanel returned from `ThumbnailPanel`
  Since:
    2.11.7

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `isPaused()` Return true if the task has been paused with the `pause()` method
    `boolean` | `isRunning()` Returns true if the task is still running
    `void` | `pause()` Pause the task until the `unpause()` method is called.
    `void` | `unpause()` Unpause the task after a call to `pause()`

- - ### Method Detail

    - #### isPaused

          boolean isPaused()

      Return true if the task has been paused with the `pause()` method

    - #### pause

          void pause()
              throws InterruptedException

      Pause the task until the `unpause()` method is called. This method waits until the task has actually paused.
      Throws:
        `InterruptedException`

    - #### unpause

          void unpause()

      Unpause the task after a call to `pause()`

    - #### isRunning

          boolean isRunning()

      Returns true if the task is still running

Copyright © 2001-2015 Big Faceless Organization