FreeText

All Superinterfaces:

Annotation

All Known Subinterfaces:

Callout
```
public interface FreeText
extends Annotation
```
Interface representing a FreeText annotation in a PDF document. This annotation is called Text Box in the user interface. FreeText annotations are displayed as a text box on the PDF document.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGN_BOTTOM`
`static int`	`ALIGN_CENTER`
`static int`	`ALIGN_LEFT`
`static int`	`ALIGN_MIDDLE`
`static int`	`ALIGN_RIGHT`
`static int`	`ALIGN_TOP`
`static String`	`INTENT_TYPE_WRITER`

Fields inherited from interface com.qoppa.pdf.annotations.Annotation
BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAlignHorizontal()`
`int`	`getAlignVertical()`
`Color`	`getBorderColor()`
`Rectangle2D.Double`	`getBorderRect()`
`String`	`getContents()` Returns the string contents for this annotation.
`Date`	`getCreationDate()` Returns the date and time when the annotation was created.
`Font`	`getFont()` Deprecated. Use getFontName() and getFontSize() instead.
`String`	`getFontName()` Return the name of the PDF font.
`float`	`getFontSize()` Returns the point size of the PDF font.
`String`	`getIntent()` Returns the description of the intent of the FreeText Annotation
`int`	`getRotation()`
`BasicStroke`	`getStroke()` Gets the stroke to use when drawing the annotation.
`Color`	`getTextColor()`
`boolean`	`isIntentTypeWriter()`
`void`	`setAlignHorizontal(int align)`
`void`	`setAlignVertical(int align)`
`void`	`setBorderColor(Color borderColor)`
`void`	`setBorderRect(Rectangle2D.Double borderRect)`
`void`	`setContents(String contents)` Sets the string contents for this annotation.
`void`	`setFont(Font font)` Deprecated. Use setPDFFont() instead.
`void`	`setIntent(String intent)` Set the description of the intent of the FreeText Annotation.
`void`	`setPDFFont(String fontName, float fontSize)` Sets the name and point size of the PDF Font.
`void`	`setRotation(int rotation)`
`void`	`setStroke(BasicStroke stroke)` Sets the stroke used when drawing the annotation.
`void`	`setTextColor(Color textColor)`

Methods inherited from interface com.qoppa.pdf.annotations.Annotation
getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setSubtype, setTriggerActions, shiftRectangle

- Field Detail
  - ALIGN_LEFT
```
static final int ALIGN_LEFT
```
    See Also:
    Constant Field Values
  - ALIGN_CENTER
```
static final int ALIGN_CENTER
```
    See Also:
    Constant Field Values
  - ALIGN_RIGHT
```
static final int ALIGN_RIGHT
```
    See Also:
    Constant Field Values
  - ALIGN_TOP
```
static final int ALIGN_TOP
```
    See Also:
    Constant Field Values
  - ALIGN_MIDDLE
```
static final int ALIGN_MIDDLE
```
    See Also:
    Constant Field Values
  - ALIGN_BOTTOM
```
static final int ALIGN_BOTTOM
```
    See Also:
    Constant Field Values
  - INTENT_TYPE_WRITER
```
static final String INTENT_TYPE_WRITER
```
    See Also:
    Constant Field Values
- Method Detail
  - getContents
```
String getContents()
```
    Returns the string contents for this annotation.
    
    Specified by:
    
    getContents in interface Annotation
    
    Returns:
    The annotation's contents.
  - setContents
```
void setContents(String contents)
```
    Sets the string contents for this annotation.
  - getAlignHorizontal
```
int getAlignHorizontal()
```
  - setAlignHorizontal
```
void setAlignHorizontal(int align)
```
  - getAlignVertical
```
int getAlignVertical()
```
  - setAlignVertical
```
void setAlignVertical(int align)
```
  - getFont
```
Font getFont()
```
    Deprecated. Use getFontName() and getFontSize() instead.
  - setFont
```
void setFont(Font font)
```
    Deprecated. Use setPDFFont() instead.
  - setPDFFont
```
void setPDFFont(String fontName,
              float fontSize)
```
    Sets the name and point size of the PDF 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 font name.
    fontSize - The Font size.
  - getFontName
```
String getFontName()
```
    Return the name of the PDF font.
    
    Returns:
    The name of the PDF font.
  - getFontSize
```
float getFontSize()
```
    Returns the point size of the PDF font.
    
    Returns:
    The point size of the PDF font.
  - getTextColor
```
Color getTextColor()
```
  - setTextColor
```
void setTextColor(Color textColor)
```
  - getBorderColor
```
Color getBorderColor()
```
  - setBorderColor
```
void setBorderColor(Color borderColor)
```
  - getBorderRect
```
Rectangle2D.Double getBorderRect()
```
  - setBorderRect
```
void setBorderRect(Rectangle2D.Double borderRect)
```
  - getRotation
```
int getRotation()
```
  - setRotation
```
void setRotation(int rotation)
```
  - getIntent
```
String getIntent()
```
    Returns the description of the intent of the FreeText Annotation
    
    Returns:
    intent
  - setIntent
```
void setIntent(String intent)
```
    Set the description of the intent of the FreeText Annotation. Valid value is FreeText.INTENT_TYPE_WRITER, which means that the annotation is intended to function as a click-to-type or typewriter object.
    
    Parameters:
    intent - the intent to set
  - isIntentTypeWriter
```
boolean isIntentTypeWriter()
```
  - getStroke
```
BasicStroke getStroke()
```
    Gets the stroke to use when drawing the annotation.
    
    Returns:
    The stroke used in drawing.
  - setStroke
```
void setStroke(BasicStroke stroke)
```
    Sets the stroke used when drawing the annotation.
    
    Parameters:
    stroke - The stroke to use when drawing the annotation.
  - getCreationDate
```
Date getCreationDate()
```
    Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.
    
    Returns:
    The date and time when the annotation was created.

Interface FreeText

Field Summary

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

Method Summary

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

Field Detail

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

ALIGN_TOP

ALIGN_MIDDLE

ALIGN_BOTTOM

INTENT_TYPE_WRITER

Method Detail

getContents

setContents

getAlignHorizontal

setAlignHorizontal

getAlignVertical

setAlignVertical

getFont

setFont

setPDFFont

getFontName

getFontSize

getTextColor

setTextColor

getBorderColor

setBorderColor

getBorderRect

setBorderRect

getRotation

setRotation

getIntent

setIntent

isIntentTypeWriter

getStroke

setStroke

getCreationDate