com.qoppa.notes

Class QPDFNotesView

java.lang.Object

RelativeLayout

com.qoppa.viewer.QPDFViewerView

com.qoppa.notes.QPDFNotesView

All Implemented Interfaces:

com.qoppa.notes.priv.IQPDFNotes

public class QPDFNotesView
extends QPDFViewerView
implements com.qoppa.notes.priv.IQPDFNotes

An extension of FrameLayout which provides PDF viewing, annotating, and form filling 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. The toolbar also provides tools for annotating the document. All document interactions may also be performed programtically, by calling the methods provided by this class.

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

Author:

Qoppa Software

Nested Class Summary

Nested classes/interfaces inherited from class com.qoppa.viewer.QPDFViewerView

QPDFViewerView.VIEW_MODE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addNewPage() Adds a blank page to the end of the current document.
void	clearDrawingTool() Clears the current drawing tool.
void	copy(Annotation annot) Copies the annotation to the system clipboard in XFDF format.
ToolbarNotes	getToolbar() Returns the application toolbar
Dialog	initAnnotContextDialog(AnnotComponent comp) This is called to instantiate the annotation context dialog, which is displayed when an annotation is long pressed upon. The return for this method is null safe.
Dialog	initAnnotPropsDialog(AnnotComponent comp, boolean justAdded) Initializer which is called for creating all AnnotPropDialogs.
Dialog	initPageContextDialog(PDFPageView pageView, PointF location)
void	newDoc() Closes the the current document and creates and loads a blank document.
void	paste(PDFPageView pageView, PointF location) If the clipboard contains an annotation, pastes it onto the page at the given location.
void	save() Prompts the user to save the current document.
void	save(java.lang.String path) Saves the current document to the given path.
void	saveAs() Displays the save as file chooser
void	signAndSaveAs(SignatureField field, SigningInformation info) Prompts the user to pick a location for the new document, and then signs and saves to that location.
void	startDrawingTool(AnnotDrawingTool tool) Begin drawing with the given tool.

Methods inherited from class com.qoppa.viewer.QPDFViewerView

addDocumentChangeListener, addDocumentListener, addPageChangedListener, clearAnnotationSelection, documentModified, getActivity, getCurrentPageFormat, getCurrentPageNumber, getCurrentScale, getDocument, getFitToWidth, getMaximumScale, getMininumScale, getPageView, getPageView, getPageViewOverlay, getScrollView, getSearchToolbar, getSelectedAnnotation, getShowNoteHook, getTileFactory, getToolbarLocation, getViewMode, goToPage, handleAction, handleActions, initAnnotComponent, initScrollViewWrapper, inputPage, inputZoom, isNightMode, isSearchVisible, isTouchListenerActive, isZooming, loadDocument, loadDocument, loadDocument, nextPage, onConfigurationChanged, onLeftToRightSwipe, onRightToLeftSwipe, open, prevPage, redrawCachedAnnots, redrawContent, redrawContent, refreshTiles, releaseDocument, scrollPdfRectVisible, selectAnnotation, setActivity, setCurrentPageFormat, setDocument, setMaximumScale, setMinimumScale, setNightMode, setOnGestureListener, setPageViewOverlay, setScale, setShowNoteHook, setShowProgressDialog, setToolbarLocation, setTouchListenerActive, showHideSearch, showHideToolbar, zoomIn, zoomOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.qoppa.notes.priv.IQPDFNotes

getActivity, getContext, getDocument

Constructor Detail

QPDFNotesView

public QPDFNotesView(Context context)

QPDFNotesView

public QPDFNotesView(Context context,
                     AttributeSet set)

QPDFNotesView

public QPDFNotesView(Context context,
                     QPDFViewerView.VIEW_MODE viewMode)

If viewMode is null, QPDFViewerView.VIEW_MODE.VERTICAL_CONTINUOUS will be used.

Method Detail

save

public void save()

Prompts the user to save the current document. The user will be presented with a dialog which will prompt them to either overwrite the current document, or to choose a location to save the document to.

Specified by:

save in interface com.qoppa.notes.priv.IQPDFNotes

saveAs

public void saveAs()

Displays the save as file chooser

Specified by:

saveAs in interface com.qoppa.notes.priv.IQPDFNotes

save

public void save(java.lang.String path)

Saves the current document to the given path.

Specified by:

save in interface com.qoppa.notes.priv.IQPDFNotes

Parameters:

path - The path to save the document to. If path is null or path is the path for the currently open document, an overwrite will be performed

newDoc

public void newDoc()

Closes the the current document and creates and loads a blank document.

Specified by:

newDoc in interface com.qoppa.notes.priv.IQPDFNotes

getToolbar

public ToolbarNotes getToolbar()

Returns the application toolbar

Overrides:

getToolbar in class QPDFViewerView

Returns:

a ToolbarNotes

initAnnotContextDialog

public Dialog initAnnotContextDialog(AnnotComponent comp)

This is called to instantiate the annotation context dialog, which is displayed when an annotation is long pressed upon.

The return for this method is null safe. If this method returns null, no Dialog will be displayed. This can be overridden to customize the dialog like:

  public AnnotContextMenuDialog initAnnotContextDialog() {
        AnnotContextDialog dialog = super.initAnnotContextDialog();
        dialog.getTvShowComment().setText("custom text");
        return dialog;
  }
  

Specified by:

initAnnotContextDialog in interface com.qoppa.notes.priv.IQPDFNotes

Returns:

a context menu dialog

initPageContextDialog

public Dialog initPageContextDialog(PDFPageView pageView,
                                    PointF location)

Specified by:

initPageContextDialog in interface com.qoppa.notes.priv.IQPDFNotes

clearDrawingTool

public void clearDrawingTool()

Clears the current drawing tool. If a drawing tool is currently active, this cancels it.

Specified by:

clearDrawingTool in interface com.qoppa.notes.priv.IQPDFNotes

startDrawingTool

public void startDrawingTool(AnnotDrawingTool tool)

Begin drawing with the given tool.

Specified by:

startDrawingTool in interface com.qoppa.notes.priv.IQPDFNotes

Parameters:

tool - An AnnotDrawingTool

initAnnotPropsDialog

public Dialog initAnnotPropsDialog(AnnotComponent comp,
                                   boolean justAdded)

Initializer which is called for creating all AnnotPropDialogs. This method may be overriden to return a customized Dialog.

Specified by:

initAnnotPropsDialog in interface com.qoppa.notes.priv.IQPDFNotes

addNewPage

public void addNewPage()

Adds a blank page to the end of the current document. The pages dimensions match those of the page that preceeds it.

Specified by:

addNewPage in interface com.qoppa.notes.priv.IQPDFNotes

signAndSaveAs

public void signAndSaveAs(SignatureField field,
                          SigningInformation info)

Prompts the user to pick a location for the new document, and then signs and saves to that location.

Specified by:

signAndSaveAs in interface com.qoppa.notes.priv.IQPDFNotes

copy

public void copy(Annotation annot)

Copies the annotation to the system clipboard in XFDF format.

Parameters:

annot -

paste

public void paste(PDFPageView pageView,
                  PointF location)

If the clipboard contains an annotation, pastes it onto the page at the given location.

Parameters:

pageView - Page to paste the annotation onto.

location - Location on the page to paste the annotation.