java.lang.Object
   ↳ com.pdftron.pdf.tools.Tool
     ↳ com.pdftron.pdf.tools.BaseTool
       ↳ com.pdftron.pdf.tools.SimpleShapeCreate
         ↳ com.pdftron.pdf.tools.StickyNoteCreate
Known Direct Subclasses

Class Overview

This class is for creating a sticky note annotation.

Summary

[Expand]
Inherited Constants
From class com.pdftron.pdf.tools.SimpleShapeCreate
From class com.pdftron.pdf.tools.BaseTool
From class com.pdftron.pdf.tools.Tool
[Expand]
Inherited Fields
From class com.pdftron.pdf.tools.Tool
Public Constructors
StickyNoteCreate(PDFViewCtrl ctrl)
Class constructor
Public Methods
int getCreateAnnotType()
Gets what annotation type this tool can create
ToolManager.ToolModeBase getToolMode()
The overload implementation of getToolMode().
void onAnnotButtonPressed(int button)
The overload implementation of onAnnotButtonPressed(int).
void onChangeAnnotBorderStyle(ShapeBorderStyle borderStyle)
This method is invoked when the border style of an annotation is changed
void onChangeAnnotFillColor(int color)
The method is invoked when fill color is selected
void onChangeAnnotFont(FontResource font)
The method is invoked when font resource is selected in font spinner
void onChangeAnnotIcon(String icon)
The method is invoked when icon is selected in icon picker
void onChangeAnnotLineEndStyle(LineEndingStyle lineEndStyle)
This method is invoked when the line end style of an annotation is changed
void onChangeAnnotLineStartStyle(LineEndingStyle lineStartStyle)
This method is invoked when the line start style of an annotation is changed
void onChangeAnnotLineStyle(LineStyle lineStyle)
This method is invoked when the line style of an annotation is changed
void onChangeAnnotOpacity(float opacity, boolean done)
The method is invoked when opacity is changed in style picker
void onChangeAnnotStrokeColor(int color)
The method is invoked when color is selected If it is Text annotation, it will change sticky note icon color If it is FreeText annotation, it will change text color
void onChangeAnnotTextColor(int textColor)
The method is invoked when text color is changed in style picker
void onChangeAnnotTextSize(float textSize, boolean done)
The method is invoked when text size is changed in style picker
void onChangeAnnotThickness(float thickness, boolean done)
The method is invoked when thickness is changed in style picker
void onChangeDateFormat(String dateFormat)
This method is invoked when date format change
void onChangeOverlayText(String overlayText)
The method is invoked when overlay text change
void onChangeRichContentEnabled(boolean enabled)
The method is invoked when rich content enabled change
void onChangeRulerProperty(RulerItem rulerItem)
The method is invoked when any of the ruler properties change
void onChangeSnapping(boolean snap)
The method is invoked when snap switch change
void onChangeTextAlignment(int horizontalAlignment, int verticalAlignment)
This method is invoked when the text alignment is changed
void onClose()
The overload implementation of onClose().
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 onQuickMenuClicked(QuickMenuItem menuItem)
Called when a menu in quick menu has been clicked.
boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)
The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode).
void setTargetPoint(PointF point)
Sets the target point.
void setupAnnotProperty(int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName)
The overload implementation of setupAnnotProperty(int, float, float, int, String, String).
[Expand]
Inherited Methods
From class com.pdftron.pdf.tools.SimpleShapeCreate
From class com.pdftron.pdf.tools.BaseTool
From class com.pdftron.pdf.tools.Tool
From class java.lang.Object
From interface com.pdftron.pdf.model.AnnotStyle.OnAnnotStyleChangeListener
From interface com.pdftron.pdf.tools.DialogAnnotNote.DialogAnnotNoteListener
From interface com.pdftron.pdf.tools.ToolManager.Tool

Public Constructors

public StickyNoteCreate (PDFViewCtrl ctrl)

Class constructor

Public Methods

public int getCreateAnnotType ()

Gets what annotation type this tool can create

Returns
  • annot type for annotation creation tool, or unknown for non-creation tool.

public ToolManager.ToolModeBase getToolMode ()

The overload implementation of getToolMode().

Returns
  • the mode/identifier of this tool.

public void onAnnotButtonPressed (int button)

The overload implementation of onAnnotButtonPressed(int).

Parameters
button The button ID. See android.content.DialogInterface

public void onChangeAnnotBorderStyle (ShapeBorderStyle borderStyle)

This method is invoked when the border style of an annotation is changed

Parameters
borderStyle the border style

public void onChangeAnnotFillColor (int color)

The method is invoked when fill color is selected

Parameters
color fill color of annotation

public void onChangeAnnotFont (FontResource font)

The method is invoked when font resource is selected in font spinner

Parameters
font font resource

public void onChangeAnnotIcon (String icon)

The method is invoked when icon is selected in icon picker

Parameters
icon icon name of sticky note

public void onChangeAnnotLineEndStyle (LineEndingStyle lineEndStyle)

This method is invoked when the line end style of an annotation is changed

Parameters
lineEndStyle the line end style

public void onChangeAnnotLineStartStyle (LineEndingStyle lineStartStyle)

This method is invoked when the line start style of an annotation is changed

Parameters
lineStartStyle the line start style

public void onChangeAnnotLineStyle (LineStyle lineStyle)

This method is invoked when the line style of an annotation is changed

Parameters
lineStyle the line style

public void onChangeAnnotOpacity (float opacity, boolean done)

The method is invoked when opacity is changed in style picker

Parameters
opacity opacity of annotation

public void onChangeAnnotStrokeColor (int color)

The method is invoked when color is selected If it is Text annotation, it will change sticky note icon color If it is FreeText annotation, it will change text color

Parameters
color stroke color/ icon color/ text color of annotation

public void onChangeAnnotTextColor (int textColor)

The method is invoked when text color is changed in style picker

Parameters
textColor text color of annotation style.

public void onChangeAnnotTextSize (float textSize, boolean done)

The method is invoked when text size is changed in style picker

Parameters
textSize text size of annotation style.

public void onChangeAnnotThickness (float thickness, boolean done)

The method is invoked when thickness is changed in style picker

Parameters
thickness thickness of annotation style.

public void onChangeDateFormat (String dateFormat)

This method is invoked when date format change

Parameters
dateFormat the date format

public void onChangeOverlayText (String overlayText)

The method is invoked when overlay text change

Parameters
overlayText the overlay text

public void onChangeRichContentEnabled (boolean enabled)

The method is invoked when rich content enabled change

Parameters
enabled whether to enable rich content

public void onChangeRulerProperty (RulerItem rulerItem)

The method is invoked when any of the ruler properties change

Parameters
rulerItem the ruler item

public void onChangeSnapping (boolean snap)

The method is invoked when snap switch change

Parameters
snap whether to snap

public void onChangeTextAlignment (int horizontalAlignment, int verticalAlignment)

This method is invoked when the text alignment is changed

Parameters
horizontalAlignment the horizontal text alignment
verticalAlignment the vertical text alignment

public void onClose ()

The overload implementation of onClose().

public void onConfigurationChanged (Configuration newConfig)

The overload implementation of onConfigurationChanged(Configuration).

public boolean onDown (MotionEvent e)

The overload implementation of onDown(MotionEvent).

public boolean onFlingStop ()

The overload implementation of onFlingStop().

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

The overload implementation of onMove(MotionEvent, MotionEvent, float, float).

public boolean onQuickMenuClicked (QuickMenuItem menuItem)

Called when a menu in quick menu has been clicked.

Parameters
menuItem The clicked menu item.
Returns
  • True if handled

public boolean onUp (MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)

The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode).

public void setTargetPoint (PointF point)

Sets the target point.

Parameters
point The target point

public void setupAnnotProperty (int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName)

The overload implementation of setupAnnotProperty(int, float, float, int, String, String).

Parameters
color The color
opacity The opacity
thickness The thickness
fillColor The color for filling
icon The icon
pdfTronFontName The PDFTron font name