Package 

Interface ScrollHandle

  • 
public interface ScrollHandle

    An interface representing a scroll handle in a PDF previewer.

    • Method Summary

      Modifier and Type Method Description
      abstract Unit setScroll(Float position) Used to move the handle, called internally by PDFView.
      abstract Unit setupLayout(PDFView pdfView) Method called by PDFView after setting the scroll handle.
      abstract Unit destroyLayout() Method called by PDFView when the handle should be removed from layout.
      abstract Unit setPageNum(Integer pageNum) Set the page number displayed on the handle.
      abstract Unit show() Show the handle.
      abstract Unit hide() Hide the handle immediately.
      abstract Unit hideDelayed() Hide the handle after some time (defined by the implementation).
      abstract Boolean getShown() Get handle visibility.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setScroll

         abstract Unit setScroll(Float position)

        Used to move the handle, called internally by PDFView.

        Parameters:
        position - Current scroll ratio between 0 and 1.

      • setupLayout

         abstract Unit setupLayout(PDFView pdfView)

        Method called by PDFView after setting the scroll handle. Do not call this method manually. For usage sample see DefaultScrollHandle.

        Parameters:
        pdfView - The PDFView instance.

      • destroyLayout

         abstract Unit destroyLayout()

        Method called by PDFView when the handle should be removed from layout. Do not call this method manually.

      • setPageNum

         abstract Unit setPageNum(Integer pageNum)

        Set the page number displayed on the handle.

        Parameters:
        pageNum - The page number.

      • show

         abstract Unit show()

        Show the handle.

      • hide

         abstract Unit hide()

        Hide the handle immediately.

      • hideDelayed

         abstract Unit hideDelayed()

        Hide the handle after some time (defined by the implementation).