Package com.github.barteksc.pdfviewer.scroll

Interface ScrollHandle

All Known Implementing Classes:
DefaultScrollHandle
public interface ScrollHandle

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroyLayout()
    Method called by PDFView when handle should be removed from layout Do not call this method manually.
    void
    hide()
    Hide handle immediately
    void
    hideDelayed()
    Hide handle after some time (defined by implementation)
    void
    setPageNum(int pageNum)
    Set page number displayed on handle
    void
    setScroll(float position)
    Used to move the handle, called internally by PDFView
    void
    setupLayout(PDFView pdfView)
    Method called by PDFView after setting scroll handle.
    void
    show()
    Show handle
    boolean
    shown()
    Get handle visibility

  • Method Details

    • setScroll

      void setScroll(float position)
      Used to move the handle, called internally by PDFView
      Parameters:
      position - current scroll ratio between 0 and 1

    • setupLayout

      void setupLayout(PDFView pdfView)
      Method called by PDFView after setting scroll handle. Do not call this method manually. For usage sample see DefaultScrollHandle
      Parameters:
      pdfView - PDFView instance

    • destroyLayout

      void destroyLayout()
      Method called by PDFView when handle should be removed from layout Do not call this method manually.

    • setPageNum

      void setPageNum(int pageNum)
      Set page number displayed on handle
      Parameters:
      pageNum - page number

    • shown

      boolean shown()
      Get handle visibility
      Returns:
      true if handle is visible, false otherwise

    • show

      void show()
      Show handle

    • hide

      void hide()
      Hide handle immediately

    • hideDelayed

      void hideDelayed()
      Hide handle after some time (defined by implementation)