public class

TextFormConfiguration

extends FormElementConfiguration<T extends FormElement, K extends FormField>
java.lang.Object
   ↳ com.pspdfkit.forms.FormElementConfiguration<T extends com.pspdfkit.forms.FormElement, K extends com.pspdfkit.forms.FormField>
     ↳ com.pspdfkit.forms.TextFormConfiguration

Class Overview

Configuration class of TextFormElement for the creation of a TextFormField using addFormElementToPage(String, T).

Summary

Nested Classes
class TextFormConfiguration.Builder Builder used to construct TextFormConfiguration instance. 
[Expand]
Inherited Fields
From class com.pspdfkit.forms.FormElementConfiguration
Public Methods
int getMaxLength()
Maximum length of text allowed in the text field.
String getRichText()
String getText()
boolean isMultiLine()
Returns whether text is allowed to have multiple lines or not.
boolean isPassword()
Returns whether text is intended for entering a secure password that should not be visible on the screen.
boolean isSpellCheckEnabled()
Returns whether text entered in the field shall be spell-checked.
[Expand]
Inherited Methods
From class com.pspdfkit.forms.FormElementConfiguration
From class java.lang.Object

Public Methods

public int getMaxLength ()

Maximum length of text allowed in the text field.

Returns
  • Maximum length of text allowed or 0 if length is unlimited.

public String getRichText ()

public String getText ()

public boolean isMultiLine ()

Returns whether text is allowed to have multiple lines or not.

Returns
  • true when text is allowed to span multiple lines.

public boolean isPassword ()

Returns whether text is intended for entering a secure password that should not be visible on the screen.

Returns
  • true when text should be not echoed on screen.

public boolean isSpellCheckEnabled ()

Returns whether text entered in the field shall be spell-checked.

Returns
  • true when text content can be spell checked.