Gnostice PDFOne
Pro. Ed. v5.0.0


com.gnostice.pdfone
Class PdfFormTextField

java.lang.Object
  extended bycom.gnostice.pdfone.PdfAnnot
      extended bycom.gnostice.pdfone.PdfProAnnot
          extended bycom.gnostice.pdfone.PdfFormField
              extended bycom.gnostice.pdfone.PdfFormTextField
All Implemented Interfaces:
Cloneable, Usable

public class PdfFormTextField
extends PdfFormField

This class represents a text box form field.

// Create a PDF page
PdfPage page = new PdfPage();

// Create a text box form field
PdfFormTextField tf1 = new PdfFormTextField(
                         new PdfRect(300, 100, 100, 20),
                         "tf_name", 
                         PdfFormField.FLAG_REQUIRED, 
                         Color.BLACK, 
                         Color.YELLOW);
tf1.setBorderColor(Color.BLACK);
tf1.setValue("Enter name here");

// Add the form field to the page
page.addFormField(tf1);

page.writeText("Enter name", 225, 105);


Field Summary
static int FLAG_COMB
          Flag specifying that viewer applications will divide the text field into a number of boxes, each of which will accept only one character entered by the user.
static int FLAG_FILESELECT
          Flag specifying whether contents of the file whose pathname has been entered by the user in the text field will be submitted as the value of the field when the form is submitted.
static int FLAG_MULTILINE
          Flag specifying that viewer applications will be able to display multi-line text for the text field.
static int FLAG_NO_SCROLL
          Flag specifying that viewer applications will not display vertical scrollbars (for multi-line text) or horizontal scrollbars (for single-line text) when the value entered by the user on the text field goes beyond what can be accommodated within the width of the field.
static int FLAG_PASSWORD
          Flag specifying that viewer applications will masks characters entered by the user in the text field with asterisks or bullets.
static int FLAG_RICH_TEXT
          Flag specifying that viewer applications will display a rich text string for this text field.
 
Fields inherited from class com.gnostice.pdfone.PdfFormField
ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, BUTTON_STATE_OFF, BUTTON_STATE_ON, FLAG_CHOICE_COMMIT_ON_SEL_CHANGE, FLAG_CHOICE_MULTISELECT, FLAG_NO_EXPORT, FLAG_NO_SPELLCHECK, FLAG_NONE, FLAG_RADIO_IN_UNISON, FLAG_RADIO_NO_TOGGLE_TO_OFF, FLAG_READONLY, FLAG_REQUIRED, FLAG_SUBMIT_TYPE_FDF, HIGHLIGHT_MODE_INVERT, HIGHLIGHT_MODE_NONE, HIGHLIGHT_MODE_OUTLINE, HIGHLIGHT_MODE_PUSH, HIGHLIGHT_MODE_TOGGLE, ROTATION_0, ROTATION_180, ROTATION_270, ROTATION_90, SUBMIT_ACTION_TYPE_FDF, SUBMIT_ACTION_TYPE_HTML_POST, SUBMIT_ACTION_TYPE_XFDF, TYPE_CHECKGROUP, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_PUSHBUTTON, TYPE_RADIOGROUP, TYPE_SIGNATURE, TYPE_TEXTFIELD
 
Fields inherited from class com.gnostice.pdfone.PdfAnnot
ANNOT_TYPE_CARET, ANNOT_TYPE_CIRCLE, ANNOT_TYPE_FILE_ATTACHMENT, ANNOT_TYPE_FREE_TEXT, ANNOT_TYPE_INK, ANNOT_TYPE_LINE, ANNOT_TYPE_LINK, ANNOT_TYPE_MARKUP, ANNOT_TYPE_POLYGON, ANNOT_TYPE_POLYLINE, ANNOT_TYPE_POPUP, ANNOT_TYPE_SQUARE, ANNOT_TYPE_STAMP, ANNOT_TYPE_TEXT, ANNOT_TYPE_WATERMARK, BORDERSTYLE_BEVELED, BORDERSTYLE_DASHED, BORDERSTYLE_INSET, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINT, FLAG_TOGGLE_NO_VIEW
 
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_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_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWIDTH, 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_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
PdfFormTextField(PdfRect rect)
          Constructs a new text field with specified bounding box.
PdfFormTextField(PdfRect r, String name)
          Constructs a new text field with specified bounding box and name.
PdfFormTextField(PdfRect r, String name, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified bounding box, name, border color, and background color.
PdfFormTextField(PdfRect r, String name, int fieldFlags)
          Constructs a new text field with specified bounding box, name, and flags.
PdfFormTextField(PdfRect r, String name, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified bounding box, name, flags, border color, and background color.
PdfFormTextField(PdfRect r, String name, String alternateName, String mappingName)
          Constructs a new text field with specified bounding box, name, alternate name, and mapping name.
PdfFormTextField(PdfRect r, String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified bounding box, name, alternate name, mapping name, border color, and background color.
PdfFormTextField(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags)
          Constructs a new text field with specified bounding box, name, alternate name, mapping name, and flags.
PdfFormTextField(PdfRect r, String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.
PdfFormTextField(String name)
          Constructs a new text field with specified name.
PdfFormTextField(String name, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified name, border color, and background color.
PdfFormTextField(String name, int fieldFlags)
          Constructs a new text field with specified name and flags.
PdfFormTextField(String name, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified name, flags, border color, and background color.
PdfFormTextField(String name, String alternateName, String mappingName)
          Constructs a new text field with specified name, alternate name, and mapping name.
PdfFormTextField(String name, String alternateName, String mappingName, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified name, alternate name, mapping name, border color, and background color.
PdfFormTextField(String name, String alternateName, String mappingName, int fieldFlags)
          Constructs a new text field with specified name, alternate name, mapping name, and flags.
PdfFormTextField(String name, String alternateName, String mappingName, int fieldFlags, Color borderColor, Color backgroundColor)
          Constructs a new text field with specified name, alternate name, mapping name, flags, border color, and background color.
 
Method Summary
 Object clone()
           
 int getAlignment()
          Returns how text is aligned inside the text field.
 int getMaxlen()
          Return maximum number of characters that the user can enter in the text field on a viewer application.
 String getValue()
          Returns value that is displayed by the text field on a viewer application.
 boolean isAutoAdjustTextHeight()
          Returns whether the font size of text inside the field will be adjusted by the viewer application in real time so that the text entered by the users will be fully accommodated inside the field without any cropping.
 boolean isComb()
          Returns whether the FLAG_COMB flag has been set for this text field.
 boolean isFileSelect()
          Returns whether the FLAG_FILESELECT flag has been set for this text field.
 boolean isMultiline()
          Returns whether the FLAG_MULTILINE flag has been set for this text field.
 boolean isNoScroll()
          Returns whether the FLAG_NO_SCROLL flag has been set for this text field.
 boolean isPasswordField()
          Returns whether the FLAG_PASSWORD flag has been set for this text field.
 boolean isRichText()
          Returns whether the FLAG_RICH_TEXT flag has been set for this text field.
 void setAlignment(int alignment)
          Specifies how text needs to be aligned inside the text field.
 void setAsFileSelectField(boolean fileSelect)
          Specifies whether the FLAG_FILESELECT flag needs to be set for this text field.
 void setAsPasswordField(boolean passwordField)
          Specifies whether the FLAG_PASSWORD flag needs to be set for this text field.
 void setAutoAdjustTextHeight(boolean autoAdjustFieldTextHeight)
          Specifies whether the font size of text inside the field needs to be adjusted by the viewer application in real time so that the text entered by the users will be fully accommodated inside the field without any cropping.
 void setComb(boolean comb)
          Specifies whether the FLAG_COMB flag needs to be set for this text field.
 void setMaxlen(int maxlen)
          Return maximum number of characters that the user needs to be allowed to enter in the text field on a viewer application.
 void setMultiline(boolean multiline)
          Specifies whether the FLAG_MULTILINE flag needs to be set for this text field.
 void setNoScroll(boolean noScroll)
          Specifies whether the FLAG_NO_SCROLL flag needs to be set for this text field.
 void setRichText(boolean richText)
          Specifies whether the FLAG_RICH_TEXT flag needs to be set for this text field.
 void setValue(String value)
          Specifies value that needs to be displayed by the text field on a viewer application.
 
Methods inherited from class com.gnostice.pdfone.PdfFormField
addAction, addAction, addAction, addActionFormReset, addActionFormReset, addActionFormReset, addActionFormSubmit, addActionFormSubmit, addActionFormSubmit, addActionImportData, addChildField, flatten, flatten, getAlternateName, getBackgroundColor, getBorderColor, getCheckGroupItems, getCheckGroupSelectedIndices, getCheckGroupSelectedValues, getChildCount, getChildList, getDefaultValue, getDownAppearance, getFieldFlags, getFont, getFullyQualifiedName, getMappingName, getName, getNormalAppearance, getPopup, getRadioGroupSelectedIndices, getRadioGroupSelectedValues, getRolloverAppearance, getRotation, getType, isFlattened, isNameAsUnicode, isNoExport, isNoSpellCheck, isRadioInUnison, isRadioNoToggleToOff, isReadOnly, isRequired, setAlternateName, setBackgroundColor, setBorderColor, setDefaultValue, setDownAppearance, setFieldFlags, setFont, setIncludeNoValueFieldsOnSubmit, setMappingName, setName, setNameAsUnicode, setNoExport, setNormalAppearance, setNoSpellCheck, setParentAsNull, setPopup, setRadioInUnison, setRadioNoToggleToOff, setReadOnly, setRequired, setRolloverAppearance, setRotation, setSubmitActionType, setType
 
Methods inherited from class com.gnostice.pdfone.PdfAnnot
delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, 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

FLAG_MULTILINE

public static final int FLAG_MULTILINE
Flag specifying that viewer applications will be able to display multi-line text for the text field. If switched off, viewer applications will display the form field's value in a single line.

See Also:
Constant Field Values

FLAG_PASSWORD

public static final int FLAG_PASSWORD
Flag specifying that viewer applications will masks characters entered by the user in the text field with asterisks or bullets.

See Also:
Constant Field Values

FLAG_FILESELECT

public static final int FLAG_FILESELECT
Flag specifying whether contents of the file whose pathname has been entered by the user in the text field will be submitted as the value of the field when the form is submitted.

See Also:
Constant Field Values

FLAG_NO_SCROLL

public static final int FLAG_NO_SCROLL
Flag specifying that viewer applications will not display vertical scrollbars (for multi-line text) or horizontal scrollbars (for single-line text) when the value entered by the user on the text field goes beyond what can be accommodated within the width of the field.

See Also:
Constant Field Values

FLAG_COMB

public static final int FLAG_COMB
Flag specifying that viewer applications will divide the text field into a number of boxes, each of which will accept only one character entered by the user. This flag is useful only if FLAG_MULTILINE, FLAG_PASSWORD, and FLAG_FILESELECT are not set and the maximum length of the text field has been specified. If user input is required only in one row, then the FLAG_NO_SCROLL needs to be set.

See Also:
Constant Field Values

FLAG_RICH_TEXT

public static final int FLAG_RICH_TEXT
Flag specifying that viewer applications will display a rich text string for this text field.

See Also:
Constant Field Values
Constructor Detail

PdfFormTextField

public PdfFormTextField(String name,
                        int fieldFlags)
Constructs a new text field with specified name and flags.

Parameters:
name - name of the text field in the document
fieldFlags - text field flags
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        String alternateName,
                        String mappingName,
                        int fieldFlags)
Constructs a new text field with specified name, alternate name, mapping name, and flags.

Parameters:
name - name for the text field in the document
alternateName - alternate name for the text field
mappingName - mapping name for the text field
fieldFlags - text field flags
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        String alternateName,
                        String mappingName)
Constructs a new text field with specified name, alternate name, and mapping name.

Parameters:
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name)
Constructs a new text field with specified name.

Parameters:
name - name for the text field in the document
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect rect)
Constructs a new text field with specified bounding box.

Parameters:
rect - bounding box of the text field

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        int fieldFlags)
Constructs a new text field with specified bounding box, name, and flags.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
fieldFlags - text field flags
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name)
Constructs a new text field with specified bounding box and name.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        String alternateName,
                        String mappingName,
                        int fieldFlags)
Constructs a new text field with specified bounding box, name, alternate name, mapping name, and flags.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
alternateName - alternate name for the text field
mappingName - mapping name for the text field
fieldFlags - text field flags
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        String alternateName,
                        String mappingName)
Constructs a new text field with specified bounding box, name, alternate name, and mapping name.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        int fieldFlags,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified name, flags, border color, and background color.

Parameters:
name - name for the text field in the document
fieldFlags - text field flags
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        String alternateName,
                        String mappingName,
                        int fieldFlags,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified name, alternate name, mapping name, flags, border color, and background color.

Parameters:
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
fieldFlags - text field flags
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        String alternateName,
                        String mappingName,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified name, alternate name, mapping name, border color, and background color.

Parameters:
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(String name,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified name, border color, and background color.

Parameters:
name - name for the text field in the document
borderColor - border color for the text field
backgroundColor - background color for the text field

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        int fieldFlags,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified bounding box, name, flags, border color, and background color.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
fieldFlags - text field flags
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified bounding box, name, border color, and background color.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
borderColor - border color of the text field
backgroundColor - background color of the text field

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        String alternateName,
                        String mappingName,
                        int fieldFlags,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified bounding box, name, alternate name, mapping name, flags, border color, and background color.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
fieldFlags - text field flags
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField

PdfFormTextField

public PdfFormTextField(PdfRect r,
                        String name,
                        String alternateName,
                        String mappingName,
                        Color borderColor,
                        Color backgroundColor)
Constructs a new text field with specified bounding box, name, alternate name, mapping name, border color, and background color.

Parameters:
r - bounding box of the text field
name - name for the text field in the document
alternateName - alternate name for the text field in the document
mappingName - mapping name for the text field in the document
borderColor - border color of the text field
backgroundColor - background color of the text field
See Also:
PdfFormField
Method Detail

clone

public Object clone()
Overrides:
clone in class PdfFormField

isMultiline

public boolean isMultiline()
Returns whether the FLAG_MULTILINE flag has been set for this text field.

Returns:
whether the FLAG_MULTILINE flag has been set for this text field
See Also:
setMultiline(boolean)

setMultiline

public void setMultiline(boolean multiline)
Specifies whether the FLAG_MULTILINE flag needs to be set for this text field.

Parameters:
multiline - whether the FLAG_MULTILINE flag needs to be set
See Also:
isMultiline()

isPasswordField

public boolean isPasswordField()
Returns whether the FLAG_PASSWORD flag has been set for this text field.

Returns:
whether the FLAG_PASSWORD flag has been set
See Also:
setAsPasswordField(boolean)

setAsPasswordField

public void setAsPasswordField(boolean passwordField)
Specifies whether the FLAG_PASSWORD flag needs to be set for this text field.

Parameters:
passwordField - whether the FLAG_PASSWORD flag needs to be set
See Also:
isPasswordField()

isFileSelect

public boolean isFileSelect()
Returns whether the FLAG_FILESELECT flag has been set for this text field.

Returns:
whether the FLAG_FILESELECT flag has been set
See Also:
setAsFileSelectField(boolean)

setAsFileSelectField

public void setAsFileSelectField(boolean fileSelect)
Specifies whether the FLAG_FILESELECT flag needs to be set for this text field.

Parameters:
fileSelect - whether the FLAG_FILESELECT flag needs to be set for this text field
See Also:
isFileSelect()

isNoScroll

public boolean isNoScroll()
Returns whether the FLAG_NO_SCROLL flag has been set for this text field.

Returns:
whether the FLAG_NO_SCROLL flag has been set
See Also:
setNoScroll(boolean)

setNoScroll

public void setNoScroll(boolean noScroll)
Specifies whether the FLAG_NO_SCROLL flag needs to be set for this text field.

Parameters:
noScroll - whether the FLAG_NO_SCROLL flag needs to be set
See Also:
isNoScroll()

isComb

public boolean isComb()
Returns whether the FLAG_COMB flag has been set for this text field.

Returns:
whether the FLAG_COMB flag has been set
See Also:
setComb(boolean)

setComb

public void setComb(boolean comb)
Specifies whether the FLAG_COMB flag needs to be set for this text field.

Parameters:
comb - whether the FLAG_COMB flag needs to be set for this text field.
See Also:
isComb()

isRichText

public boolean isRichText()
Returns whether the FLAG_RICH_TEXT flag has been set for this text field.

Returns:
whether the FLAG_RICH_TEXT flag has been set
See Also:
setRichText(boolean)

setRichText

public void setRichText(boolean richText)
Specifies whether the FLAG_RICH_TEXT flag needs to be set for this text field.

Parameters:
richText - whether the FLAG_RICH_TEXT flag needs to be set
See Also:
isRichText()

isAutoAdjustTextHeight

public boolean isAutoAdjustTextHeight()
Returns whether the font size of text inside the field will be adjusted by the viewer application in real time so that the text entered by the users will be fully accommodated inside the field without any cropping.

Returns:
whether viewer application will adjust the font size of the value displayed in the text field
See Also:
setAutoAdjustTextHeight(boolean)

setAutoAdjustTextHeight

public void setAutoAdjustTextHeight(boolean autoAdjustFieldTextHeight)
Specifies whether the font size of text inside the field needs to be adjusted by the viewer application in real time so that the text entered by the users will be fully accommodated inside the field without any cropping.

Parameters:
autoAdjustFieldTextHeight - whether viewer application needs to adjust the font size of the value displayed in the text field
See Also:
isAutoAdjustTextHeight()

getAlignment

public int getAlignment()
Returns how text is aligned inside the text field.

Returns:
constant specifying how text is aligned inside the text field

setAlignment

public void setAlignment(int alignment)
Specifies how text needs to be aligned inside the text field.

Parameters:
alignment - constant how text needs to be aligned inside the text field

getMaxlen

public int getMaxlen()
Return maximum number of characters that the user can enter in the text field on a viewer application.

Returns:
maximum number of characters that the user can enter in the text field on a viewer application
See Also:
FLAG_COMB

setMaxlen

public void setMaxlen(int maxlen)
Return maximum number of characters that the user needs to be allowed to enter in the text field on a viewer application.

Parameters:
maxlen - maximum number of characters that the user needs to be allowed to enter in the text field on a viewer application
See Also:
FLAG_COMB

getValue

public String getValue()
Returns value that is displayed by the text field on a viewer application.

Overrides:
getValue in class PdfFormField
Returns:
value that is displayed by the text field on a viewer application
See Also:
setValue(String)

setValue

public void setValue(String value)
Specifies value that needs to be displayed by the text field on a viewer application.

Overrides:
setValue in class PdfFormField
Parameters:
value - that needs to be displayed by the text field on a viewer application
See Also:
getValue()

Gnostice PDFOne
Pro. Ed. v5.0.0

To contact our support team, send an e-mail to support@gnostice.com.
 
© 2010 Gnostice Information Technologies Private Limited. All rights reserved.
www.gnostice.com