QPDFViewerView

java.lang.Object
- RelativeLayout
- - com.qoppa.viewer.QPDFViewerView

Direct Known Subclasses:

QPDFNotesView
```
public class QPDFViewerView
extends RelativeLayout
```
An extension of FrameLayout which provides PDF viewing capabilities.

The Viewer includes a TouchListener to handle scrolling and zooming of the document. A toolbar provides additional document navigation fucntions along with text search and ability opening a new document. All document interactions may also be performed programtically, by calling the methods provided by this class.

Please note it is essential to call setActivity(Activity)() after this class is constructed.

Author:

Qoppa Software

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QPDFViewerView.VIEW_MODE

Nested Classes
Modifier and Type	Class and Description
`static class`	`QPDFViewerView.VIEW_MODE`

Constructor Summary

Constructors
Constructor and Description
`QPDFViewerView(Context context)`
`QPDFViewerView(Context context, AttributeSet set)`
`QPDFViewerView(Context context, QPDFViewerView.VIEW_MODE viewMode)` If viewMode is null, `QPDFViewerView.VIEW_MODE.VERTICAL_CONTINUOUS` will be used.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDocumentChangeListener(DocumentChangeListener listener)` Register a listener to receive notifications of changes to the document.
`void`	`addDocumentListener(DocumentListener listener)` Register a listener to receive document events.
`void`	`addPageChangedListener(PageChangedListener listener)` Register a listener to receive page change events.
`boolean`	`clearAnnotationSelection()` De-selects any currently selected Annotations.
`void`	`documentModified()` Deprecated. `redrawContent()`
`Activity`	`getActivity()` Returns the owner Activity
`java.lang.String`	`getCurrentPageFormat(java.lang.String format)` Returns the currentPageFormat set in `setCurrentPageFormat(String)`.
`int`	`getCurrentPageNumber()` Getter for the current page number, 1 based.
`float`	`getCurrentScale()` Getter for the viewer's current scale
`PDFDocument`	`getDocument()` Getter for the currently loaded document.
`float`	`getFitToWidth()` Getter for the fit to width scale, the maximum scale at which the document's width will fit within the device's scren.
`float`	`getMaximumScale()` Returns the maximum scale at which the document can be displayed.
`float`	`getMininumScale()` Returns the minimum scale at which the document can be displayed.
`PDFPageView`	`getPageView(int pageIndex)` Returns a view representing the PDFPage for the given pageIndex.
`PDFPageView`	`getPageView(PDFPage page)` Returns a view representing the PDFPage for the given page.
`PageViewOverlay`	`getPageViewOverlay()` Returns the currently set PageViewOverlay.
`FrameLayout`	`getScrollView()` Getter for the application's scroll view
`LinearLayout`	`getSearchToolbar()` Getter for the application search toolbar
`java.util.Vector<AnnotComponent>`	`getSelectedAnnotation()` Returns a Vector of currently selected annotations.
`ShowNoteHook`	`getShowNoteHook()` Returns the current ShowNoteHook.
`com.qoppa.viewer.utils.TileFactory`	`getTileFactory()` Internal method, do not use.
`Toolbar`	`getToolbar()` Getter for the application toolbar
`Location`	`getToolbarLocation()` Returns the current location of the toolbar.
`QPDFViewerView.VIEW_MODE`	`getViewMode()` Returns the current view mode.
`void`	`goToPage(int page)` Navigates to the specified page number in the document.
`void`	`handleAction(Action action)` Performs the specified action.
`void`	`handleActions(java.util.List<Action> actions)` Performs the list of actions.
`AnnotComponent`	`initAnnotComponent(Annotation annot, View parent)` Initializer which is called when an Annotation is selected.
`ScrollViewWrapper`	`initScrollViewWrapper()` This is called when creating the ScrollViewWrapper for the library.
`void`	`inputPage()` Allows the user to jump to a specific page in the document.
`void`	`inputZoom()` Allows the user to input a specific zoom.
`boolean`	`isNightMode()` Returns true if Night Mode is on.
`boolean`	`isSearchVisible()` Method to test if the text search bar is visible.
`boolean`	`isTouchListenerActive()` Returns true if the touch listener is active.
`boolean`	`isZooming()` Returns true if the user is currently zooming in or out on the document.
`void`	`loadDocument(java.io.InputStream stream)` Opens the pdf document from an `InputStream`
`void`	`loadDocument(java.lang.String path)` Opens the pdf document at the given file location.
`void`	`loadDocument(java.lang.String path, int initialPage)` Opens the pdf document at the given file location and opens to the given page
`void`	`nextPage()` Navigates to the next page in the document.
`void`	`onConfigurationChanged(Configuration newConfig)`
`void`	`onLeftToRightSwipe()`
`void`	`onRightToLeftSwipe()`
`void`	`open()` Launches a file browser, allowing users to select a document to open.
`void`	`prevPage()` Navigates to the previous page in the document.
`void`	`redrawCachedAnnots(PDFPageView view)` PDF content is cached so it can be redrawn quickly as the user scrolls.
`void`	`redrawContent()` Content for each PDFPage is cached.
`void`	`redrawContent(PDFPageView view)` Content for each PDFPage is cached.
`void`	`refreshTiles()`
`void`	`releaseDocument()` This will release all references to the current the document.
`void`	`scrollPdfRectVisible(RectF rect, int pageIndex)` Scrolls so that a rectangle defined in pdf space is visible.
`AnnotComponent`	`selectAnnotation(Annotation annotation, int pageIndex)` Selects the given `Annotation`.
`void`	`setActivity(Activity activity)` The library requires a reference to an `Activity`.
`void`	`setCurrentPageFormat(java.lang.String format)` By default, the current page is displayed in the toolbar as "i of t" where i is the current page, and t is the total number of pages.
`void`	`setDocument(PDFDocument document)` Releases the currently opened document and replaces it with the given document.
`void`	`setMaximumScale(float scale)` Sets the maximum scale at which the document can be displayed.
`void`	`setMinimumScale(float scale)` Sets the minimum scale at which the document can be displayed.
`void`	`setNightMode(boolean nightOn)` Invert a documents colors by setting Night Mode on.
`void`	`setOnGestureListener(OnGestureListenerExt gestureListener)` QPDFViewerView handles gestures to provide a variety of functionality (zooming, scrolling, paning, etc..).
`void`	`setPageViewOverlay(PageViewOverlay overlay)` The PageViewOverlay can be used to additional content on top of PDFPageViews.
`void`	`setScale(float scale)` Set the viewer scale.
`void`	`setShowNoteHook(ShowNoteHook showNoteHook)` By default, when selected Annotations are double tapped their Note/Comment is displayed as a toast.
`void`	`setShowProgressDialog(boolean showProgressDialog)`
`void`	`setToolbarLocation(Location location)` Setter for the toolbar location.
`void`	`setTouchListenerActive(boolean active)` When set to false, all touch events (zooming, scrolling, etc...) will be ignored.
`void`	`showHideSearch()` Shows or hides the text search bar.
`void`	`showHideToolbar()` Shows or hides the button toolbar.
`void`	`zoomIn(PointF center)` Zoom in on the given point.
`void`	`zoomOut(PointF center)` Zoom out on the given point.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QPDFViewerView
```
public QPDFViewerView(Context context)
```
  - QPDFViewerView
```
public QPDFViewerView(Context context,
                      AttributeSet set)
```
  - QPDFViewerView
```
public QPDFViewerView(Context context,
                      QPDFViewerView.VIEW_MODE viewMode)
```
    If viewMode is null, QPDFViewerView.VIEW_MODE.VERTICAL_CONTINUOUS will be used.
- Method Detail
  - setActivity
```
public void setActivity(Activity activity)
```
    The library requires a reference to an Activity. This setter must be called prior to interacting with QPDFViewerView.
    
    Parameters:
    
    activity - An owner activity
  - getActivity
```
public Activity getActivity()
```
    Returns the owner Activity
    
    Returns:
    
    the Activity
  - onConfigurationChanged
```
public void onConfigurationChanged(Configuration newConfig)
```
  - open
```
public void open()
```
    Launches a file browser, allowing users to select a document to open.
  - showHideSearch
```
public void showHideSearch()
```
    Shows or hides the text search bar. If text search is visible, calling this method will set it invisible. If text search is invisible, calling this method will expose it.
  - isSearchVisible
```
public boolean isSearchVisible()
```
    Method to test if the text search bar is visible.
    
    Returns:
    
    true if search bar is visible, false otherwise
  - showHideToolbar
```
public void showHideToolbar()
```
    Shows or hides the button toolbar. If the button toolbar is visible, calling this method will set it invisible. If the button toolbar is invisible, calling this method will expose it.
  - zoomIn
```
public void zoomIn(PointF center)
```
    Zoom in on the given point. This will set the zoom scale to 1.5 times the current scale, and center the view around the given point. The parameter may be null.
    
    Parameters:
    
    center - A PointF to center around
  - zoomOut
```
public void zoomOut(PointF center)
```
    Zoom out on the given point. This will set the zoom scale to .75 times the current scale, and center the view around the given point. The parameter may be null.
    
    Parameters:
    
    center - A PointF to center around
  - setScale
```
public void setScale(float scale)
```
    Set the viewer scale.
    
    Parameters:
    
    scale - The scale to set the viewer to
  - inputPage
```
public void inputPage()
```
    Allows the user to jump to a specific page in the document. When called, a dialog is presented which can be used to specify the page to jump to.
  - inputZoom
```
public void inputZoom()
```
    Allows the user to input a specific zoom. When called, a dialog is presented for zoom entry.
  - prevPage
```
public void prevPage()
```
    Navigates to the previous page in the document.
  - nextPage
```
public void nextPage()
```
    Navigates to the next page in the document.
  - goToPage
```
public void goToPage(int page)
```
    Navigates to the specified page number in the document.
  - loadDocument
```
public void loadDocument(java.lang.String path)
```
    Opens the pdf document at the given file location.
    
    Parameters:
    
    path - The path to the pdf file
  - loadDocument
```
public void loadDocument(java.lang.String path,
                         int initialPage)
```
    Opens the pdf document at the given file location and opens to the given page
    
    Parameters:
    
    path - The path to the pdf file
    
    initialPage - The 0 based page index of the page to display upon document load
  - releaseDocument
```
public void releaseDocument()
```
    This will release all references to the current the document. This can be used to free any significant memory being utilized by QPDFViewerView
  - loadDocument
```
public void loadDocument(java.io.InputStream stream)
```
    Opens the pdf document from an InputStream
    
    Parameters:
    
    stream - The pdf document stream
  - getToolbar
```
public Toolbar getToolbar()
```
    Getter for the application toolbar
    
    Returns:
    
    a Toolbar
  - getSearchToolbar
```
public LinearLayout getSearchToolbar()
```
    Getter for the application search toolbar
    
    Returns:
    
    a LinearLayout
  - getScrollView
```
public FrameLayout getScrollView()
```
    Getter for the application's scroll view
    
    Returns:
    
    an extension of FrameLayout
  - getCurrentScale
```
public float getCurrentScale()
```
    Getter for the viewer's current scale
    
    Returns:
    
    the current scale
  - getFitToWidth
```
public float getFitToWidth()
```
    Getter for the fit to width scale, the maximum scale at which the document's width will fit within the device's scren.
    
    Returns:
    
    the fit to width scale
  - getDocument
```
public PDFDocument getDocument()
```
    Getter for the currently loaded document. Returns null if no document has been loaded.
    
    Returns:
    
    a PDFDocument
  - getCurrentPageNumber
```
public int getCurrentPageNumber()
```
    Getter for the current page number, 1 based.
    
    Returns:
    
    current page number
  - redrawContent
```
public void redrawContent()
```
    Content for each PDFPage is cached. Call this method if changes are made to the underlying content to notify the library that all content must be re-cached.
  - redrawContent
```
public void redrawContent(PDFPageView view)
```
    Content for each PDFPage is cached. Call this method if changes are made to the underlying content to notify the library that content for the page of the given PDFPageView must be re-cached.
    
    Parameters:
    
    pageIndex - The 0 based index for the page to re-cache
  - redrawCachedAnnots
```
public void redrawCachedAnnots(PDFPageView view)
```
    PDF content is cached so it can be redrawn quickly as the user scrolls. In general annotations are drawn on top of the cached content, because they draw very quickly and not caching allows them to be responsive when the user modifies them. However, some annotations do not draw quickly enough to be drawn on top of the content so they need to be cached. Because of this, if one of these annotations is programmtically modified, it is necessary to notify the library so that it can be redrawn. Calling this method will redraw all cached annotations on the given page.
    
    The Annotations that are cached are: Link, RubberStamp, and Widget with the exception of WidgetSignature which are not cached.
    
    Parameters:
    
    view - The PDFPageView for the page whose annotations need to be redrawn
  - handleActions
```
public void handleActions(java.util.List<Action> actions)
```
    Performs the list of actions.
    
    Parameters:
    
    actions - A list of actions to handle
  - handleAction
```
public void handleAction(Action action)
```
    Performs the specified action.
    
    Parameters:
    
    action - An action to handle
  - selectAnnotation
```
public AnnotComponent selectAnnotation(Annotation annotation,
                                       int pageIndex)
```
    Selects the given Annotation. Also de-selects any currently selected annotations.
    
    Parameters:
    
    annotation - The Annotation to select
    
    pageIndex - Index of the Annotation's parent page, 0 based
  - scrollPdfRectVisible
```
public void scrollPdfRectVisible(RectF rect,
                                 int pageIndex)
```
    Scrolls so that a rectangle defined in pdf space is visible.
    
    Parameters:
    
    rect - The rectangle in pdf space
    
    pageIndex - The index of the page to scroll to
  - getSelectedAnnotation
```
public java.util.Vector<AnnotComponent> getSelectedAnnotation()
```
    Returns a Vector of currently selected annotations. Currently, only one annotation can be selected at time, so this Vector will contain exactly 1 AnnotComponent if an annotation is selected, or will be empty if no annotations are selected. In the future, it may contain multiple AnnotComponents.
  - clearAnnotationSelection
```
public boolean clearAnnotationSelection()
```
    De-selects any currently selected Annotations. Returns true if something was in fact cleared, false otherwise.
  - documentModified
```
@Deprecated
public void documentModified()
```
    Deprecated. redrawContent()
    
    The viewer caches the PDFDocument's pages contents. If a change is made to the Document's contents, method should be called to notify the viewer that the pages contents need to be updated. It is not necessary to call this method if changes are made by calling a method exposed by the viewer.
  - addDocumentListener
```
public void addDocumentListener(DocumentListener listener)
```
    Register a listener to receive document events.
    
    Parameters:
    
    listener -
  - addPageChangedListener
```
public void addPageChangedListener(PageChangedListener listener)
```
    Register a listener to receive page change events.
    
    Parameters:
    
    listener -
  - addDocumentChangeListener
```
public void addDocumentChangeListener(DocumentChangeListener listener)
```
    Register a listener to receive notifications of changes to the document.
    
    Parameters:
    
    listener -
  - initScrollViewWrapper
```
public ScrollViewWrapper initScrollViewWrapper()
```
    This is called when creating the ScrollViewWrapper for the library. It can be overriden to return a custom wrapper.
    
    Returns:
    
    a ScrollViewWrapper
  - setToolbarLocation
```
public void setToolbarLocation(Location location)
```
    Setter for the toolbar location.
    
    Parameters:
    
    a - Location
  - getToolbarLocation
```
public Location getToolbarLocation()
```
    Returns the current location of the toolbar.
    
    Returns:
    
    the Location
  - initAnnotComponent
```
public AnnotComponent initAnnotComponent(Annotation annot,
                                         View parent)
```
    Initializer which is called when an Annotation is selected. This method may be overriden to return a customized AnnotComponent.
  - setDocument
```
public void setDocument(PDFDocument document)
```
    Releases the currently opened document and replaces it with the given document.
    
    Parameters:
    
    document -
  - setShowProgressDialog
```
public void setShowProgressDialog(boolean showProgressDialog)
```
  - onRightToLeftSwipe
```
public void onRightToLeftSwipe()
```
  - onLeftToRightSwipe
```
public void onLeftToRightSwipe()
```
  - getTileFactory
```
public com.qoppa.viewer.utils.TileFactory getTileFactory()
```
    Internal method, do not use.
  - setTouchListenerActive
```
public void setTouchListenerActive(boolean active)
```
    When set to false, all touch events (zooming, scrolling, etc...) will be ignored. Defaults to true.
    
    Parameters:
    
    active -
  - isTouchListenerActive
```
public boolean isTouchListenerActive()
```
    Returns true if the touch listener is active.
    
    Returns:
  - getPageView
```
public PDFPageView getPageView(int pageIndex)
```
    Returns a view representing the PDFPage for the given pageIndex.
  - getPageView
```
public PDFPageView getPageView(PDFPage page)
```
    Returns a view representing the PDFPage for the given page.
  - setOnGestureListener
```
public void setOnGestureListener(OnGestureListenerExt gestureListener)
```
    QPDFViewerView handles gestures to provide a variety of functionality (zooming, scrolling, paning, etc..). However, it may be desirable for developers to be notified when gestures occur on the View. Call this method to set an OnGestureListener which QPDFViewerView will notify when gestures occur.
  - setPageViewOverlay
```
public void setPageViewOverlay(PageViewOverlay overlay)
```
    The PageViewOverlay can be used to additional content on top of PDFPageViews. If set using this method, the PageViewOverlay will receive a callback once the PDFPageView has finished drawing.
    
    Parameters:
    
    overlay - An instance of PageViewOverlay
  - getPageViewOverlay
```
public PageViewOverlay getPageViewOverlay()
```
    Returns the currently set PageViewOverlay.
    
    Returns:
    
    the current PageViewOverlay or null
  - setMinimumScale
```
public void setMinimumScale(float scale)
```
    Sets the minimum scale at which the document can be displayed. If the user attempts to zoom out past this scale, their zoom will be rejected; this creates a nice effect and avoids displaying documents at an illegible zoom.
    
    If this value is not set, minimum scale is calculated as 1/2 of getFitToWidth().
    
    Parameters:
    
    scale - The minimum scale, should be > 0.
  - setMaximumScale
```
public void setMaximumScale(float scale)
```
    Sets the maximum scale at which the document can be displayed. If the user attempts to zoom in past this scale, their zoom will be rejected; this creates a nice effect and avoids displaying documents being displayed at a pointlessly high zoom.
    
    If this value is not set, a default of 64 is used.
    
    Parameters:
    
    scale - The maximum scale, should be > 0.
  - getMaximumScale
```
public float getMaximumScale()
```
    Returns the maximum scale at which the document can be displayed. If the user attempts to zoom in past this scale, their zoom will be rejected.
    
    Returns:
    
    The maximum scale.
  - getMininumScale
```
public float getMininumScale()
```
    Returns the minimum scale at which the document can be displayed. If the user attempts to zoom out past this scale, their zoom will be rejected.
    
    Returns:
    
    The minimum scale.
  - setCurrentPageFormat
```
public void setCurrentPageFormat(java.lang.String format)
```
    By default, the current page is displayed in the toolbar as "i of t" where i is the current page, and t is the total number of pages. If desired, a format can be set using this method. The format should contain one or two "%d" entries, the first of which will be used for the current page and the second of which will be used for the total number of pages.
    
    For example, setting the format as: "Page %d of %d total pages" would result in something like: "Page 1 of 15 total pages". If no format is set, the default is used.
  - getCurrentPageFormat
```
public java.lang.String getCurrentPageFormat(java.lang.String format)
```
    Returns the currentPageFormat set in setCurrentPageFormat(String). If not format has been set, returns null.
  - getViewMode
```
public QPDFViewerView.VIEW_MODE getViewMode()
```
    Returns the current view mode.
    
    Returns:
    
    a QPDFViewerView.VIEW_MODE
  - isZooming
```
public boolean isZooming()
```
    Returns true if the user is currently zooming in or out on the document.
    
    Returns:
    
    isZooming
  - setShowNoteHook
```
public void setShowNoteHook(ShowNoteHook showNoteHook)
```
    By default, when selected Annotations are double tapped their Note/Comment is displayed as a toast. To override this behavior, use this method to set an implementation of the ShowNoteHook. If no ShowNoteHook is set, the default behavior will be used
  - getShowNoteHook
```
public ShowNoteHook getShowNoteHook()
```
    Returns the current ShowNoteHook. Will return null if no setShowNoteHook(ShowNoteHook) has not been called.
  - setNightMode
```
public void setNightMode(boolean nightOn)
```
    Invert a documents colors by setting Night Mode on. Night Mode is off by default. \br\br If a document is rendered, call refreshTiles() to re-render any cached renderings.
    
    Parameters:
    
    nightOn - True to invert colors, False by default.
  - isNightMode
```
public boolean isNightMode()
```
    Returns true if Night Mode is on.
    
    Returns:
    
    nightOn
  - refreshTiles
```
public void refreshTiles()
```

Class QPDFViewerView

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QPDFViewerView

QPDFViewerView

QPDFViewerView

Method Detail

setActivity

getActivity

onConfigurationChanged

open

showHideSearch

isSearchVisible

showHideToolbar

zoomIn

zoomOut

setScale

inputPage

inputZoom

prevPage

nextPage

goToPage

loadDocument

loadDocument

releaseDocument

loadDocument

getToolbar

getSearchToolbar

getScrollView

getCurrentScale

getFitToWidth

getDocument

getCurrentPageNumber

redrawContent

redrawContent

redrawCachedAnnots

handleActions

handleAction

selectAnnotation

scrollPdfRectVisible

getSelectedAnnotation

clearAnnotationSelection

documentModified

addDocumentListener

addPageChangedListener

addDocumentChangeListener

initScrollViewWrapper

setToolbarLocation

getToolbarLocation

initAnnotComponent

setDocument

setShowProgressDialog

onRightToLeftSwipe

onLeftToRightSwipe

getTileFactory

setTouchListenerActive

isTouchListenerActive

getPageView

getPageView

setOnGestureListener

setPageViewOverlay

getPageViewOverlay

setMinimumScale

setMaximumScale

getMaximumScale

getMininumScale

setCurrentPageFormat

getCurrentPageFormat

getViewMode

isZooming

setShowNoteHook

getShowNoteHook

setNightMode

isNightMode

refreshTiles