pdftron.PDF

Interface PDFViewCtrl.Tool

All Known Implementing Classes:

FreeTextCreate

Enclosing class:

PDFViewCtrl

public static interface PDFViewCtrl.Tool

Tool interface. A tool provides the support for the interaction between a user and PDFViewCtrl. For more details, please refer to PDFViewCtrl.ToolManager.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMode() Returns the mode/identifier of this tool.
int	getNextToolMode() Returns the mode of the next tool.
void	onClose() Called by PDFViewCtrl to indicate the tool is being closed, e.g., when the current document is being closed.
void	onCustom(java.lang.Object o) Called by PDFViewCtrl in the next message loop of the main thread.
void	onDocumentDownloadEvent(int type, int page_num, int page_downloaded, int page_count) Called when an update from document downloading is available, which can be started by PDFViewCtrl#openURL(String, String).
boolean	onDoubleTap(MotionEvent e) Called at the beginning when PDFViewCtrl.onDoubleTap() is triggered.
void	onDoubleTapEnd(MotionEvent e) Called at the end when PDFViewCtrl.onDoubleTap() is triggered.
boolean	onDown(MotionEvent e) Called when PDFViewCtrl.onDown() is triggered.
void	onDraw(Canvas canvas, android.graphics.Matrix tfm) Called by PDFViewCtrl to draw tool's content, if there is any.
boolean	onFlingStop() Called when a fling motion stops by itself (not by a touching event).
void	onLayout(boolean changed, int l, int t, int r, int b) Called when PDFViewCtrl's onLayout(), e.g., android.view.View.onLayout(), is triggered, or PDFViewCtrl's page presentation mode or page view mode is changed by PDFViewCtrl.setPagePresentationMode(int) or PDFViewCtrl.setPageViewMode(int).
boolean	onLongPress(MotionEvent e) Called when PDFViewCtrl.onLongPress() is triggered.
boolean	onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) Called when PDFViewCtrl.onScroll() is triggered.
void	onPageTurning(int old_page, int cur_page) Called when turning pages in non-continuous page presentation mode.
void	onPostSingleTapConfirmed() Called about 200ms after PDFViewCtrl.onSingleTapConfirmed() is called.
boolean	onScale(float x, float y) Called when PDFViewCtrl.onScale() is triggered.
boolean	onScaleBegin(float x, float y) Called when PDFViewCtrl.onScaleBegin() is triggered.
boolean	onScaleEnd(float x, float y) Called when PDFViewCtrl.onScaleEnd() is triggered.
void	onSetDoc() Called by PDFViewCtrl after {link PDFViewCtrl.setDoc(PDFDoc) is called and the document is set within PDFViewCtrl.
boolean	onShowPress(MotionEvent e) Called when onShowPress() is triggered.
boolean	onSingleTapConfirmed(MotionEvent e) Called when PDFViewCtrl.onSingleTapConfirmed() is triggered.
boolean	onSingleTapUp(MotionEvent e) Called when onSingleTapUp() is triggered.
boolean	onUp(MotionEvent e, int prior_event_type) Called when PDFViewCtrl.onUp() is triggered.

Method Detail

getMode

int getMode()

Returns the mode/identifier of this tool.

getNextToolMode

int getNextToolMode()

Returns the mode of the next tool. Via this, a tool can indicate the next tool to switch to.

onClose

void onClose()

Called by PDFViewCtrl to indicate the tool is being closed, e.g., when the current document is being closed. Tool should clean up at this moment, e.g., closing its menu.

onCustom

void onCustom(java.lang.Object o)

Called by PDFViewCtrl in the next message loop of the main thread. This callback can be registered through PDFViewCtrl.postToolOnCustomEvent(Object) method. Note that this function is called only once per posting.

Parameters:

o - The Object passed in when calling PDFViewCtrl.postToolOnCustomEvent(Object).

onDoubleTap

boolean onDoubleTap(MotionEvent e)

Called at the beginning when PDFViewCtrl.onDoubleTap() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

Note:

By default, PDFViewCtrl changes the zoom when double tapping. But since Tool.onDoubleTap() is called before the zoom is changed, calling PDFViewCtrl.getZoom() in this callback would return the old zoom factor.

onDoubleTapEnd

void onDoubleTapEnd(MotionEvent e)

Called at the end when PDFViewCtrl.onDoubleTap() is triggered.

Note:

By default, PDFViewCtrl changes the zoom when double tapping. Since Tool.onDoubleTapEnd() is called after the zoom is changed, calling PDFViewCtrl.getZoom() in this callback would return the new zoom factor.

onDown

boolean onDown(MotionEvent e)

Called when PDFViewCtrl.onDown() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onDocumentDownloadEvent

void onDocumentDownloadEvent(int type,
                           int page_num,
                           int page_downloaded,
                           int page_count)

Called when an update from document downloading is available, which can be started by PDFViewCtrl#openURL(String, String).

Parameters:

type - the type of the update. Possible values are:

• PDFViewCtrl.DOWNLOAD_START
• PDFViewCtrl.DOWNLOAD_PAGE
• PDFViewCtrl.DOWNLOAD_FINISH
• PDFViewCtrl.DOWNLOAD_FAIL

page_num - the number of the page that is just downloaded. Meaningful if type is PDFViewCtrl.DOWNLOAD_PAGE.

page_downloaded - the total number of pages that have been downloaded.

page_count - the page count of the associated document.

onDraw

void onDraw(Canvas canvas,
          android.graphics.Matrix tfm)

Called by PDFViewCtrl to draw tool's content, if there is any. Note that this is called after all the document content is drawn; therefore the content drawn in this function will be on top of the document content.

Parameters:

canvas - The android.graphics.Canvas object to draw on PDFViewCtrl.

tfm - The extra transformation matrix applied to 'canvas'. This matrix is normally an identity matrix unless when the built-in page sliding is in process. The inverse of this matrix can be temporarily applied to 'canvas' in order to make the content drawn in this function appear stationary during sliding.

onFlingStop

boolean onFlingStop()

Called when a fling motion stops by itself (not by a touching event).

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onLayout

void onLayout(boolean changed,
            int l,
            int t,
            int r,
            int b)

Called when PDFViewCtrl's onLayout(), e.g., android.view.View.onLayout(), is triggered, or PDFViewCtrl's page presentation mode or page view mode is changed by PDFViewCtrl.setPagePresentationMode(int) or PDFViewCtrl.setPageViewMode(int).

Parameters:

changed - This is a new size or position for this view.

l - Left position, relative to parent

t - Top position, relative to parent

r - Right position, relative to parent

b - Bottom position, relative to parent

onLongPress

boolean onLongPress(MotionEvent e)

Called when PDFViewCtrl.onLongPress() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onMove

boolean onMove(MotionEvent e1,
             MotionEvent e2,
             float x_dist,
             float y_dist)

Called when PDFViewCtrl.onScroll() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, true should be returned so that while the tool is moving, the content will not be scrolled.

onPageTurning

void onPageTurning(int old_page,
                 int cur_page)

Called when turning pages in non-continuous page presentation mode.

onScale

boolean onScale(float x,
              float y)

Called when PDFViewCtrl.onScale() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onScaleBegin

boolean onScaleBegin(float x,
                   float y)

Called when PDFViewCtrl.onScaleBegin() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onScaleEnd

boolean onScaleEnd(float x,
                 float y)

Called when PDFViewCtrl.onScaleEnd() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onSetDoc

void onSetDoc()

Called by PDFViewCtrl after {link PDFViewCtrl.setDoc(PDFDoc) is called and the document is set within PDFViewCtrl.

onShowPress

boolean onShowPress(MotionEvent e)

Called when onShowPress() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onSingleTapConfirmed

boolean onSingleTapConfirmed(MotionEvent e)

Called when PDFViewCtrl.onSingleTapConfirmed() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onPostSingleTapConfirmed

void onPostSingleTapConfirmed()

Called about 200ms after PDFViewCtrl.onSingleTapConfirmed() is called.

Note:

If a new event is triggered by a user after onSingleTapConfirmed() is called but before onPostSingleTapConfirmed() is called, PDFViewCtrl ensures onPostSingleTapConfirmed() is called immediately before the new event. In other words, the 200ms delay is ignored.

onSingleTapUp

boolean onSingleTapUp(MotionEvent e)

Called when onSingleTapUp() is triggered.

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.

onUp

boolean onUp(MotionEvent e,
           int prior_event_type)

Called when PDFViewCtrl.onUp() is triggered.

Parameters:

e - the up motion event.

prior_event_type - indicates the prior event type. Possible values are:

• PDFViewCtrl.PRIOR_EVENT_SCROLLING
• PDFViewCtrl.PRIOR_EVENT_PINCH
• PDFViewCtrl.PRIOR_EVENT_FLING
• PDFViewCtrl.PRIOR_EVENT_DBLTAP
• PDFViewCtrl.PRIOR_EVENT_OTHER

Returns:

true if the event is swallowed by the tool. This way, PDFViewCtrl will not perform its usual task associated with this event. In general, false should be returned.