public abstract class BaseField extends Object
Modifier and Type | Field and Description |
---|---|
protected int |
alignment |
protected BaseColor |
backgroundColor |
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.
|
protected BaseColor |
borderColor |
protected int |
borderStyle |
protected float |
borderWidth |
protected Rectangle |
box |
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.
|
protected String |
fieldName
Holds value of property fieldName.
|
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.
|
protected BaseFont |
font |
protected float |
fontSize |
static int |
HIDDEN
The field is hidden.
|
static int |
HIDDEN_BUT_PRINTABLE
The field is hidden but is printable.
|
protected int |
maxCharacterLength
Holds value of property maxCharacterLength.
|
static int |
MULTILINE
The field may contain multiple lines of text.
|
static int |
MULTISELECT
whether or not a list may have multiple selections.
|
protected int |
options
Holds value of property options.
|
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.
|
protected int |
rotation
Holds value of property rotation.
|
protected String |
text |
protected BaseColor |
textColor |
protected int |
visibility
Holds value of property visibility.
|
static int |
VISIBLE
The field is visible.
|
static int |
VISIBLE_BUT_DOES_NOT_PRINT
The field is visible but does not print.
|
protected PdfWriter |
writer |
Constructor and Description |
---|
BaseField(PdfWriter writer, Rectangle box, String fieldName)
Creates a new TextField .
|
Modifier and Type | Method and Description |
---|---|
protected static ArrayList<String> |
breakLines(ArrayList<String> breaks, BaseFont font, float fontSize, float width) |
int |
getAlignment()
Gets the text horizontal alignment.
|
BaseColor |
getBackgroundColor()
Gets the background color.
|
protected PdfAppearance |
getBorderAppearance() |
BaseColor |
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.
|
protected static ArrayList<String> |
getHardBreaks(String text) |
int |
getMaxCharacterLength()
Gets the maximum length of the field's text, in characters.
|
int |
getOptions()
Gets the option flags.
|
protected BaseFont |
getRealFont() |
int |
getRotation()
Gets the field rotation.
|
String |
getText()
Gets the text.
|
BaseColor |
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(BaseColor backgroundColor)
Sets the background color.
|
void |
setBorderColor(BaseColor 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(BaseColor textColor)
Sets the text color.
|
void |
setVisibility(int visibility)
Sets the field visibility flag.
|
void |
setWriter(PdfWriter writer)
Setter for property writer.
|
protected static void |
trimRight(StringBuffer buf) |
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 MULTISELECT
public static final int COMB
protected float borderWidth
protected int borderStyle
protected BaseColor borderColor
protected BaseColor backgroundColor
protected BaseColor textColor
protected BaseFont font
protected float fontSize
protected int alignment
protected PdfWriter writer
protected String text
protected Rectangle box
protected int rotation
protected int visibility
protected String fieldName
protected int options
protected int maxCharacterLength
public BaseField(PdfWriter writer, Rectangle box, String fieldName)
TextField
.
writer
- the document PdfWriter
box
- the field location and dimensions
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.
protected BaseFont getRealFont() throws IOException, DocumentException
IOException
DocumentException
protected PdfAppearance getBorderAppearance()
protected static void trimRight(StringBuffer buf)
protected static ArrayList<String> breakLines(ArrayList<String> breaks, BaseFont font, float fontSize, float width)
public float getBorderWidth()
public void setBorderWidth(float borderWidth)
null
.
borderWidth
- the border width in points
public 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 style
public BaseColor getBorderColor()
public void setBorderColor(BaseColor borderColor)
null
to remove the border.
borderColor
- the border color
public BaseColor getBackgroundColor()
public void setBackgroundColor(BaseColor backgroundColor)
null
for transparent background.
backgroundColor
- the background color
public BaseColor getTextColor()
public void setTextColor(BaseColor textColor)
null
the color used will be black.
textColor
- the text color
public BaseFont getFont()
public void setFont(BaseFont font)
null
then Helvetica will be used.
font
- the text font
public float getFontSize()
public void setFontSize(float fontSize)
fontSize
- the font size
public int getAlignment()
public void setAlignment(int alignment)
Element.ALIGN_LEFT
, Element.ALIGN_CENTER
and Element.ALIGN_RIGHT
.
alignment
- the text horizontal alignment
public String getText()
public void setText(String text)
text
- the text
public Rectangle getBox()
public void setBox(Rectangle box)
box
- the field dimension and position
public int getRotation()
public void setRotation(int rotation)
rotation
- the field rotation
public void setRotationFromPage(Rectangle page)
page
- the page
public int getVisibility()
public void setVisibility(int visibility)
VISIBLE
, HIDDEN
, VISIBLE_BUT_DOES_NOT_PRINT
and HIDDEN_BUT_PRINTABLE
.
visibility
- field visibility flag
public 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 flags
public int getMaxCharacterLength()
public void setMaxCharacterLength(int maxCharacterLength)
maxCharacterLength
- the maximum length of the field's text, in characters
public 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 source
to
- the destination. It may be null
Copyright © 2016. All rights reserved.