public class

RulerCreate

extends ArrowCreate
java.lang.Object
   ↳ com.pdftron.pdf.tools.Tool
     ↳ com.pdftron.pdf.tools.BaseTool
       ↳ com.pdftron.pdf.tools.SimpleShapeCreate
         ↳ com.pdftron.pdf.tools.ArrowCreate
           ↳ com.pdftron.pdf.tools.RulerCreate

Summary

[Expand]
Inherited Constants
From class com.pdftron.pdf.tools.Tool
[Expand]
Inherited Fields
From class com.pdftron.pdf.tools.Tool
Public Constructors
RulerCreate(PDFViewCtrl ctrl)
Class constructor
Public Methods
static void adjustContents(Annot annot, RulerItem rulerItem, double pt1x, double pt1y, double pt2x, double pt2y)
Modifies the annotation's measurement entries based on input.
int getCreateAnnotType()
Gets what annotation type this tool can create
static String getLabel(RulerItem rulerItem, double pt1x, double pt1y, double pt2x, double pt2y)
Gets measurement label for display purpose.
ToolManager.ToolModeBase getToolMode()
The overload implementation of getToolMode().
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).
boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)
The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode).
void setupAnnotProperty(AnnotStyle annotStyle)
Setup annotation properties.
[Expand]
Inherited Methods
From class com.pdftron.pdf.tools.ArrowCreate
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.tools.ToolManager.Tool

Public Constructors

public RulerCreate (PDFViewCtrl ctrl)

Class constructor

Public Methods

public static void adjustContents (Annot annot, RulerItem rulerItem, double pt1x, double pt1y, double pt2x, double pt2y)

Modifies the annotation's measurement entries based on input.

Parameters
annot the annotation
rulerItem the scale information
pt1x pt1x
pt1y pt1y
pt2x pt2x
pt2y pt2y

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 static String getLabel (RulerItem rulerItem, double pt1x, double pt1y, double pt2x, double pt2y)

Gets measurement label for display purpose.

Parameters
rulerItem the scale information
pt1x pt1x
pt1y pt1y
pt2x pt2x
pt2y pt2y
Returns
  • the label

public ToolManager.ToolModeBase getToolMode ()

The overload implementation of getToolMode().

Returns
  • the mode/identifier of this tool.

public boolean onDown (MotionEvent e)

The overload implementation of onDown(MotionEvent).

public void onDraw (Canvas canvas, Matrix tfm)

The overload implementation of onDraw(Canvas, Matrix).

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

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

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

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

public void setupAnnotProperty (AnnotStyle annotStyle)

Setup annotation properties.