|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.itextpdf.text.pdf.BaseField
com.itextpdf.text.pdf.TextField
public class TextField
Supports text, combo and list fields generating the correct appearances. All the option in the Acrobat GUI are supported in an easy to use API.
| Field Summary |
|---|
| Fields inherited from class com.itextpdf.text.pdf.BaseField |
|---|
alignment, backgroundColor, BORDER_WIDTH_MEDIUM, BORDER_WIDTH_THICK, BORDER_WIDTH_THIN, borderColor, borderStyle, borderWidth, box, COMB, DO_NOT_SCROLL, DO_NOT_SPELL_CHECK, EDIT, fieldName, FILE_SELECTION, font, fontSize, HIDDEN, HIDDEN_BUT_PRINTABLE, maxCharacterLength, MULTILINE, MULTISELECT, options, PASSWORD, READ_ONLY, REQUIRED, rotation, text, textColor, visibility, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT, writer |
| Constructor Summary | |
|---|---|
TextField(PdfWriter writer,
Rectangle box,
java.lang.String fieldName)
Creates a new TextField. |
|
| Method Summary | |
|---|---|
void |
addChoiceSelection(int selection)
adds another (or a first I suppose) selection to a MULTISELECT list. |
PdfAppearance |
getAppearance()
Get the PdfAppearance of a text or combo field |
java.lang.String[] |
getChoiceExports()
Gets the export values in list/combo fields. |
protected PdfFormField |
getChoiceField(boolean isList)
|
java.lang.String[] |
getChoices()
Gets the choices to be presented to the user in list/combo fields. |
int |
getChoiceSelection()
Gets the zero based index of the selected item. |
java.util.ArrayList<java.lang.Integer> |
getChoiceSelections()
Gets the selected items. |
PdfFormField |
getComboField()
Gets a new combo field. |
java.lang.String |
getDefaultText()
Gets the default text. |
BaseFont |
getExtensionFont()
Gets the extensionFont. |
PdfFormField |
getListField()
Gets a new list field. |
java.util.ArrayList<BaseFont> |
getSubstitutionFonts()
Gets the list of substitution fonts. |
PdfFormField |
getTextField()
Gets a new text field. |
static java.lang.String |
obfuscatePassword(java.lang.String text)
Obfuscates a password String. |
static java.lang.String |
removeCRLF(java.lang.String text)
Removes CRLF from a String. |
void |
setChoiceExports(java.lang.String[] choiceExports)
Sets the export values in list/combo fields. |
void |
setChoices(java.lang.String[] choices)
Sets the choices to be presented to the user in list/combo fields. |
void |
setChoiceSelection(int choiceSelection)
Sets the zero based index of the selected item. |
void |
setChoiceSelections(java.util.ArrayList<java.lang.Integer> selections)
replaces the existing selections with the param. |
void |
setDefaultText(java.lang.String defaultText)
Sets the default text. |
void |
setExtensionFont(BaseFont extensionFont)
Sets the extensionFont. |
void |
setExtraMargin(float extraMarginLeft,
float extraMarginTop)
Sets extra margins in text fields to better mimic the Acrobat layout. |
void |
setSubstitutionFonts(java.util.ArrayList<BaseFont> substitutionFonts)
Sets a list of substitution fonts. |
| Methods inherited from class com.itextpdf.text.pdf.BaseField |
|---|
breakLines, getAlignment, getBackgroundColor, getBorderAppearance, getBorderColor, getBorderStyle, getBorderWidth, getBox, getFieldName, getFont, getFontSize, getHardBreaks, getMaxCharacterLength, getOptions, getRealFont, getRotation, getText, getTextColor, getVisibility, getWriter, moveFields, setAlignment, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setBox, setFieldName, setFont, setFontSize, setMaxCharacterLength, setOptions, setRotation, setRotationFromPage, setText, setTextColor, setVisibility, setWriter, trimRight |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TextField(PdfWriter writer,
Rectangle box,
java.lang.String fieldName)
TextField.
writer - the document PdfWriterbox - the field location and dimensionsfieldName - the field name. If null only the widget keys
will be included in the field allowing it to be used as a kid field.| Method Detail |
|---|
public static java.lang.String removeCRLF(java.lang.String text)
String.
text -
public static java.lang.String obfuscatePassword(java.lang.String text)
String.
Every character is replaced by an asterisk (*).
text -
public PdfAppearance getAppearance()
throws java.io.IOException,
DocumentException
PdfAppearance of a text or combo field
PdfAppearance
java.io.IOException - on error
DocumentException - on error
public PdfFormField getTextField()
throws java.io.IOException,
DocumentException
java.io.IOException - on error
DocumentException - on error
public PdfFormField getComboField()
throws java.io.IOException,
DocumentException
java.io.IOException - on error
DocumentException - on error
public PdfFormField getListField()
throws java.io.IOException,
DocumentException
java.io.IOException - on error
DocumentException - on error
protected PdfFormField getChoiceField(boolean isList)
throws java.io.IOException,
DocumentException
java.io.IOException
DocumentExceptionpublic java.lang.String getDefaultText()
public void setDefaultText(java.lang.String defaultText)
defaultText - the default textpublic java.lang.String[] getChoices()
public void setChoices(java.lang.String[] choices)
choices - the choices to be presented to the userpublic java.lang.String[] getChoiceExports()
public void setChoiceExports(java.lang.String[] choiceExports)
null then the choice values will also be used
as the export values.
choiceExports - the export values in list/combo fieldspublic int getChoiceSelection()
public java.util.ArrayList<java.lang.Integer> getChoiceSelections()
public void setChoiceSelection(int choiceSelection)
choiceSelection - the zero based index of the selected itempublic void addChoiceSelection(int selection)
selection - new selectionpublic void setChoiceSelections(java.util.ArrayList<java.lang.Integer> selections)
selections - new selections. If null, it clear()s the underlying ArrayList.
public void setExtraMargin(float extraMarginLeft,
float extraMarginTop)
extraMarginLeft - the extra margin leftextraMarginTop - the extra margin toppublic java.util.ArrayList<BaseFont> getSubstitutionFonts()
BaseFont and can be null. The fonts in this list will be used if the original
font doesn't contain the needed glyphs.
public void setSubstitutionFonts(java.util.ArrayList<BaseFont> substitutionFonts)
BaseFont and can also be null. The fonts in this list will be used if the original
font doesn't contain the needed glyphs.
substitutionFonts - the listpublic BaseFont getExtensionFont()
null.
public void setExtensionFont(BaseFont extensionFont)
null.
extensionFont - New value of property extensionFont.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||