FreehandCreate

Class Overview

This class is for creating a free hand annotation.

If mMultiStrokeMode is true, then each subsequent stroke will be added to the same annot.

If mTimedModeEnabled is true, then the strokes will be committed to the annot on a timer basis. This flag is only under effect if mMultiStrokeMode is true.

If mIsFromEditToolbar is true, then mMultiStrokeMode must be false and mTimedModeEnabled must be false.

# Test cases:

## Stylus as Pen: ### Invariants mTimedModeEnabled can be true or false mMultiStrokeMode can be true or false mIsEditingAnnot must be false ### Tests 1. mTimedModeEnabled = true and mMultiStrokeMode = true. A new annot should not be created each stroke, and strokes should be saved every 3 seconds. 2. mMultiStrokeMode = false. A new annot will be created after every stroke.

## Ink tool from toolbar: ### Invariants mTimedModeEnabled can be true or false mMultiStrokeMode can be true or false mIsEditingAnnot must be false ### Tests 1. mTimedModeEnabled = true and mMultiStrokeMode = true. A new annot should not be created each stroke, and strokes should be saved every 30 seconds. 2. mMultiStrokeMode = false. A new annot will be created after every stroke.

## Ink tool from quick menu: ### Invariants mTimedModeEnabled can be true or false mMultiStrokeMode must be true mIsEditingAnnot must be false 1. mTimedModeEnabled = true and mMultiStrokeMode = true. A new annot should not be created each stroke, and strokes should be saved every 30 seconds.

## Draw with finger setting

### 1. Draw with finger setting enabled: i. Enable stylus as pen setting and **enable** draw with finger setting. ii. Open a document and select the ink tool. iii. When you draw with the finger first, ink should be created. However once you start drawing with the stylus, the finger should only pan.

### 2. Draw with finger setting disabled: i. Enable stylus as pen setting and **disable** draw with finger setting. ii. Open a document and select the ink tool. iii. When you draw with the finger, it should always pan and never draw.

### 3. Stylus as pen setting disabled: i. Disable stylus as pen setting. ii. Open a document and select the ink tool. iii. When you draw with the finger, ink should be created. However once you start drawing with the stylus, the finger should only pan. Same as expected behavior 1.

## Always Draw with Finger and Stylus Setting

When this setting is enabled, the tool will always draw with finger and stylus.

Summary

[Expand] Inherited Constants
From class com.pdftron.pdf.tools.SimpleShapeCreate int sTapToCreateHalfWidth
From class com.pdftron.pdf.tools.BaseTool int LOUPE_RADIUS int LOUPE_SIZE int LOUPE_TYPE_MEASURE int LOUPE_TYPE_TEXT
From class com.pdftron.pdf.tools.Tool String ANNOTATION_FREE_TEXT_FONTS String ANNOTATION_FREE_TEXT_JSON_FONT String ANNOTATION_FREE_TEXT_JSON_FONT_DISPLAY_IN_LIST String ANNOTATION_FREE_TEXT_JSON_FONT_DISPLAY_NAME String ANNOTATION_FREE_TEXT_JSON_FONT_FILE_PATH String ANNOTATION_FREE_TEXT_JSON_FONT_NAME String ANNOTATION_FREE_TEXT_JSON_FONT_PDFTRON_NAME int ANNOTATION_FREE_TEXT_PREFERENCE_DIALOG String ANNOTATION_FREE_TEXT_PREFERENCE_EDITING int ANNOTATION_FREE_TEXT_PREFERENCE_EDITING_DEFAULT int ANNOTATION_FREE_TEXT_PREFERENCE_INLINE String ANNOTATION_NOTE_ICON_FILE_POSTFIX_FILL String ANNOTATION_NOTE_ICON_FILE_POSTFIX_OUTLINE String ANNOTATION_NOTE_ICON_FILE_PREFIX String ANNOTATION_TOOLBAR_SIGNATURE_STATE int ANNOT_PERMISSION_FILL_AND_SIGN int ANNOT_PERMISSION_INTERACT int ANNOT_PERMISSION_MENU int ANNOT_PERMISSION_SELECTION String FLATTENED String FORM_FIELD_SYMBOL_CHECKBOX String FORM_FIELD_SYMBOL_CIRCLE String FORM_FIELD_SYMBOL_CROSS String FORM_FIELD_SYMBOL_DIAMOND String FORM_FIELD_SYMBOL_SQUARE String FORM_FIELD_SYMBOL_STAR String IS_LINK String KEYS String LAST_DEVICE_LOCALE_LANGUAGE String LINK_RECTF String LINK_URL String METHOD_FROM String PAGE_NUMBER String PDFTRON_ID String PDFTRON_THICKNESS String PREF_ANNOTATION_CREATION_ARROW String PREF_ANNOTATION_CREATION_CLOUD String PREF_ANNOTATION_CREATION_COLOR String PREF_ANNOTATION_CREATION_ERASER String PREF_ANNOTATION_CREATION_FILL_COLOR String PREF_ANNOTATION_CREATION_FONT String PREF_ANNOTATION_CREATION_FREEHAND String PREF_ANNOTATION_CREATION_FREETEXT String PREF_ANNOTATION_CREATION_FREE_HIGHLIGHTER String PREF_ANNOTATION_CREATION_HIGHLIGHT String PREF_ANNOTATION_CREATION_ICON String PREF_ANNOTATION_CREATION_LINE String PREF_ANNOTATION_CREATION_LINK String PREF_ANNOTATION_CREATION_NOTE String PREF_ANNOTATION_CREATION_OPACITY String PREF_ANNOTATION_CREATION_OVAL String PREF_ANNOTATION_CREATION_POLYGON String PREF_ANNOTATION_CREATION_POLYLINE String PREF_ANNOTATION_CREATION_RECTANGLE String PREF_ANNOTATION_CREATION_SIGNATURE String PREF_ANNOTATION_CREATION_SQUIGGLY String PREF_ANNOTATION_CREATION_STRIKEOUT String PREF_ANNOTATION_CREATION_TEXT_COLOR String PREF_ANNOTATION_CREATION_TEXT_SIZE String PREF_ANNOTATION_CREATION_THICKNESS String PREF_ANNOTATION_CREATION_UNDERLINE String PREF_TRANSLATION_SOURCE_LANGUAGE_CODE_DEFAULT String PREF_TRANSLATION_SOURCE_LANGUAGE_CODE_KEY String PREF_TRANSLATION_TARGET_LANGUAGE_CODE_DEFAULT String PREF_TRANSLATION_TARGET_LANGUAGE_CODE_KEY int QM_MAX_ROW_SIZE String STAMP_SHOW_FLATTEN_WARNING

[Expand] Inherited Fields
From class com.pdftron.pdf.tools.Tool public static final String[] ANNOTATION_FREE_TEXT_WHITELIST_FONTS

[Expand] Inherited Methods
From class com.pdftron.pdf.tools.SimpleShapeCreate abstract int getCreateAnnotType() Gets what annotation type this tool can create abstract ToolManager.ToolModeBase getToolMode() The overload interface of getToolMode() ()}. boolean isCreatingAnnotation() The overload implementation of isCreatingAnnotation(). void onConfigurationChanged(Configuration newConfig) The overload implementation of onConfigurationChanged(Configuration). boolean onDown(MotionEvent e) The overload implementation of onDown(MotionEvent). boolean onFlingStop() The overload implementation of onFlingStop(). boolean onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) The overload implementation of onMove(MotionEvent, MotionEvent, float, float). boolean onScaleBegin(float x, float y) The overload implementation of onScaleBegin(float, float). boolean onSingleTapConfirmed(MotionEvent e) The overload implementation of onSingleTapConfirmed(MotionEvent). boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode) The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode). void setForceSameNextToolMode(boolean mode) Specifies the mode that should forcefully remains. void setupAnnotProperty(AnnotStyle annotStyle) Setup annotation properties.
From class com.pdftron.pdf.tools.BaseTool boolean isDrawingLoupe() void onClose() The overload implementation of onClose(). boolean onDown(MotionEvent e) The overload implementation of onDown(MotionEvent). void onDraw(Canvas canvas, Matrix tfm) The overload implementation of onDraw(Canvas, Matrix). boolean onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) The overload implementation of onMove(MotionEvent, MotionEvent, float, float).
From class com.pdftron.pdf.tools.Tool void backToDefaultTool() static Pair<ToolManager.ToolMode, ArrayList<Annot>> canSelectGroupAnnot(PDFViewCtrl pdfViewCtrl, Annot annot, int pageNum) Check whether an annotation is part of a group annotation, proceed to select the group instead. void clearTargetPoint() Clears the target point. void closeQuickMenu() Closes the quick menu void executeAction(ActionParameter actionParam) Executes an action with the specified parameters. static String findPDFTronFontName(Context context, String fontName) Returns the PDFTron font name associated with the given font name. Annot getAnnot() Returns the annotation associated with this tool. static Bundle getAnnotationModificationBundle(Bundle bundle) Bundle getBundle() abstract int getCreateAnnotType() Gets what annotation type this tool can create ToolManager.ToolModeBase getCurrentDefaultToolMode() static String getFontKey(int annotType) Returns the storage key string for font static String getHorizontalAlignmentKey(int annotType) Returns the storage key string for horizontal text alignment final ToolManager.ToolModeBase getNextToolMode() The overload implementation of getNextToolMode(). boolean getSnappingEnabled() static RectF getTextSelectRect(float x, float y) Gets a rectangle to use when selecting text. abstract ToolManager.ToolModeBase getToolMode() The overload implementation of getToolMode(). static SharedPreferences getToolPreferences(Context context) static String getVerticalAlignmentKey(int annotType) Returns the storage key string for vertical text alignment boolean hasAnnotSelected() boolean hasMenuEntry(int menuId) Whether the current quick menu includes a certain menu type boolean isCreatingAnnotation() The overload implementation of isCreatingAnnotation(). boolean isEditAnnotTool() Whether the purpose of this tool is editing annotation boolean isEditingAnnot() boolean isForceSameNextToolMode() Gets whether the mode that should forcefully remains. boolean isInsideQuickMenu(float x, float y) Checks whether the specified point is inside the quick menu layout. boolean isQuickMenuShown() check if quick menu is showing void onAnnotPainterUpdated(int page, long which, CurvePainter painter) The overload implementation of onAnnotPainterUpdated(int, long, CurvePainter). void onClose() The overload implementation of onClose(). void onConfigurationChanged(Configuration newConfig) The overload implementation of onConfigurationChanged(Configuration). void onCreate() Called after the tool is created by ToolManager. void onCustomEvent(Object o) The overload implementation of onCustomEvent(Object). void onDocumentDownloadEvent(PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message) The overload implementation of onDocumentDownloadEvent(PDFViewCtrl.DownloadState, int, int, int, String). boolean onDoubleTap(MotionEvent e) The overload implementation of onDoubleTap(MotionEvent). void onDoubleTapEnd(MotionEvent e) The overload implementation of onDoubleTapEnd(MotionEvent). boolean onDoubleTapEvent(MotionEvent e) The overload implementation of onDoubleTapEvent(MotionEvent). void onDoubleTapZoomAnimationBegin() The overload implementation of onDoubleTapZoomAnimationBegin(). void onDoubleTapZoomAnimationEnd() The overload implementation of onDoubleTapZoomAnimationEnd(). boolean onDown(MotionEvent e) The overload implementation of onDown(MotionEvent). void onDraw(Canvas canvas, Matrix tfm) The overload implementation of onDraw(Canvas, Matrix). boolean onDrawEdgeEffects(Canvas canvas, int width, int verticalOffset) The overload implementation of onDrawEdgeEffects(Canvas, int, int). boolean onFlingStop() The overload implementation of onFlingStop(). boolean onKeyUp(int keyCode, KeyEvent event) The overload implementation of onKeyUp(int, KeyEvent). void onLayout(boolean changed, int l, int t, int r, int b) The overload implementation of onLayout(boolean, int, int, int, int). boolean onLongPress(MotionEvent e) The overload implementation of onLongPress(MotionEvent). boolean onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) The overload implementation of onMove(MotionEvent, MotionEvent, float, float). void onNightModeUpdated(boolean isNightMode) The overload implementation of onNightModeUpdated(boolean). void onPageTurning(int old_page, int cur_page) The overload implementation of onPageTurning(int, int). boolean onPointerDown(MotionEvent e) The overload implementation of onPointerDown(MotionEvent). void onPostSingleTapConfirmed() The overload implementation of onPostSingleTapConfirmed(). void onPullEdgeEffects(int whichEdge, float deltaDistance) The overload implementation of onPullEdgeEffects(int, float). boolean onQuickMenuClicked(QuickMenuItem menuItem) Called when a menu in quick menu has been clicked. void onReleaseEdgeEffects() The overload implementation of onReleaseEdgeEffects(). void onRenderingFinished() The overload implementation of onRenderingFinished(). boolean onScale(float x, float y) The overload implementation of onScale(float, float). boolean onScaleBegin(float x, float y) The overload implementation of onScaleBegin(float, float). boolean onScaleEnd(float x, float y) The overload implementation of onScaleEnd(float, float). void onScrollChanged(int l, int t, int oldl, int oldt) The overload implementation of onScrollChanged(int, int, int, int). void onSetDoc() The overload implementation of onSetDoc(). boolean onShowPress(MotionEvent e) The overload implementation of onShowPress(MotionEvent). boolean onSingleTapConfirmed(MotionEvent e) The overload implementation of onSingleTapConfirmed(MotionEvent). boolean onSingleTapUp(MotionEvent e) The overload implementation of onSingleTapUp(MotionEvent). boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode) The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode). void selectAnnot(Annot annot, int pageNum) Selects the specified annotation. static void setAuthorForAnnot(ToolManager toolManager, Markup annot) void setCurrentDefaultToolModeHelper(ToolManager.ToolModeBase defaultToolMode) Uses a helper to set current default tool mode. static void setDebug(boolean debug) void setForceSameNextToolMode(boolean mode) Specifies the mode that should forcefully remains. void setNextToolModeHelper(ToolManager.ToolMode nextToolMode) Uses a helper to set the next tool mode. void setPageNumberIndicatorVisible(boolean visible) Sets the visiblity of page number indicator. void setSnappingEnabled(boolean enabled) void setupAnnotProperty(int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName, int textColor, float textSize) Setup annotation properties. void setupAnnotProperty(AnnotStyle annotStyle) Setup annotation properties. void setupAnnotProperty(int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName) Setup annotation properties. void setupAnnotStyles(ArrayList<AnnotStyle> annotStyles) boolean showMenu(RectF anchor_rect, QuickMenu quickMenu) Shows the quick menu with given menu. boolean showMenu(RectF anchor_rect) Shows the quick menu. static void updateFont(PDFViewCtrl pdfViewCtrl, Widget widget, String contents) Updates font of widget. static void updateFontMap(Context context, int annotType, String pdfFontName, String fontName) void updateQuickMenuNoteText(String note) Update quick menu note text based on if the note has contents void updateQuickMenuStyleColor(int color) Update quick menu appearance item color void updateQuickMenuStyleOpacity(float opacity)
From class java.lang.Object boolean equals(Object arg0) final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.pdftron.pdf.tools.ToolManager.Tool abstract int getCreateAnnotType() Gets what annotation type this tool can create abstract ToolManager.ToolModeBase getNextToolMode() Gets the next tool mode. abstract ToolManager.ToolModeBase getToolMode() Gets the tool mode. abstract boolean isCreatingAnnotation() Propagates isCreatingAnnotation() to the tools. abstract void onAnnotPainterUpdated(int page, long which, CurvePainter painter) Propagates onAnnotPainterUpdated(int, long, com.pdftron.pdf.CurvePainter) to the tools. abstract void onClose() Propagates onClose() to the tools. abstract void onConfigurationChanged(Configuration newConfig) Propagates onConfigurationChanged(Configuration) to the tools. abstract void onCustomEvent(Object obj) Propagates onCustomEvent(Object) to the tools. abstract void onDocumentDownloadEvent(PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message) Propagates onDocumentDownloadEvent(PDFViewCtrl.DownloadState, int, int, int, String) to the tools. abstract boolean onDoubleTap(MotionEvent e) Propagates onDoubleTap(MotionEvent) to the tools. abstract void onDoubleTapEnd(MotionEvent e) Propagates onDoubleTapEnd(MotionEvent) to the tools. abstract boolean onDoubleTapEvent(MotionEvent e) Propagates onDoubleTapEvent(MotionEvent) to the tools. abstract void onDoubleTapZoomAnimationBegin() Propagates onDoubleTapZoomAnimationBegin() to the tools. abstract void onDoubleTapZoomAnimationEnd() Propagates onDoubleTapZoomAnimationEnd() to the tools. abstract boolean onDown(MotionEvent e) Propagates onDown(MotionEvent) to the tools. abstract void onDraw(Canvas canvas, Matrix tfm) Propagates onDraw(Canvas, Matrix) to the tools. abstract boolean onDrawEdgeEffects(Canvas canvas, int width, int verticalOffset) Propagates onDrawEdgeEffects(Canvas, int, int) to the tools. abstract boolean onFlingStop() Propagates onFlingStop() to the tools. abstract boolean onKeyUp(int keyCode, KeyEvent event) Propagates onKeyUp(int, KeyEvent) to the tools. abstract void onLayout(boolean changed, int l, int t, int r, int b) Propagates onLayout(boolean, int, int, int, int) to the tools. abstract boolean onLongPress(MotionEvent e) Propagates onLongPress(MotionEvent) to the tools. abstract boolean onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) Propagates onMove(MotionEvent, MotionEvent, float, float) to the tools. abstract void onNightModeUpdated(boolean isNightMode) Called when night mode has been updated. abstract void onPageTurning(int old_page, int cur_page) Propagates onPageTurning(int, int) to the tools. abstract boolean onPointerDown(MotionEvent e) Propagates onPointerDown(MotionEvent) to the tools. abstract void onPostSingleTapConfirmed() Propagates onPostSingleTapConfirmed() to the tools. abstract void onPullEdgeEffects(int which_edge, float delta_distance) Propagates onPullEdgeEffects(int, float) to the tools. abstract void onReleaseEdgeEffects() Propagates onReleaseEdgeEffects() to the tools. abstract void onRenderingFinished() Propagates onRenderingFinished() to the tools. abstract boolean onScale(float x, float y) Propagates onScale(float, float) to the tools. abstract boolean onScaleBegin(float x, float y) Propagates onScaleBegin(float, float) to the tools. abstract boolean onScaleEnd(float x, float y) Propagates onScaleEnd(float, float) to the tools. abstract void onScrollChanged(int l, int t, int oldl, int oldt) Propagates onScrollChanged(int, int, int, int) to the tools. abstract void onSetDoc() Propagates onSetDoc() to the tools. abstract boolean onShowPress(MotionEvent e) Propagates onShowPress(MotionEvent) to the tools. abstract boolean onSingleTapConfirmed(MotionEvent e) Propagates onSingleTapConfirmed(MotionEvent) to the tools. abstract boolean onSingleTapUp(MotionEvent e) Propagates onSingleTapUp(MotionEvent) to the tools. abstract boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode) Propagates onUp(MotionEvent, PDFViewCtrl.PriorEventMode) to the tools.