DistanceTool (Qoppa jPDFNotes API)

java.lang.Object
- com.qoppa.pdfNotes.settings.DistanceTool

```
public class DistanceTool
extends Object
```
This class manages the default properties and settings for the Distance Tool. The method setDefaultProperties() can be used to set the Annotation properties to this Tool's default properties.
The Tool's property values can be retrieved and initialized with the methods toXMLString() and setFromXML() in the AnnotationTools class. Please see AnnotationTools.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type Field and Description

static int SHOW_NOTHING

static int SHOW_POPUP

static int SHOW_PROPS_DIALOG

Fields
Modifier and Type	Field and Description
`static int`	`SHOW_NOTHING`
`static int`	`SHOW_POPUP`
`static int`	`SHOW_PROPS_DIALOG`

Constructor Summary

Constructors
Constructor and Description

DistanceTool()

Constructors
Constructor and Description
`DistanceTool()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static BasicStroke`	`getDefaultBasicStroke()` Gets the default stroke.
`static Color`	`getDefaultBorderColor()` Returns the color used for the line when a new annotation is created.
`static double`	`getDefaultBorderWidth2D()` Returns the default line width, used when new annotations are created.
`static Color`	`getDefaultFillColor()` Returns the fill color.
`static String`	`getDefaultLineEndStyle()` Gets the default line end style used when creating new line annotations.
`static String`	`getDefaultLineStartStyle()` Gets the default line start style used when creating new line annotations.
`static int`	`getDefaultTransparency()` Gets the default transparency value that is used when new annotations are created.
`static Dimension`	`getMinimumAnnotSize()` Gets the minimum size for the annotations created with this Tool.
`static int`	`getShowOption()` Returns the option for what this Tool should do after it creates the annotation.
`static boolean`	`isShowCalibrateMessage()` Returns the value of the show calibrate message flag.
`static boolean`	`isShowMeasurement()` Returns the setting for whether to display the measurement on the annotation itself.
`static boolean`	`isShowPropDialog()` Deprecated.
`static boolean`	`isToolSticky()` Returns a flag indicating if this tool is sticky.
`static void`	`setDefaultBasicStroke(BasicStroke defaultStroke)` Sets the default stroke.
`static void`	`setDefaultBorderColor(Color defaultBorderColor)` Sets the default line color.
`static void`	`setDefaultBorderWidth2D(double defaultBorderWidth)` Sets the line width used when a new annotation is created.
`static void`	`setDefaultFillColor(Color defaultFillColor)` Sets the default fill color.
`static void`	`setDefaultLineEndStyle(String defaultLineEndStyle)` Possible values are: `ShapeAnnotation.LE_NONE_STR` `ShapeAnnotation.LE_SQUARE_STR` `ShapeAnnotation.LE_CIRCLE_STR` `ShapeAnnotation.LE_DIAMOND_STR` `ShapeAnnotation.LE_OPENARROW_STR` `ShapeAnnotation.LE_CLOSEDARROW_STR`
`static void`	`setDefaultLineStartStyle(String defaultLineStartStyle)` Possible values are: `ShapeAnnotation.LE_NONE_STR` `ShapeAnnotation.LE_SQUARE_STR` `ShapeAnnotation.LE_CIRCLE_STR` `ShapeAnnotation.LE_DIAMOND_STR` `ShapeAnnotation.LE_OPENARROW_STR` `ShapeAnnotation.LE_CLOSEDARROW_STR`
`static void`	`setDefaultProperties(Line line)` This is a convenience method to set the Line-Dimension properties to the MeasurementTool default properties.
`static void`	`setDefaultTransparency(int defaultTransparency)` Sets the default transparency values when new annotations are created.
`static void`	`setMinimumAnnotSize(Dimension minimumAnnotSize)` Sets the minimum size for the annotations created with this Tool.
`static void`	`setShowCalibrateMessage(boolean show)` Sets a flag to indicate whether to show the explanation message when calibrating the scale.
`static void`	`setShowMeasurement(boolean showMeasurement)` Set whether to display the measurement on the annotation itself.
`static void`	`setShowOption(int option)` Sets the option for what this Tool should do after it creates the annotation.
`static void`	`setShowPropDialog(boolean showPropDialog)` Deprecated.
`static void`	`setToolSticky(boolean toolSticky)` Sets the flag that indicates whether this tool is sticky or not.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SHOW_NOTHING
```
public static int SHOW_NOTHING
```
  - SHOW_PROPS_DIALOG
```
public static int SHOW_PROPS_DIALOG
```
  - SHOW_POPUP
```
public static int SHOW_POPUP
```
- Constructor Detail
  - DistanceTool
```
public DistanceTool()
```
- Method Detail
  - setDefaultProperties
```
public static void setDefaultProperties(Line line)
```
    This is a convenience method to set the Line-Dimension properties to the MeasurementTool default properties.
  - getDefaultTransparency
```
public static int getDefaultTransparency()
```
    Gets the default transparency value that is used when new annotations are created.
    
    Returns:
    
    the default transparency value
  - setDefaultTransparency
```
public static void setDefaultTransparency(int defaultTransparency)
```
    Sets the default transparency values when new annotations are created.
    
    Parameters:
    
    defaultTransparency - Thew new default transparency value
  - getDefaultLineStartStyle
```
public static String getDefaultLineStartStyle()
```
    Gets the default line start style used when creating new line annotations.
    
    Returns:
    
    the default line start style
  - setDefaultLineStartStyle
```
public static void setDefaultLineStartStyle(String defaultLineStartStyle)
```
    Possible values are:
    - ShapeAnnotation.LE_NONE_STR
    - ShapeAnnotation.LE_SQUARE_STR
    - ShapeAnnotation.LE_CIRCLE_STR
    - ShapeAnnotation.LE_DIAMOND_STR
    - ShapeAnnotation.LE_OPENARROW_STR
    - ShapeAnnotation.LE_CLOSEDARROW_STR
    Parameters:
    
    defaultLineStartStyle - the defaultLineStartStyle to set
  - getDefaultLineEndStyle
```
public static String getDefaultLineEndStyle()
```
    Gets the default line end style used when creating new line annotations.
    
    Returns:
    
    the default line end style
  - setDefaultLineEndStyle
```
public static void setDefaultLineEndStyle(String defaultLineEndStyle)
```
    Possible values are:
    - ShapeAnnotation.LE_NONE_STR
    - ShapeAnnotation.LE_SQUARE_STR
    - ShapeAnnotation.LE_CIRCLE_STR
    - ShapeAnnotation.LE_DIAMOND_STR
    - ShapeAnnotation.LE_OPENARROW_STR
    - ShapeAnnotation.LE_CLOSEDARROW_STR
    Parameters:
    
    defaultLineEndStyle - the defaultLineEndStyle to set
  - getDefaultBorderColor
```
public static Color getDefaultBorderColor()
```
    Returns the color used for the line when a new annotation is created. This property is called the border color because internally, the PDF format defines the line color as the border color.
    
    Returns:
    
    the default line color
  - setDefaultBorderColor
```
public static void setDefaultBorderColor(Color defaultBorderColor)
```
    Sets the default line color. This color will be used when new annotations are created.
    
    Parameters:
    
    defaultBorderColor - The new default line color.
  - getDefaultFillColor
```
public static Color getDefaultFillColor()
```
    Returns the fill color. This color is used to fill the arrow heads, if they are set to solid.
    
    Returns:
    
    the fill color
  - setDefaultFillColor
```
public static void setDefaultFillColor(Color defaultFillColor)
```
    Sets the default fill color. This is the color used to fill in solid arrows when creating new arrow annotations.
    
    Parameters:
    
    defaultFillColor - the defaultFillColor to set
  - getDefaultBorderWidth2D
```
public static double getDefaultBorderWidth2D()
```
    Returns the default line width, used when new annotations are created.
    
    Returns:
    
    the default border width value
  - setDefaultBorderWidth2D
```
public static void setDefaultBorderWidth2D(double defaultBorderWidth)
```
    Sets the line width used when a new annotation is created.
    
    Parameters:
    
    defaultBorderWidth - The new default line width
  - getDefaultBasicStroke
```
public static BasicStroke getDefaultBasicStroke()
```
    Gets the default stroke. This is the stroke used to draw the annotation.
    
    Returns:
    
    the default stroke
  - setDefaultBasicStroke
```
public static void setDefaultBasicStroke(BasicStroke defaultStroke)
```
    Sets the default stroke. This is the stroke used to draw the annotation.
    
    Parameters:
    
    defaultStroke - The new default stroke
  - isToolSticky
```
public static boolean isToolSticky()
```
    Returns a flag indicating if this tool is sticky. When a tool is sticky, it will remain active after a user finishes adding a comment.
    
    Returns:
    
    the toolSticky flag
  - setToolSticky
```
public static void setToolSticky(boolean toolSticky)
```
    Sets the flag that indicates whether this tool is sticky or not. When a tool is sticky, it will remain active after a user finishes adding a comment.
    
    Parameters:
    
    toolSticky - The new value of the sticky flag.
  - isShowPropDialog
```
@Deprecated
public static boolean isShowPropDialog()
```
    Deprecated.
    
    Gets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.
    
    Returns:
    
    the showPropDialog
  - setShowPropDialog
```
@Deprecated
public static void setShowPropDialog(boolean showPropDialog)
```
    Deprecated.
    
    Sets the flag for this Tool to show or not the annotation properties popup dialog after an annotation has been created.
    
    Parameters:
    
    showPropDialog - the showPropDialog to set
  - getShowOption
```
public static int getShowOption()
```
    Returns the option for what this Tool should do after it creates the annotation. The options are SHOW_NOTHING, SHOW_PROPS_DIALOG, or .
    
    Returns:
  - setShowOption
```
public static void setShowOption(int option)
```
    Sets the option for what this Tool should do after it creates the annotation. The options are SHOW_NOTHING, SHOW_PROPS_DIALOG, or .
    
    Parameters:
    
    option -
  - getMinimumAnnotSize
```
public static Dimension getMinimumAnnotSize()
```
    Gets the minimum size for the annotations created with this Tool. When the annotation is drawn by a user with a "null size", the annotation size will be automatically set to the annotation's minimum size.
    
    Returns:
    
    the minimumAnnotSize
  - setMinimumAnnotSize
```
public static void setMinimumAnnotSize(Dimension minimumAnnotSize)
```
    Sets the minimum size for the annotations created with this Tool. When the annotation is drawn by a user with a "null size", the annotation size will be automatically set to the annotation's minimum size.
    
    Parameters:
    
    minimumAnnotSize - the minimumAnnotSize to set
  - setShowCalibrateMessage
```
public static void setShowCalibrateMessage(boolean show)
```
    Sets a flag to indicate whether to show the explanation message when calibrating the scale.
    
    Parameters:
    
    show - The new value of the show calibrate message flag.
  - isShowCalibrateMessage
```
public static boolean isShowCalibrateMessage()
```
    Returns the value of the show calibrate message flag.
    
    Returns:
    
    The value of the show calibrate message flag.
  - isShowMeasurement
```
public static boolean isShowMeasurement()
```
    Returns the setting for whether to display the measurement on the annotation itself.
    
    Returns:
    
    the setting for displaying the measurement
  - setShowMeasurement
```
public static void setShowMeasurement(boolean showMeasurement)
```
    Set whether to display the measurement on the annotation itself.
    
    Parameters:
    
    showMeasurement - boolean controlling whether to display the measurement on the annotation

Class DistanceTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHOW_NOTHING

SHOW_PROPS_DIALOG

SHOW_POPUP

Constructor Detail

DistanceTool

Method Detail

setDefaultProperties

getDefaultTransparency

setDefaultTransparency

getDefaultLineStartStyle

setDefaultLineStartStyle

getDefaultLineEndStyle

setDefaultLineEndStyle

getDefaultBorderColor

setDefaultBorderColor

getDefaultFillColor

setDefaultFillColor

getDefaultBorderWidth2D

setDefaultBorderWidth2D

getDefaultBasicStroke

setDefaultBasicStroke

isToolSticky

setToolSticky

isShowPropDialog

setShowPropDialog

getShowOption

setShowOption

getMinimumAnnotSize

setMinimumAnnotSize

setShowCalibrateMessage

isShowCalibrateMessage

isShowMeasurement

setShowMeasurement