DimensionTool (Qoppa jPDFEditor API)

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

```
public class DimensionTool
extends Object
```
This class manages the default settings common across all measurement tools. These defaults are used in DimensionController.
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

Constructor Summary

Constructors
Constructor and Description

DimensionTool()

Constructors
Constructor and Description
`DimensionTool()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getDefaultScaleDisplayUnits()` Returns the default scale display units to use when creating new measurements.
`static String`	`getDefaultScaleDisplayUnitsY()` Returns the default scale display units units for vertical scaling to use when creating new measurements.
`static String`	`getDefaultScaleDisplayValue()` Returns the default scale display value to use when creating new measurements.
`static String`	`getDefaultScaleDisplayValueY()` Returns the default scale display value units for vertical scaling to use when creating new measurements.
`static String`	`getDefaultScalePageUnits()` Returns the default scale page units to use when creating new measurements.
`static String`	`getDefaultScalePageUnitsY()` Returns the default scale page units units for vertical scaling to use when creating new measurements.
`static String`	`getDefaultScalePageValue()` Returns the default scale page value to use when creating new measurements.
`static String`	`getDefaultScalePageValueY()` Returns the default scale page value for vertical scaling used when creating new measurements.
`static String`	`getDefaultScalePrecision()` Returns the default scale precision used when creating new measurements
`static boolean`	`isShiftKeyPressed()` Returns the value of the flag that controls whether the Shift key should be simulated when creating dimension annotations (distance, perimeter, area).
`static boolean`	`isShowDimensionDialog()` Returns the value of the show dimension dialog flag.
`static boolean`	`isSnapEnabled()` Returns the value of the snap to content enabled flag.
`static void`	`setDefaultScaleDisplayUnits(String defaultScaleDisplayUnits)` Sets the default scale display units to use when creating new measurements.
`static void`	`setDefaultScaleDisplayUnitsY(String defaultScaleDisplayUnits)` Sets the default scale display units for vertical scaling to use when creating new measurements.
`static void`	`setDefaultScaleDisplayValue(String defaultScaleDisplayValue)` Sets the default scale display value to use when creating new measurements.
`static void`	`setDefaultScaleDisplayValueY(String defaultScaleDisplayValue)` Sets the default scale display value units for vertical scaling to use when creating new measurements.
`static void`	`setDefaultScalePageUnits(String defaultScalePageUnits)` Sets the default scale page units to use when creating new measurements.
`static void`	`setDefaultScalePageUnitsY(String defaultScalePageUnits)` Sets the default scale page units units for vertical scaling to use when creating new measurements.
`static void`	`setDefaultScalePageValue(String defaultScalePageValue)` Sets the default scale page value to use when creating new measurements.
`static void`	`setDefaultScalePageValueY(String defaultScalePageValue)` Sets the default scale page value units for vertical scaling to use when creating new measurements.
`static void`	`setDefaultScalePrecision(String defaultScalePrecision)` Sets the default scale precision to use when creating new measurements.
`static void`	`setShiftKeyPressed(boolean shiftKeyPressed)` Sets a flag to indicate whether the Shift key should be simulated when creating dimension annotations (distance, perimeter, area).
`static void`	`setSnapToContent(boolean snap)` Sets a flag to indicate whether snapping to content should be enabled when drawing dimension annotations.
`static void`	`setUseSeparateVerticalScale(boolean useSeparateVerticalScale)` Sets a flag to indicate whether separate vertical scaling should be used when creating dimension annotations.
`static void`	`showDimensionDialog(boolean show)` Sets a flag to indicate whether to show the dimension dialog when creating dimension annotations (distance, perimeter, area).
`static boolean`	`useSeparateVerticalScale()` Returns the value of the flag that controls whether separate vertical scaling should be used by default when creating dimension annotations.

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

- Constructor Detail
  - DimensionTool
```
public DimensionTool()
```
- Method Detail
  - setSnapToContent
```
public static void setSnapToContent(boolean snap)
```
    Sets a flag to indicate whether snapping to content should be enabled when drawing dimension annotations.
    
    Parameters:
    
    snap - The new value of the snap to content flag
  - isSnapEnabled
```
public static boolean isSnapEnabled()
```
    Returns the value of the snap to content enabled flag.
    
    Returns:
    
    The value of the snap to content enabled flag.
  - showDimensionDialog
```
public static void showDimensionDialog(boolean show)
```
    Sets a flag to indicate whether to show the dimension dialog when creating dimension annotations (distance, perimeter, area).
    
    Parameters:
    
    show - The new value of the show dimension dialog flag.
  - isShowDimensionDialog
```
public static boolean isShowDimensionDialog()
```
    Returns the value of the show dimension dialog flag.
    
    Returns:
    
    The value of the show dimension dialog flag.
  - isShiftKeyPressed
```
public static boolean isShiftKeyPressed()
```
    Returns the value of the flag that controls whether the Shift key should be simulated when creating dimension annotations (distance, perimeter, area).
    
    Returns:
    
    the shiftKeyPressed
  - setShiftKeyPressed
```
public static void setShiftKeyPressed(boolean shiftKeyPressed)
```
    Sets a flag to indicate whether the Shift key should be simulated when creating dimension annotations (distance, perimeter, area). Setting this flag will force the angles to the horizon to be 0, 45, or 90 degrees.
    
    Parameters:
    
    shiftKeyPressed - The new value of the flag
  - getDefaultScalePageValue
```
public static String getDefaultScalePageValue()
```
    Returns the default scale page value to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Returns:
    
    the default scale page value
  - setDefaultScalePageValue
```
public static void setDefaultScalePageValue(String defaultScalePageValue)
```
    Sets the default scale page value to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Parameters:
    
    defaultScalePageValue - The new value of the default scale page value
  - getDefaultScalePageUnits
```
public static String getDefaultScalePageUnits()
```
    Returns the default scale page units to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Returns:
    
    the default scale page units
  - setDefaultScalePageUnits
```
public static void setDefaultScalePageUnits(String defaultScalePageUnits)
```
    Sets the default scale page units to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Parameters:
    
    defaultScalePageUnits - The new value of the default scale page units
  - getDefaultScaleDisplayValue
```
public static String getDefaultScaleDisplayValue()
```
    Returns the default scale display value to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Returns:
    
    the default scale display value
  - setDefaultScaleDisplayValue
```
public static void setDefaultScaleDisplayValue(String defaultScaleDisplayValue)
```
    Sets the default scale display value to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Parameters:
    
    defaultScaleDisplayValue - the new value of the default scale display value
  - getDefaultScaleDisplayUnits
```
public static String getDefaultScaleDisplayUnits()
```
    Returns the default scale display units to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Returns:
    
    the default scale display units
  - setDefaultScaleDisplayUnits
```
public static void setDefaultScaleDisplayUnits(String defaultScaleDisplayUnits)
```
    Sets the default scale display units to use when creating new measurements. When useSeparateVerticalScale() returns true, this is used for the X scale only.
    
    Parameters:
    
    defaultScaleDisplayUnits - the new value for the default scale display units
  - getDefaultScalePrecision
```
public static String getDefaultScalePrecision()
```
    Returns the default scale precision used when creating new measurements
    
    Returns:
    
    the default scale precision
  - setDefaultScalePrecision
```
public static void setDefaultScalePrecision(String defaultScalePrecision)
```
    Sets the default scale precision to use when creating new measurements.
    
    Parameters:
    
    defaultScalePrecision - the new value of the default scale precision
  - getDefaultScalePageValueY
```
public static String getDefaultScalePageValueY()
```
    Returns the default scale page value for vertical scaling used when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Returns:
    
    the default scale page value
  - setDefaultScalePageValueY
```
public static void setDefaultScalePageValueY(String defaultScalePageValue)
```
    Sets the default scale page value units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Parameters:
    
    defaultScalePageValue - The new value of the default scale page value
  - getDefaultScalePageUnitsY
```
public static String getDefaultScalePageUnitsY()
```
    Returns the default scale page units units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Returns:
    
    the default scale page units
  - setDefaultScalePageUnitsY
```
public static void setDefaultScalePageUnitsY(String defaultScalePageUnits)
```
    Sets the default scale page units units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Parameters:
    
    defaultScalePageUnits - The new value of the default scale page units
  - getDefaultScaleDisplayValueY
```
public static String getDefaultScaleDisplayValueY()
```
    Returns the default scale display value units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Returns:
    
    the default scale display value
  - setDefaultScaleDisplayValueY
```
public static void setDefaultScaleDisplayValueY(String defaultScaleDisplayValue)
```
    Sets the default scale display value units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Parameters:
    
    defaultScaleDisplayValue - the new value of the default scale display value
  - getDefaultScaleDisplayUnitsY
```
public static String getDefaultScaleDisplayUnitsY()
```
    Returns the default scale display units units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Returns:
    
    the default scale display units
  - setDefaultScaleDisplayUnitsY
```
public static void setDefaultScaleDisplayUnitsY(String defaultScaleDisplayUnits)
```
    Sets the default scale display units for vertical scaling to use when creating new measurements. Only used when useSeparateVerticalScale() returns true.
    
    Parameters:
    
    defaultScaleDisplayUnits - the new value for the default scale display units
  - useSeparateVerticalScale
```
public static boolean useSeparateVerticalScale()
```
    Returns the value of the flag that controls whether separate vertical scaling should be used by default when creating dimension annotations.
    
    Returns:
    
    the value of the separate vertical scaling flag
  - setUseSeparateVerticalScale
```
public static void setUseSeparateVerticalScale(boolean useSeparateVerticalScale)
```
    Sets a flag to indicate whether separate vertical scaling should be used when creating dimension annotations.
    
    Parameters:
    
    useSeparateVerticalScale - new value of the flag

Class DimensionTool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DimensionTool

Method Detail

setSnapToContent

isSnapEnabled

showDimensionDialog

isShowDimensionDialog

isShiftKeyPressed

setShiftKeyPressed

getDefaultScalePageValue

setDefaultScalePageValue

getDefaultScalePageUnits

setDefaultScalePageUnits

getDefaultScaleDisplayValue

setDefaultScaleDisplayValue

getDefaultScaleDisplayUnits

setDefaultScaleDisplayUnits

getDefaultScalePrecision

setDefaultScalePrecision

getDefaultScalePageValueY

setDefaultScalePageValueY

getDefaultScalePageUnitsY

setDefaultScalePageUnitsY

getDefaultScaleDisplayValueY

setDefaultScaleDisplayValueY

getDefaultScaleDisplayUnitsY

setDefaultScaleDisplayUnitsY

useSeparateVerticalScale

setUseSeparateVerticalScale