|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.BaseField
com.lowagie.text.pdf.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 | |
private String[] |
choiceExports
Holds value of property choiceExports. |
private String[] |
choices
Holds value of property choices. |
private int |
choiceSelection
Holds value of property choiceSelection. |
private String |
defaultText
Holds value of property defaultText. |
private float |
extraMarginLeft
|
private float |
extraMarginTop
|
private int |
topFirst
|
Fields inherited from class com.lowagie.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, options, PASSWORD, READ_ONLY, REQUIRED, rotation, text, textColor, visibility, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT, writer |
Constructor Summary | |
TextField(PdfWriter writer,
Rectangle box,
String fieldName)
Creates a new TextField . |
Method Summary | |
PdfAppearance |
getAppearance()
Gets the appearance for this TextField. |
String[] |
getChoiceExports()
Gets the export values in list/combo fields. |
protected PdfFormField |
getChoiceField(boolean isList)
|
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. |
PdfFormField |
getComboField()
Gets a new combo field. |
String |
getDefaultText()
Gets the default text. |
(package private) PdfAppearance |
getListAppearance()
|
PdfFormField |
getListField()
Gets a new list field. |
PdfFormField |
getTextField()
Gets a new text field. |
(package private) int |
getTopFirst()
|
void |
setChoiceExports(String[] choiceExports)
Sets the export values in list/combo fields. |
void |
setChoices(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 |
setDefaultText(String defaultText)
Sets the default text. |
void |
setExtraMargin(float extraMarginLeft,
float extraMarginTop)
Sets extra margins in text fields to better mimic the Acrobat layout. |
Methods inherited from class com.lowagie.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 |
Field Detail |
private String defaultText
private String[] choices
private String[] choiceExports
private int choiceSelection
private int topFirst
private float extraMarginLeft
private float extraMarginTop
Constructor Detail |
public TextField(PdfWriter writer, Rectangle box, String fieldName)
TextField
.
writer
- the document PdfWriter
box
- 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 PdfAppearance getAppearance() throws IOException, DocumentException
IOException
DocumentException
PdfAppearance getListAppearance() throws IOException, DocumentException
IOException
DocumentException
public PdfFormField getTextField() throws IOException, DocumentException
IOException
- on error
DocumentException
- on errorpublic PdfFormField getComboField() throws IOException, DocumentException
IOException
- on error
DocumentException
- on errorpublic PdfFormField getListField() throws IOException, DocumentException
IOException
- on error
DocumentException
- on errorprotected PdfFormField getChoiceField(boolean isList) throws IOException, DocumentException
IOException
DocumentException
public String getDefaultText()
public void setDefaultText(String defaultText)
defaultText
- the default textpublic String[] getChoices()
public void setChoices(String[] choices)
choices
- the choices to be presented to the userpublic String[] getChoiceExports()
public void setChoiceExports(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 void setChoiceSelection(int choiceSelection)
choiceSelection
- the zero based index of the selected itemint getTopFirst()
public void setExtraMargin(float extraMarginLeft, float extraMarginTop)
extraMarginLeft
- the extra marging leftextraMarginTop
- the extra margin top
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |