FreeTextTool (Qoppa jPDFNotes API)

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

```
public class FreeTextTool
extends Object
```
This class manages the default properties and settings for the FreeText 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_PROPS_DIALOG

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

Constructor Summary

Constructors
Constructor and Description

FreeTextTool()

Constructors
Constructor and Description
`FreeTextTool()`

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 border when a new annotation is created.
`static double`	`getDefaultBorderWidth2D()` Returns the default border width, used when new annotations are created.
`static Color`	`getDefaultColor()` Returns the default color.
`static Color`	`getDefaultFillColor()` Gets the default fill color.
`static String`	`getDefaultFontName()` Returns the name of the default font.
`static float`	`getDefaultFontSize()` Returns the point size of the default font
`static int`	`getDefaultHorizontalAlign()` Returns the default horizontal alignment property used when a new free text annotation is created.
`static boolean`	`getDefaultStrikethrough()` Gets the default strikethrough value that is used when new annotations are created.
`static int`	`getDefaultTransparency()` Gets the default transparency value that is used when new annotations are created.
`static boolean`	`getDefaultUnderline()` Gets the default underline value that is used when new annotations are created.
`static int`	`getDefaultVerticalAlign()` Returns the default vertical alignment property used when a new free text annotation is 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`	`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 border color.
`static void`	`setDefaultBorderWidth2D(double defaultBorderWidth)` Sets the border width used when a new annotation is created.
`static void`	`setDefaultColor(Color defaultColor)` Sets the default color.
`static void`	`setDefaultFillColor(Color defaultFillColor)` Sets the default fill color.
`static void`	`setDefaultFontName(String fontName)` Sets the name of the default font.
`static void`	`setDefaultFontSize(float fontSize)` Sets the point size of the default font.
`static void`	`setDefaultHorizontalAlign(int defaultHorizontalAlign)` Sets the default horizontal alignment property.
`static void`	`setDefaultProperties(FreeText freeText)` This is a convenience method to set the FreeText properties to the FreeTextTool default properties.
`static void`	`setDefaultStrikethrough(boolean defaultStrikethrough)` Sets the default strikethrough value that is used when new annotations are created.
`static void`	`setDefaultTransparency(int defaultTransparency)` Sets the default transparency values when new annotations are created.
`static void`	`setDefaultUnderline(boolean defaultUnderline)` Sets the default underline value that is used when new annotations are created.
`static void`	`setDefaultVerticalAlign(int defaultVerticalAlign)` Sets the default vertical alignment property.
`static void`	`setMinimumAnnotSize(Dimension minimumAnnotSize)` Sets the minimum size for the annotations created with this Tool.
`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
```
- Constructor Detail
  - FreeTextTool
```
public FreeTextTool()
```
- Method Detail
  - setDefaultProperties
```
public static void setDefaultProperties(FreeText freeText)
```
    This is a convenience method to set the FreeText properties to the FreeTextTool default properties.
  - getDefaultFillColor
```
public static Color getDefaultFillColor()
```
    Gets the default fill color. This color is used to fill in the annotation when a new annotation is created.
    
    Returns:
    
    the default fill color
  - setDefaultFillColor
```
public static void setDefaultFillColor(Color defaultFillColor)
```
    Sets the default fill color. This color is used to fill in the annotation when a new annotation is created.
    
    Parameters:
    
    defaultFillColor - The new default fill color
  - getDefaultBorderColor
```
public static Color getDefaultBorderColor()
```
    Returns the color used for the border when a new annotation is created.
    
    Returns:
    
    the default border color
  - setDefaultBorderColor
```
public static void setDefaultBorderColor(Color defaultBorderColor)
```
    Sets the default border color. This color will be used when new annotations are created.
    
    Parameters:
    
    defaultBorderColor - The new default border color.
  - getDefaultBorderWidth2D
```
public static double getDefaultBorderWidth2D()
```
    Returns the default border width, used when new annotations are created.
    
    Returns:
    
    the default border width value
  - setDefaultBorderWidth2D
```
public static void setDefaultBorderWidth2D(double defaultBorderWidth)
```
    Sets the border width used when a new annotation is created.
    
    Parameters:
    
    defaultBorderWidth - The new default border width
  - getDefaultColor
```
public static Color getDefaultColor()
```
    Returns the default color. This color is used to paint the text in the annotation.
    
    Returns:
    
    the default color
  - setDefaultColor
```
public static void setDefaultColor(Color defaultColor)
```
    Sets the default color. This color is used to paint the text in the annotation.
    
    Parameters:
    
    defaultColor - the new default color
  - getDefaultHorizontalAlign
```
public static int getDefaultHorizontalAlign()
```
    Returns the default horizontal alignment property used when a new free text annotation is created.
    
    Returns:
    
    the value of the horizontal alignment property
  - setDefaultHorizontalAlign
```
public static void setDefaultHorizontalAlign(int defaultHorizontalAlign)
```
    Sets the default horizontal alignment property. This is used when a new free text annotation is created.
    
    Parameters:
    
    defaultHorizontalAlign - the new value for the default horizontal alignment
  - getDefaultVerticalAlign
```
public static int getDefaultVerticalAlign()
```
    Returns the default vertical alignment property used when a new free text annotation is created.
    
    Returns:
    
    the value of the vertical alignment property
  - setDefaultVerticalAlign
```
public static void setDefaultVerticalAlign(int defaultVerticalAlign)
```
    Sets the default vertical alignment property. This is used when a new free text annotation is created.
    
    Parameters:
    
    defaultVerticalAlign - the new value for the default vertical alignment
  - 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
  - getDefaultFontName
```
public static String getDefaultFontName()
```
    Returns the name of the default font.
    
    Returns:
    
    The default font name.
  - setDefaultFontName
```
public static void setDefaultFontName(String fontName)
```
    Sets the name of the default font.
    The supported fonts are Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic.
    The font will default to Helvetica.
    
    Parameters:
    
    fontName - The default font name.
  - getDefaultFontSize
```
public static float getDefaultFontSize()
```
    Returns the point size of the default font
    
    Returns:
    
    The default font size.
  - setDefaultFontSize
```
public static void setDefaultFontSize(float fontSize)
```
    Sets the point size of the default font.
    
    Parameters:
    
    fontSize - The default font size.
  - 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 - The new default transparency value
  - getDefaultStrikethrough
```
public static boolean getDefaultStrikethrough()
```
    Gets the default strikethrough value that is used when new annotations are created.
    
    Returns:
    
    the default strikethrough value
  - setDefaultStrikethrough
```
public static void setDefaultStrikethrough(boolean defaultStrikethrough)
```
    Sets the default strikethrough value that is used when new annotations are created.
    
    Parameters:
    
    defaultStrikethrough - The new default strikethrough value
  - getDefaultUnderline
```
public static boolean getDefaultUnderline()
```
    Gets the default underline value that is used when new annotations are created.
    
    Returns:
    
    the default underline value
  - setDefaultUnderline
```
public static void setDefaultUnderline(boolean defaultUnderline)
```
    Sets the default underline value that is used when new annotations are created.
    
    Parameters:
    
    defaultUnderline - The new default underline value

Class FreeTextTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHOW_NOTHING

SHOW_PROPS_DIALOG

Constructor Detail

FreeTextTool

Method Detail

setDefaultProperties

getDefaultFillColor

setDefaultFillColor

getDefaultBorderColor

setDefaultBorderColor

getDefaultBorderWidth2D

setDefaultBorderWidth2D

getDefaultColor

setDefaultColor

getDefaultHorizontalAlign

setDefaultHorizontalAlign

getDefaultVerticalAlign

setDefaultVerticalAlign

getDefaultBasicStroke

setDefaultBasicStroke

isToolSticky

setToolSticky

isShowPropDialog

setShowPropDialog

getShowOption

setShowOption

getMinimumAnnotSize

setMinimumAnnotSize

getDefaultFontName

setDefaultFontName

getDefaultFontSize

setDefaultFontSize

getDefaultTransparency

setDefaultTransparency

getDefaultStrikethrough

setDefaultStrikethrough

getDefaultUnderline

setDefaultUnderline