|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.cete.dynamicpdf.PageElement com.cete.dynamicpdf.pageelements.TaggablePageElement com.cete.dynamicpdf.pageelements.forms.FormElement com.cete.dynamicpdf.pageelements.forms.TextField
public class TextField
Represents the text field of a interactive forms.
Text fields are boxes or spaces in which the user can enter text from the keyboard.
NOTE: This page element cannot be used within a table cell, or tranformation group.
Licensing:
This class is a DynamicPDF Generator Enterprise Edition
feature. One of the following licenses is required for non-evaluation usage:
Constructor Summary | |
---|---|
TextField(java.lang.String name,
float x,
float y,
float width,
float height)
Creates a new instance of TextField class. |
Method Summary | |
---|---|
void |
draw(PageWriter writer)
Draws the text field to the given PageWriter object. |
java.lang.String |
getDefaultValue()
Gets the text field's default value. |
Font |
getFont()
Gets the font of the field. |
float |
getFontSize()
Gets the font size of the field. |
int |
getMaxLength()
Gets the maximum length of characters in a text field. |
boolean |
isMultiLine()
Gets the text field multiline status. |
boolean |
isNoExport()
Gets the export state for the field. |
boolean |
isPassword()
Gets the text field password flag status. |
boolean |
isRequired()
Gets the value specifying the required state of the field. |
void |
setAlign(Align align)
Sets the text align. |
void |
setDefaultValue(java.lang.String defaultValue)
Sets the text field's default value. |
void |
setFont(Font font)
Sets the font for the field. |
void |
setFontSize(float fontSize)
Sets the font size for the field. |
void |
setMaxLength(int length)
Sets the maximum length of characters in a text field. |
void |
setMultiLine(boolean value)
Sets the text field to contain multiple lines. |
void |
setNoExport(boolean value)
Sets the export state for the field. |
void |
setPassword(boolean value)
Sets the text field intended for entering a secure password that should not be echoed visibly to the screen. |
void |
setRequired(boolean value)
Sets the required state for the field. |
Methods inherited from class com.cete.dynamicpdf.pageelements.forms.FormElement |
---|
getBackgroundColor, getBorderColor, getBorderStyle, getHeight, getMappingName, getName, getOutput, getReaderEvents, getRotate, getTextColor, getToolTip, getWidth, getX, getY, isPrintable, isReadOnly, isVisible, setBackgroundColor, setBorderColor, setBorderStyle, setHeight, setMappingName, setName, setOutput, setPrintable, setReadOnly, setRotate, setTag, setTextColor, setToolTip, setVisible, setWidth, setX, setY |
Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement |
---|
getTag, getTagOrder, setTagOrder |
Methods inherited from class com.cete.dynamicpdf.PageElement |
---|
getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TextField(java.lang.String name, float x, float y, float width, float height)
TextField
class.
name
- Name of a text field.x
- X coordinate of a text field.y
- Y coordinate of a text field.width
- Width of a text field.height
- Height of a text field.Method Detail |
---|
public void setFont(Font font)
font
- the font for the field.public Font getFont()
public void setFontSize(float fontSize)
fontSize
- the font size for the field.public float getFontSize()
public java.lang.String getDefaultValue()
public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- the text field's default value.public int getMaxLength()
public void setMaxLength(int length)
length
- the maximum length of characters in a text field.public void setAlign(Align align)
public void setPassword(boolean value)
value
- password of the field.public boolean isPassword()
public void setMultiLine(boolean value)
If set, the field may contain multiple lines of text; if clear, the field�s text is restricted to a single line.
value
- the multi line property of the field.public boolean isMultiLine()
public boolean isRequired()
public void setRequired(boolean value)
If set, the field must have a value at the time it is exported by a submit-form action.
value
- the required state for the field.public boolean isNoExport()
public void setNoExport(boolean value)
If set, the field will not be exported by a submit-form action.
value
- the export state for the field.public void draw(PageWriter writer)
PageWriter
object.
draw
in class TaggablePageElement
GeneratorException
- If Form Field with the same name already exist.writer
- PageWriter
object to receive the text field's output.PageWriter
|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |