|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.lowagie.text.pdf.BaseField
Common field variables.
| Field Summary | |
static float |
BORDER_WIDTH_MEDIUM
A medium border with 2 point width. |
static float |
BORDER_WIDTH_THICK
A thick border with 3 point width. |
static float |
BORDER_WIDTH_THIN
A thin border with 1 point width. |
static int |
COMB
combo box flag. |
static int |
DO_NOT_SCROLL
The field will not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than will fit within its annotation rectangle. |
static int |
DO_NOT_SPELL_CHECK
The text entered in the field will not be spell-checked. |
static int |
EDIT
If set the combo box includes an editable text box as well as a drop list; if clear, it includes only a drop list. |
static int |
FILE_SELECTION
The text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field. |
static int |
HIDDEN
The field is hidden. |
static int |
HIDDEN_BUT_PRINTABLE
The field is hidden but is printable. |
static int |
MULTILINE
The field may contain multiple lines of text. |
static int |
PASSWORD
The field is intended for entering a secure password that should not be echoed visibly to the screen. |
static int |
READ_ONLY
The user may not change the value of the field. |
static int |
REQUIRED
The field must have a value at the time it is exported by a submit-form action. |
static int |
VISIBLE
The field is visible. |
static int |
VISIBLE_BUT_DOES_NOT_PRINT
The field is visible but does not print. |
| Constructor Summary | |
BaseField(PdfWriter writer,
Rectangle box,
String fieldName)
Creates a new TextField. |
|
| Method Summary | |
int |
getAlignment()
Gets the text horizontal alignment. |
Color |
getBackgroundColor()
Gets the background color. |
Color |
getBorderColor()
Gets the border color. |
int |
getBorderStyle()
Gets the border style. |
float |
getBorderWidth()
Gets the border width in points. |
Rectangle |
getBox()
Gets the field dimension and position. |
String |
getFieldName()
Gets the field name. |
BaseFont |
getFont()
Gets the text font. |
float |
getFontSize()
Gets the font size. |
int |
getMaxCharacterLength()
Gets the maximum length of the field's text, in characters. |
int |
getOptions()
Gets the option flags. |
int |
getRotation()
Gets the field rotation. |
String |
getText()
Gets the text. |
Color |
getTextColor()
Gets the text color. |
int |
getVisibility()
Gets the field visibility flag. |
PdfWriter |
getWriter()
Getter for property writer. |
static void |
moveFields(PdfDictionary from,
PdfDictionary to)
Moves the field keys from from to to. |
void |
setAlignment(int alignment)
Sets the text horizontal alignment. |
void |
setBackgroundColor(Color backgroundColor)
Sets the background color. |
void |
setBorderColor(Color borderColor)
Sets the border color. |
void |
setBorderStyle(int borderStyle)
Sets the border style. |
void |
setBorderWidth(float borderWidth)
Sets the border width in points. |
void |
setBox(Rectangle box)
Sets the field dimension and position. |
void |
setFieldName(String fieldName)
Sets the field name. |
void |
setFont(BaseFont font)
Sets the text font. |
void |
setFontSize(float fontSize)
Sets the font size. |
void |
setMaxCharacterLength(int maxCharacterLength)
Sets the maximum length of the field's text, in characters. |
void |
setOptions(int options)
Sets the option flags. |
void |
setRotation(int rotation)
Sets the field rotation. |
void |
setRotationFromPage(Rectangle page)
Convenience method to set the field rotation the same as the page rotation. |
void |
setText(String text)
Sets the text for text fields. |
void |
setTextColor(Color textColor)
Sets the text color. |
void |
setVisibility(int visibility)
Sets the field visibility flag. |
void |
setWriter(PdfWriter writer)
Setter for property writer. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final float BORDER_WIDTH_THIN
public static final float BORDER_WIDTH_MEDIUM
public static final float BORDER_WIDTH_THICK
public static final int VISIBLE
public static final int HIDDEN
public static final int VISIBLE_BUT_DOES_NOT_PRINT
public static final int HIDDEN_BUT_PRINTABLE
public static final int READ_ONLY
public static final int REQUIRED
public static final int MULTILINE
public static final int DO_NOT_SCROLL
public static final int PASSWORD
public static final int FILE_SELECTION
public static final int DO_NOT_SPELL_CHECK
EDIT flag set.
public static final int EDIT
public static final int COMB
| Constructor Detail |
public BaseField(PdfWriter writer,
Rectangle box,
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 float getBorderWidth()
public void setBorderWidth(float borderWidth)
null.
borderWidth - the border width in pointspublic int getBorderStyle()
public void setBorderStyle(int borderStyle)
PdfBorderDictionary
and can be STYLE_SOLID, STYLE_DASHED,
STYLE_BEVELED, STYLE_INSET and
STYLE_UNDERLINE.
borderStyle - the border stylepublic Color getBorderColor()
public void setBorderColor(Color borderColor)
null to remove
the border.
borderColor - the border colorpublic Color getBackgroundColor()
public void setBackgroundColor(Color backgroundColor)
null for
transparent background.
backgroundColor - the background colorpublic Color getTextColor()
public void setTextColor(Color textColor)
null the color used
will be black.
textColor - the text colorpublic BaseFont getFont()
public void setFont(BaseFont font)
null then Helvetica
will be used.
font - the text fontpublic float getFontSize()
public void setFontSize(float fontSize)
fontSize - the font sizepublic int getAlignment()
public void setAlignment(int alignment)
Element.ALIGN_LEFT,
Element.ALIGN_CENTER and Element.ALIGN_RIGHT.
alignment - the text horizontal alignmentpublic String getText()
public void setText(String text)
text - the textpublic Rectangle getBox()
public void setBox(Rectangle box)
box - the field dimension and positionpublic int getRotation()
public void setRotation(int rotation)
rotation - the field rotationpublic void setRotationFromPage(Rectangle page)
page - the pagepublic int getVisibility()
public void setVisibility(int visibility)
VISIBLE, HIDDEN, VISIBLE_BUT_DOES_NOT_PRINT
and HIDDEN_BUT_PRINTABLE.
visibility - field visibility flagpublic String getFieldName()
public void setFieldName(String fieldName)
fieldName - the field name. If null only the widget keys
will be included in the field allowing it to be used as a kid field.public int getOptions()
public void setOptions(int options)
READ_ONLY, REQUIRED,
MULTILINE, DO_NOT_SCROLL,
PASSWORD, FILE_SELECTION,
DO_NOT_SPELL_CHECK and EDIT.
options - the option flagspublic int getMaxCharacterLength()
public void setMaxCharacterLength(int maxCharacterLength)
maxCharacterLength - the maximum length of the field's text, in characterspublic PdfWriter getWriter()
public void setWriter(PdfWriter writer)
writer - New value of property writer.
public static void moveFields(PdfDictionary from,
PdfDictionary to)
from to to. The moved keys
are removed from from.
from - the sourceto - the destination. It may be null
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||