FreeText (Qoppa jPDFNotes API)

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` Vertical text alignment = bottom of annotation.
`static int`	`ALIGN_CENTER` Horizontal text alignment = center of annotation.
`static int`	`ALIGN_LEFT` Horizontal text alignment = left side of annotation.
`static int`	`ALIGN_MIDDLE` Vertical text alignment = middle of annotation.
`static int`	`ALIGN_RIGHT` Horizontal text alignment = right side of annotation.
`static int`	`ALIGN_TOP` Vertical text alignment = top of annotation.
`static String`	`INTENT_TYPE_WRITER` Typewriter intent.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getAlignHorizontal()` Returns the horizontal alignment of the text.
`int`	`getAlignVertical()` Returns the vertical alignment of the text.
`Color`	`getBorderColor()` Returns the border color.
`Rectangle2D.Double`	`getBorderRect()` Returns the border rectangle.
`String`	`getContents()` Returns the plain text contents for this annotation.
`Date`	`getCreationDate()` Returns the date and time when the annotation was created.
`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
`String`	`getRichContents()` Returns the rich contents for this annotation.
`int`	`getRotation()` Returns the rotation.
`BasicStroke`	`getStroke()` Gets the stroke to use when drawing the annotation.
`Color`	`getTextColor()` Returns the color of the text.
`boolean`	`isIntentTypeWriter()` Returns true if this is a typewriter annotation.
`void`	`setAlignHorizontal(int align)` Sets the horizontal alignment of the text.
`void`	`setAlignVertical(int align)` Sets the vertical alignment of the text.
`void`	`setBorderColor(Color borderColor)` Sets the border color.
`void`	`setBorderRect(Rectangle2D.Double borderRect)` Sets the border rectangle.
`void`	`setContents(String contents)` Sets the string contents for this annotation.
`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`	`setRichContents(String richContents)` Sets the rich contents for this annotation.
`void`	`setRotation(int rotation)` Sets the rotation.
`void`	`setStroke(BasicStroke stroke)` Sets the stroke used when drawing the annotation.
`void`	`setTextColor(Color textColor)` Sets the color of the text.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation
getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, 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, setTriggerActions, shiftRectangle

- Field Detail
  - ALIGN_LEFT
```
static final int ALIGN_LEFT
```
    Horizontal text alignment = left side of annotation.
    
    See Also:
    
    Constant Field Values
  - ALIGN_CENTER
```
static final int ALIGN_CENTER
```
    Horizontal text alignment = center of annotation.
    
    See Also:
    
    Constant Field Values
  - ALIGN_RIGHT
```
static final int ALIGN_RIGHT
```
    Horizontal text alignment = right side of annotation.
    
    See Also:
    
    Constant Field Values
  - ALIGN_TOP
```
static final int ALIGN_TOP
```
    Vertical text alignment = top of annotation.
    
    See Also:
    
    Constant Field Values
  - ALIGN_MIDDLE
```
static final int ALIGN_MIDDLE
```
    Vertical text alignment = middle of annotation.
    
    See Also:
    
    Constant Field Values
  - ALIGN_BOTTOM
```
static final int ALIGN_BOTTOM
```
    Vertical text alignment = bottom of annotation.
    
    See Also:
    
    Constant Field Values
  - INTENT_TYPE_WRITER
```
static final String INTENT_TYPE_WRITER
```
    Typewriter intent.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getContents
```
String getContents()
```
    Returns the plain text contents for this annotation.
    
    Specified by:
    
    getContents in interface Annotation
    
    Returns:
    
    the plain text contents for this annotation.
    
    See Also:
    
    getRichContents()
  - setContents
```
void setContents(String contents)
```
    Sets the string contents for this annotation.
    
    Parameters:
    
    contents - the new string contents.
  - getRichContents
```
String getRichContents()
```
    Returns the rich contents for this annotation.
    
    Returns:
    
    the rich contents for this annotation.
  - setRichContents
```
void setRichContents(String richContents)
```
    Sets the rich contents for this annotation.
    
    Parameters:
    
    richContents - the new rich contents.
  - getAlignHorizontal
```
int getAlignHorizontal()
```
    Returns the horizontal alignment of the text.
    
    Returns:
    
    the horizontal alignment of the text.
  - setAlignHorizontal
```
void setAlignHorizontal(int align)
```
    Sets the horizontal alignment of the text. Should be one of ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT.
    
    Parameters:
    
    align - the new horizontal alignment of the text.
  - getAlignVertical
```
int getAlignVertical()
```
    Returns the vertical alignment of the text.
    
    Returns:
    
    the vertical alignment of the text.
  - setAlignVertical
```
void setAlignVertical(int align)
```
    Sets the vertical alignment of the text. Should be one of ALIGN_TOP, ALIGN_MIDDLE, ALIGN_BOTTOM.
    
    Parameters:
    
    align - the new vertical alignment of the text.
  - 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()
```
    Returns the color of the text.
    
    Returns:
    
    the color of the text.
  - setTextColor
```
void setTextColor(Color textColor)
```
    Sets the color of the text.
    
    Parameters:
    
    textColor - the new color of the text.
  - getBorderColor
```
Color getBorderColor()
```
    Returns the border color.
    
    Returns:
    
    the border color.
  - setBorderColor
```
void setBorderColor(Color borderColor)
```
    Sets the border color.
    
    Parameters:
    
    borderColor - the new border color.
  - getBorderRect
```
Rectangle2D.Double getBorderRect()
```
    Returns the border rectangle.
    
    Returns:
    
    the border rectangle.
  - setBorderRect
```
void setBorderRect(Rectangle2D.Double borderRect)
```
    Sets the border rectangle.
    
    Parameters:
    
    borderRect - the new border rectangle.
  - getRotation
```
int getRotation()
```
    Returns the rotation.
    
    Returns:
    
    the rotation.
  - setRotation
```
void setRotation(int rotation)
```
    Sets the rotation.
    
    Parameters:
    
    rotation - the new 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()
```
    Returns true if this is a typewriter annotation.
    
    Returns:
    
    true if this is a typewriter annotation.
  - 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

getRichContents

setRichContents

getAlignHorizontal

setAlignHorizontal

getAlignVertical

setAlignVertical

setPDFFont

getFontName

getFontSize

getTextColor

setTextColor

getBorderColor

setBorderColor

getBorderRect

setBorderRect

getRotation

setRotation

getIntent

setIntent

isIntentTypeWriter

getStroke

setStroke

getCreationDate