PdfFreeTextAnnot (Gnostice PDFOne (for Java) API Docs)

java.lang.Object
- com.gnostice.pdfone.PdfAnnot
- - com.gnostice.pdfone.PdfFreeTextAnnot

All Implemented Interfaces:: Usable, Cloneable

public class PdfFreeTextAnnot
extends PdfAnnot

This class represents a free text annotation. A free text annotation is displayed directly on the page. The "content" text for the annotation is displayed on the page. A callout line can be associated with the annotation rectangle of the free text annotation.

PdfWriter writer1 = PdfWriter.fileWriter(
         new File("PdfFreeTextAnnot_example.pdf"));
PdfDocument doc1 = new PdfDocument(writer1);        
PdfPage p1 = new PdfPage();     
doc1.add(p1);

// Create a free text annotation
PdfFreeTextAnnot fta1 = 
    new PdfFreeTextAnnot(
            new PdfRect(100,100,200,50),
            "subject line text", 
            "content text",
            "title text",
            PdfAnnot.FLAG_PRINT,
            Color.YELLOW, 
            PdfFreeTextAnnot.ALIGNMENT_CENTER);

double cl1[] = {300,100, 300,150, 350,250};

// Set properties of the annotation
fta1.setCalloutLine(cl1);
fta1.setIntent(PdfFreeTextAnnot.INTENT_FREETEXT_CALLOUT);

// Add annotation to the document
doc1.addAnnotation(fta1, 1);

// Mark the annotation
doc1.writeText(".(300, 100) starting", 300,100);
doc1.writeText(".(300, 150) ending ", 300,150);
doc1.writeText(".(350, 250) knee", 350,250);

doc1.setOpenAfterSave(true);
doc1.write();       
writer1.dispose();

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNMENT_CENTER` Constant for align of text contents of the free-text annotation to the center.
`static int`	`ALIGNMENT_LEFT` Constant for align of text contents of the free-text annotation to the left.
`static int`	`ALIGNMENT_RIGHT` Constant for align of text contents of the free-text annotation to the right margin.
`static int`	`INTENT_FREETEXT_CALLOUT` Constant for specifying that free text annotation needs to be used as a callout.
`static int`	`INTENT_FREETEXT_TYPEWRITER`

Fields inherited from interface com.gnostice.pdfone.Usable
INCHES_TO_POINTS, MM_TO_INCHES, MM_TO_POINTS, PDF_A, PDF_AA, PDF_AC, PDF_ACROFORM, PDF_ACTION, PDF_ALTERNATEPRESENTATIONS, PDF_ANNOT, PDF_ANNOT_DEFAULT_TITLE, PDF_ANNOT_NAME, PDF_ANNOT_SUBJECT, PDF_ANNOTS, PDF_AP, PDF_ARRAYEND, PDF_ARRAYSTART, PDF_ARTBOX, PDF_AS, PDF_ASCENT, PDF_ASCII85, PDF_ASCII85_NEW, PDF_ASCIIHEX, PDF_ASCIIHEX_NEW, PDF_AuthEvent, PDF_AUTHOR, PDF_AVGWIDTH, PDF_B, PDF_BASEFONT, PDF_BBOX, PDF_BC, PDF_BE, PDF_BEFOREFORMAT, PDF_BEGINTEXT, PDF_BG, PDF_BINARYDATA, PDF_BITS_PER_COMPONENT, PDF_BL, PDF_BLEEDBOX, PDF_BLINDS, PDF_BMC, PDF_BORDER, PDF_BOX, PDF_BS, PDF_BTN, PDF_BYTERANGE, PDF_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, PDF_CF, PDF_CFM, PDF_CH, PDF_CID_TO_GID_MAP, PDF_CIDFONT_TYPE0, PDF_CIDFONT_TYPE1, PDF_CIDFONT_TYPE2, PDF_CIDSYSTEM_INFO, PDF_CIRCLEANNOT, PDF_CL, PDF_CM, PDF_COLOMNS, PDF_COLOR, PDF_COLORSPACE, PDF_COLORSPACE_CALGRAY, PDF_COLORSPACE_CALRGB, PDF_COLORSPACE_DEVICEN, PDF_COLORSPACE_ICCBASED, PDF_COLORSPACE_LAB, PDF_COLORSPACE_SEPARATION, PDF_CONTACTINFO, PDF_CONTENTS, PDF_COUNT, PDF_COVER, PDF_CREATIONDATE, PDF_CREATOR, PDF_CROPBOX, PDF_CS, PDF_CSP, PDF_D, PDF_DA, PDF_DATE, PDF_DATE_FORMAT, PDF_DCTDECODE, PDF_DCTDECODE_NEW, PDF_DECODEPARMS, PDF_DESC, PDF_DESCENDANT, PDF_DESCENDANT_FONTS, PDF_DESCENDENTFONTS, PDF_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIFFERENCES, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, PDF_DOCMDP, PDF_DOS, PDF_DP, PDF_DR, PDF_DS, PDF_DV, PDF_DW, PDF_E, PDF_EF, PDF_EMBEDDEDFILE, PDF_EMBEDDEDFILES, PDF_EMC, PDF_ENCODING, PDF_ENCRYPT, PDF_ENCRYPTMETADATA, PDF_ENDOBJ, PDF_ENDPATH, PDF_ENDSTREAM, PDF_ENDTEXT, PDF_EOCLIP, PDF_EOF, PDF_EXTGSTATE, PDF_F, PDF_FADE, PDF_FALSE, PDF_FDESCRIPTOR, PDF_FIELD_FLAG, PDF_FIELDS, PDF_FILEATTACHMENTANNOT, PDF_FILESPEC, PDF_FILTER, PDF_FIRST, PDF_FIRST_PAGE, PDF_FIRSTCHAR, PDF_FIT, PDF_FIT_WINDOW, PDF_FITB, PDF_FITBH, PDF_FITBV, PDF_FITH, PDF_FITR, PDF_FITV, PDF_FIXEDPRINT, PDF_FLAGS, PDF_FLATE, PDF_FLATE_NEW, PDF_FLY, PDF_FO, PDF_FONT, PDF_FONTBBOX, PDF_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, PDF_FREE_TEXT_CALLOUT, PDF_FREE_TEXT_TYPEWRITER, PDF_FREETEXTANNOT, PDF_FS, PDF_FT, PDF_FULLSCREEN, PDF_GLITTER, PDF_GOTO_ACTION, PDF_GROUP, PDF_GS, PDF_H, PDF_HEADER, PDF_HEIGHT, PDF_HEXSTRINGEND, PDF_HEXSTRINGSTART, PDF_HIDE_MENUBAR, PDF_HIDE_TOOLBAR, PDF_HIDE_WINDOWUI, PDF_HIGHLIGHT, PDF_HORIZ_STEM, PDF_HORIZONTAL, PDF_I, PDF_IC, PDF_ID, PDF_IDS, PDF_IF, PDF_IMAGE, PDF_IMAGEB, PDF_IMAGEC, PDF_IMAGEI, PDF_IMPORTDATA, PDF_INDEX, PDF_INDEXED, PDF_INFO, PDF_INK, PDF_INKLIST, PDF_INWARD, PDF_IT, PDF_ITALANGLE, PDF_IX, PDF_JAVASCRIPT, PDF_JAVASCRIPT_ACTION, PDF_JS, PDF_KEYSTROKE, PDF_KEYWORDS, PDF_KIDS, PDF_L, PDF_L2R, PDF_LANG, PDF_LAST, PDF_LAST_PAGE, PDF_LASTCHAR, PDF_LAUNCH_ACTION, PDF_LE, PDF_LEGAL, PDF_LENGTH, PDF_LENGTH_1, PDF_LENGTH_2, PDF_LENGTH_3, PDF_LF, PDF_LINEANNOT, PDF_LINKANNOT, PDF_LITERALSTRINGEND, PDF_LITERALSTRINGSTART, PDF_LOCATION, PDF_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, PDF_MATRIX, PDF_MAXLEN, PDF_MAXWIDTH, PDF_MEDIABOX, PDF_METADATA, PDF_MISSINGWIDTH, PDF_MK, PDF_MODDATE, PDF_N, PDF_NAME, PDF_NAMED, PDF_NAMED_ACT_FIND, PDF_NAMED_ACT_OPEN, PDF_NAMED_ACT_PRINT, PDF_NAMED_ACT_SEARCH, PDF_NAMES, PDF_NAMESTART, PDF_NEEDAPPEARANCES, PDF_NEWLINE, PDF_NEWWINDOW, PDF_NEXT, PDF_NEXT_PAGE, PDF_NO_COMP_OBJ, PDF_NONFULLSCREEN_PAGEMODE, PDF_NULL, PDF_O, PDF_OBJ, PDF_OBJSTREAM, PDF_OCPROPERTIES, PDF_OFF, PDF_ONECOLUMN, PDF_OPEN, PDF_OPEN_ACTION, PDF_OPT, PDF_OUTLINES, PDF_OUTPUTINTENTS, PDF_OUTWARD, PDF_P, PDF_PAGE, PDF_PAGECLOSE, PDF_PAGEINVISIBLE, PDF_PAGELABELS, PDF_PAGELAYOUT, PDF_PAGEMODE, PDF_PAGEOPEN, PDF_PAGES, PDF_PAGEVISIBLE, PDF_PAINT_TYPE, PDF_PARAMS, PDF_PARENT, PDF_PATTERN, PDF_PATTERN_TYPE, PDF_PBD, PDF_PC, PDF_PDC, PDF_PDF, PDF_PERMS, PDF_PFD, PDF_PH, PDF_PIECEINFO, PDF_POLYGONANNOT, PDF_POLYLINEANNOT, PDF_POPUP, PDF_PREDICTOR, PDF_PREV, PDF_PREV_PAGE, PDF_PROCSET, PDF_PRODUCER, PDF_PROPERTIES, PDF_PUSH, PDF_PV, PDF_Q, PDF_QUADPOINTS, PDF_R, PDF_R2L, PDF_RC, PDF_RD, PDF_RE, PDF_REASON, PDF_RECALCULATE, PDF_RECT, PDF_REMOTEGOTO_ACTION, PDF_RENDITIONS, PDF_REPLACE, PDF_RESET_FORM, PDF_RESOURCES, PDF_RESTORE_GS, PDF_RI, PDF_ROOT, PDF_ROTATE, PDF_RUNLENGTH, PDF_RUNLENGTH_NEW, PDF_S, PDF_SCN, PDF_SHADING, PDF_SHOWIMG, PDF_SHOWTEXT, PDF_SHOWTEXT_TJ, PDF_SIG, PDF_SIG_FILTER_ADOBE_PPKLITE, PDF_SIG_FILTER_ADOBE_PPKMS, PDF_SIG_SUBFILTER_ADBE_PKCS7_DETACHED, PDF_SIG_SUBFILTER_ADBE_PKCS7_SHA1, PDF_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SQUIGGLY, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_StmF, PDF_STORE_GS, PDF_STREAM, PDF_StrF, PDF_STRIKEOUT, PDF_STRUCT_TREE, PDF_SUBFILTER, PDF_SUBMIT_FORM, PDF_SUBTYPE, PDF_T, PDF_TAB, PDF_TEMPLATES, PDF_TEXT, PDF_TEXTANNOT, PDF_TEXTCHARSPACE, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTHORIZONTALSCALE, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWORDSPACE, PDF_THREADS, PDF_THUMB, PDF_TILING_TYPE, PDF_TITLE, PDF_TJ_OPERAND_END, PDF_TJ_OPERAND_START, PDF_TM, PDF_TOUNICODE, PDF_TP, PDF_TRAILER, PDF_TRANSITION, PDF_TRIMBOX, PDF_TRUE, PDF_TRUETYPE, PDF_TU, PDF_TWOCOLUMN_LEFT, PDF_TWOCOLUMN_RIGHT, PDF_TWOPAGE_LEFT, PDF_TWOPAGE_RIGHT, PDF_TX, PDF_TYPE, PDF_TYPE0, PDF_TYPE1, PDF_U, PDF_UNCOVER, PDF_UNDERLINE, PDF_UNIX, PDF_URI_ACTION, PDF_URL, PDF_URLS, PDF_USEATTACHMENTS, PDF_USENONE, PDF_USEOC, PDF_USEOUTLINES, PDF_USETHUMBS, PDF_V, PDF_VALUECHANGE, PDF_VERSION, PDF_VERT_STEM, PDF_VERTICAL, PDF_VERTICES, PDF_VIEWER_PREFERENCES, PDF_W, PDF_WATERMARKANNOT, PDF_WIDGET, PDF_WIDTH, PDF_WIDTHS, PDF_WINANSIENCODING, PDF_WIPE, PDF_X, PDF_XML, PDF_XOBJECT, PDF_XREF, PDF_XREFSTMOFFSET, PDF_XREFSTREAM, PDF_XSTEP, PDF_XYZ, PDF_YES, PDF_YSTEP, PIXEL_PER_INCH, RUBICON_EMBEDDED, SITE, TEXT, TWIPS_TO_POINTS

Constructor Summary

Constructors
Constructor and Description
`PdfFreeTextAnnot()` Zero-argument default constructor.
`PdfFreeTextAnnot(PdfRect r, Color c)` Creates a free text annotation with specified annotation rectangle and background color.
`PdfFreeTextAnnot(PdfRect r, int flags)` Creates a free text annotation with specified annotation rectangle and annotation attributes.
`PdfFreeTextAnnot(PdfRect r, int flags, Color c)` Creates a free text annotation with specified annotation rectangle, annotation attributes, and background color.
`PdfFreeTextAnnot(PdfRect r, String subject, String contents, String title)` Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, and title text.
`PdfFreeTextAnnot(PdfRect r, String subject, String contents, String title, Color c)` Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, and background color.
`PdfFreeTextAnnot(PdfRect r, String subject, String contents, String title, int flags)` Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, and annotation attributes.
`PdfFreeTextAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c)` Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, annotation attributes, and background color.
`PdfFreeTextAnnot(PdfRect r, String subject, String contents, String title, int flags, Color c, int alignment)` Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, annotation attributes, background color, and text alignment of the displayed text.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`getAlignment()` Returns how text is aligned inside the annotation rectangle.
`double[]`	`getCalloutLine()` Returns x-y coordinates of the starting, end, and knee-bend locations of the callout line of the free text annotation.
`PdfAppearanceStream`	`getDownAppearance()` Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
`int`	`getIntent()` Returns constant identifying the function of the free text annotation.
`PdfAppearanceStream`	`getNormalAppearance()` Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
`PdfPopUpAnnot`	`getPopup()` Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
`PdfAppearanceStream`	`getRolloverAppearance()` Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).
`float`	`getTransparency()`
`void`	`setAlignment(int alignment)` Specifies how text needs to be aligned inside the annotation rectangle.
`void`	`setCalloutLine(double[] calloutLine)` Specifies x-y coordinates of the starting, end, and knee-bend locations of the callout line of the free text annotation.
`void`	`setDownAppearance(PdfAppearanceStream downAppearance)` Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
`void`	`setIntent(int intent)` Specifies constant identifying the function of the free text annotation.
`void`	`setNormalAppearance(PdfAppearanceStream normalAppearance)` Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
`void`	`setPopup(PdfPopUpAnnot popup, boolean overridePopUpProperties)` Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
`void`	`setRolloverAppearance(PdfAppearanceStream rolloverAppearance)` Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).
`void`	`setTransparency(float transparecyLevel)`

Methods inherited from class com.gnostice.pdfone.PdfAnnot
delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, getType, hashCode, isDeleted, isShowRect, setAnnotName, setBorderStyle, setBorderWidth, setColor, setContents, setDashPattern, setFlags, setRect, setRect, setRect, setRect, setRect, setShowRect, setSubject, setTitle

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

- Field Detail
  - ALIGNMENT_LEFT
```
public static final int ALIGNMENT_LEFT
```
    Constant for align of text contents of the free-text annotation to the left.
    
    See Also:
    
    Constant Field Values
  - ALIGNMENT_CENTER
```
public static final int ALIGNMENT_CENTER
```
    Constant for align of text contents of the free-text annotation to the center.
    
    See Also:
    
    Constant Field Values
  - ALIGNMENT_RIGHT
```
public static final int ALIGNMENT_RIGHT
```
    Constant for align of text contents of the free-text annotation to the right margin.
    
    See Also:
    
    Constant Field Values
  - INTENT_FREETEXT_CALLOUT
```
public static final int INTENT_FREETEXT_CALLOUT
```
    Constant for specifying that free text annotation needs to be used as a callout.
    
    See Also:
    
    Constant Field Values
  - INTENT_FREETEXT_TYPEWRITER
```
public static final int INTENT_FREETEXT_TYPEWRITER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot()
                 throws IOException,
                        PdfException
```
    Zero-argument default constructor.
    
    Throws:
    
    IOException
    
    PdfException
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags,
                        Color c,
                        int alignment)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, annotation attributes, background color, and text alignment of the displayed text.
    
    Parameters:
    
    r - annotation rectangle
    
    subject - text that needs to be used as subject of the free text annotation
    
    contents - text that needs to be directly displayed on the page
    
    title - text that needs to be used as title of the free text annotation
    
    flags - annotation attributes
    
    c - background-color of the free text annotation
    
    alignment - alignment of the text inside the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, and title text.
    
    Parameters:
    
    r - annotation rectangle
    
    subject - text that needs to be used as subject of the free text annotation
    
    contents - text that needs to be directly displayed on the page
    
    title - text that needs to be used as title of the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        Color c)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, and background color.
    
    Parameters:
    
    r - annotation rectangle
    
    subject - text that needs to be used as subject of the free text annotation
    
    contents - text that needs to be directly displayed on the page
    
    title - text that needs to be used as title of the free text annotation
    
    c - background-color of the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, and annotation attributes.
    
    Parameters:
    
    r - annotation rectangle
    
    subject - text that needs to be used as subject of the free text annotation
    
    contents - text that needs to be directly displayed on the page
    
    title - text that needs to be used as title of the free text annotation
    
    flags - annotation attributes
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        String subject,
                        String contents,
                        String title,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, subject text, displayed text content, title text, annotation attributes, and background color.
    
    Parameters:
    
    r - annotation rectangle
    
    subject - text that needs to be used as subject of the free text annotation
    
    contents - text that needs to be directly displayed on the page
    
    title - text that needs to be used as title of the free text annotation
    
    flags - annotation attributes
    
    c - background-color of the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        int flags)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle and annotation attributes.
    
    Parameters:
    
    r - annotation rectangle
    
    flags - annotation attributes
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        int flags,
                        Color c)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle, annotation attributes, and background color.
    
    Parameters:
    
    r - annotation rectangle
    
    flags - annotation attributes
    
    c - background-color of the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
  - PdfFreeTextAnnot
```
public PdfFreeTextAnnot(PdfRect r,
                        Color c)
                 throws IOException,
                        PdfException
```
    Creates a free text annotation with specified annotation rectangle and background color.
    
    Parameters:
    
    r - annotation rectangle
    
    c - background-color of the free text annotation
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    PdfException - if an illegal argument is supplied.
- Method Detail
  - clone
```
public Object clone()
```
  - getAlignment
```
public int getAlignment()
```
    Returns how text is aligned inside the annotation rectangle.
    
    Returns:
    
    constant specifying text alignment
    
    See Also:
    
    setAlignment(int)
  - setAlignment
```
public void setAlignment(int alignment)
```
    Specifies how text needs to be aligned inside the annotation rectangle. By default, text is aligned to the left.
    
    Parameters:
    
    alignment - constant specifying text alignment
    
    See Also:
    
    getAlignment()
  - getCalloutLine
```
public double[] getCalloutLine()
```
    Returns x-y coordinates of the starting, end, and knee-bend locations of the callout line of the free text annotation.
    
    Returns:
    
    x-y coordinates of starting, end, and knee-bend locations of the callout line
    
    See Also:
    
    setCalloutLine(double[])
  - setCalloutLine
```
public void setCalloutLine(double[] calloutLine)
```
    Specifies x-y coordinates of the starting, end, and knee-bend locations of the callout line of the free text annotation.
    
    Parameters:
    
    calloutLine - x-y coordinates of starting, end, and knee-bend locations of the callout line
    
    See Also:
    
    getCalloutLine()
  - getIntent
```
public int getIntent()
```
    Returns constant identifying the function of the free text annotation.
    
    Returns:
    
    constant identifying the function of the free text annotation
    
    See Also:
    
    setAlignment(int)
  - setIntent
```
public void setIntent(int intent)
```
    Specifies constant identifying the function of the free text annotation.
    
    Parameters:
    
    intent - constant identifying the function of the free text annotation
    
    See Also:
    
    getIntent()
  - setTransparency
```
public void setTransparency(float transparecyLevel)
```
  - getTransparency
```
public float getTransparency()
```
  - getPopup
```
public PdfPopUpAnnot getPopup()
```
    Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
    
    Returns:
    
    popup annotation that needs to be used as the popup window
  - setPopup
```
public void setPopup(PdfPopUpAnnot popup,
                     boolean overridePopUpProperties)
```
    Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
    
    Parameters:
    
    popup - popup annotation that needs to be used as the popup window
    
    overridePopUpProperties - whether a viewer application should override the properties of the popup annotation with those of this annotation
    
    See Also:
    
    getPopup()
  - getDownAppearance
```
public PdfAppearanceStream getDownAppearance()
```
    Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
    
    Returns:
    
    appearance that needs to be displayed
    
    See Also:
    
    getNormalAppearance(), getDownAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream)
  - setDownAppearance
```
public void setDownAppearance(PdfAppearanceStream downAppearance)
```
    Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
    
    See Also:
    
    getNormalAppearance(), getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)
  - getNormalAppearance
```
public PdfAppearanceStream getNormalAppearance()
```
    Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
    
    See Also:
    
    getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)
  - setNormalAppearance
```
public void setNormalAppearance(PdfAppearanceStream normalAppearance)
```
    Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
    
    Parameters:
    
    normalAppearance - the specified appearance stream
    
    See Also:
    
    setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream), getNormalAppearance(), getDownAppearance(), getRolloverAppearance()
  - getRolloverAppearance
```
public PdfAppearanceStream getRolloverAppearance()
```
    Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).
    
    See Also:
    
    getNormalAppearance(), getDownAppearance(), setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)
  - setRolloverAppearance
```
public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)
```
    Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).
    
    Parameters:
    
    rolloverAppearance - the specified appearance stream
    
    See Also:
    
    setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), getNormalAppearance(), getDownAppearance(), getRolloverAppearance()

Class PdfFreeTextAnnot

Field Summary

Fields inherited from class com.gnostice.pdfone.PdfAnnot

Fields inherited from interface com.gnostice.pdfone.Usable

Constructor Summary

Method Summary

Methods inherited from class com.gnostice.pdfone.PdfAnnot

Methods inherited from class java.lang.Object

Field Detail

ALIGNMENT_LEFT

ALIGNMENT_CENTER

ALIGNMENT_RIGHT

INTENT_FREETEXT_CALLOUT

INTENT_FREETEXT_TYPEWRITER

Constructor Detail

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

PdfFreeTextAnnot

Method Detail

clone

getAlignment

setAlignment

getCalloutLine

setCalloutLine

getIntent

setIntent

setTransparency

getTransparency

getPopup

setPopup

getDownAppearance

setDownAppearance

getNormalAppearance

setNormalAppearance

getRolloverAppearance

setRolloverAppearance