com.qoppa.pdf.form

Interface TextField

All Superinterfaces:

FormField

public interface TextField
extends FormField

TextField holds a text field.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	FF_COMB The field flag indicating the field is combed.
static int	FF_DONOTSCROLL The field flag indicating the field does not scroll.
static int	FF_DONOTSPELLCHECK The field flag indicating the field is not spell checked.
static int	FF_FILESELECT The field flag indicating the field contains a file path.
static int	FF_MULTILINE The field flag indicating the field can have multiple lines.
static int	FF_PASSWORD The field flag indicating the field contains a password.
static int	FF_RICHTEXT The field flag indicating the field contains rich text.

Fields inherited from interface com.qoppa.pdf.form.FormField

FF_NOEXPORT, FF_READONLY, FF_REQUIRED, TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_RADIOBUTTON, TYPE_SIGNATURE, TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Returns the default value for this text field.
int	getHorzTextAlign() Returns the horizontal text alignment property for this field.
int	getMaxLength() Returns the maximum number of characters allowed for this text field.
String	getRichValue() Returns the rich value of the text field when rich text is enabled, or null if rich text is not enabled.
String	getValue() Returns the plain text value of the text field.
boolean	isMultiLine() Returns true if the 'Multi-Line' flag is on for this text field.
boolean	isRichText() Returns true if the 'Rich Text' flag is on for this field.
void	setDefaultValue(String defaultValue) Sets the default value for this text field.
void	setHorzTextAlign(int justify) Sets the text alignment for this field.
void	setMaxLen(int maxLen) Sets the maximum number of characters allowed in this text field.
void	setRichValue(String richValue) Sets the rich value for this text field if rich text is enabled.
void	setValue(String value) Sets the value for this text field.

Methods inherited from interface com.qoppa.pdf.form.FormField

addFieldListener, addKeyListener, addMouseListener, flattenField, getAltFieldName, getFieldFlags, getFieldName, getFieldTypeDesc, getFullFieldName, getKids, getMapFieldName, getTriggerActions, getUserName, getWidgets, isEmpty, isNoExport, isReadOnly, isRequired, removeFieldListener, reset, setAltFieldName, setComponentVisible, setFieldFlags, setFieldName, setHidden, setMapFieldName, setNoExport, setPrintable, setReadOnly, setRequired, setTriggerActions, setUserName

Field Detail

FF_MULTILINE

static final int FF_MULTILINE

The field flag indicating the field can have multiple lines.

See Also:

Constant Field Values

FF_PASSWORD

static final int FF_PASSWORD

The field flag indicating the field contains a password.

See Also:

Constant Field Values

FF_FILESELECT

static final int FF_FILESELECT

The field flag indicating the field contains a file path.

See Also:

Constant Field Values

FF_DONOTSPELLCHECK

static final int FF_DONOTSPELLCHECK

The field flag indicating the field is not spell checked.

See Also:

Constant Field Values

FF_DONOTSCROLL

static final int FF_DONOTSCROLL

The field flag indicating the field does not scroll.

See Also:

Constant Field Values

FF_COMB

static final int FF_COMB

The field flag indicating the field is combed.

See Also:

Constant Field Values

FF_RICHTEXT

static final int FF_RICHTEXT

The field flag indicating the field contains rich text.

See Also:

Constant Field Values

Method Detail

getDefaultValue

String getDefaultValue()

Returns the default value for this text field.

Returns:

The default value of the field

getMaxLength

int getMaxLength()

Returns the maximum number of characters allowed for this text field.

Returns:

the max length

getValue

String getValue()

Returns the plain text value of the text field.

Returns:

The plain text value of the field

See Also:

getRichValue()

getRichValue

String getRichValue()

Returns the rich value of the text field when rich text is enabled, or null if rich text is not enabled.

Returns:

the rich value of the text field when rich text is enabled, or null if rich text is not enabled.

isMultiLine

boolean isMultiLine()

Returns true if the 'Multi-Line' flag is on for this text field. Returns false if the flag is off. The 'Multi-Line' flag controls wether users are allowed to type-in multi lines in the field.

Returns:

true or false

isRichText

boolean isRichText()

Returns true if the 'Rich Text' flag is on for this field. Returns false if the flag is off. The 'Rich Text' flag indicates the value of this field should be represented as a rich text string and the RV entry of the field dictionary specifies the rich text string.

Returns:

true or false

setValue

void setValue(String value)
       throws PDFException

Sets the value for this text field.

Parameters:

value - the new value.

Throws:

PDFException

setRichValue

void setRichValue(String richValue)
           throws PDFException

Sets the rich value for this text field if rich text is enabled.

Parameters:

richValue - the new rich value.

Throws:

PDFException

setDefaultValue

void setDefaultValue(String defaultValue)

Sets the default value for this text field.

Parameters:

defaultValue - the new default value.

setMaxLen

void setMaxLen(int maxLen)

Sets the maximum number of characters allowed in this text field.

Parameters:

maxLen - the maximum number of characters allowed in this text field.

setHorzTextAlign

void setHorzTextAlign(int justify)
               throws PDFException

Sets the text alignment for this field. The possible values are StyleConstants.ALIGN_LEFT, StyleConstants.ALIGN_CENTER and StyleConstants.ALIGN_RIGHT.

Parameters:

justify - The new value for the text alignment

Throws:

PDFException

getHorzTextAlign

int getHorzTextAlign()

Returns the horizontal text alignment property for this field. The possible return values are StyleConstants.ALIGN_LEFT, StyleConstants.ALIGN_CENTER and StyleConstants.ALIGN_RIGHT.

Returns:

The value of the horizontal text alignment property.