public abstract class

FormElement

extends Object
java.lang.Object
   ↳ com.pspdfkit.forms.FormElement
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A visible form control. Every form element has a single parent FormField. Each form element is associated with a single WidgetAnnotation that is a visual representation of the form element in the document.

Summary

Public Methods
boolean equals(Object o)
WidgetAnnotation getAnnotation()
Retrieve widget annotation for this form element.
FormField getFormField()
Retrieve parent form field.
String getFullyQualifiedName()
Returns the fully qualified name for the form element.
String getName()
Returns the name for the form element.
FormElement getNextElement()
Returns next form element in tab order.
FormElement getPreviousElement()
Returns previous form element in tab order.
abstract FormType getType()
Returns type of the form field.
int hashCode()
boolean isReadOnly()
If set, the user may not change the value of this form field.
boolean isRequired()
If set, the field shall have a value at the time it is exported by a submit-form action.
void setNextElement(FormElement nextElement)
Sets next element in form tab order, may be null.
void setPreviousElement(FormElement prevElement)
Sets previous element in form tab order, may be null.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean equals (Object o)

public WidgetAnnotation getAnnotation ()

Retrieve widget annotation for this form element.

Returns
  • Widget annotation that is a visual representation of this form element.

public FormField getFormField ()

Retrieve parent form field.

Returns
  • Attached parent form field.

public String getFullyQualifiedName ()

Returns the fully qualified name for the form element.

Returns
  • Returns fully qualified name for the form element including the parents names separated by `.`
See Also
  • FormField#getFullyQualifiedNameForFormElement(FormElement)

public String getName ()

Returns the name for the form element.

Returns
  • Returns name for form element.
See Also
  • FormField#getNameForFormElement(FormElement)

public FormElement getNextElement ()

Returns next form element in tab order.

Returns
  • Next form element in tab order or null if this element is the last element in tab order.

public FormElement getPreviousElement ()

Returns previous form element in tab order.

Returns
  • Previous form element in tab order or null if this element is the first element in tab order.

public abstract FormType getType ()

Returns type of the form field.

Returns
  • The type of the parent form field.

public int hashCode ()

public boolean isReadOnly ()

If set, the user may not change the value of this form field. This flag is useful for fields whose values are computed or imported from a database.

Returns
  • true when field is read-only.

public boolean isRequired ()

If set, the field shall have a value at the time it is exported by a submit-form action.

Returns
  • true when field is required.

public void setNextElement (FormElement nextElement)

Sets next element in form tab order, may be null.

Parameters
nextElement next element in form tab order.

public void setPreviousElement (FormElement prevElement)

Sets previous element in form tab order, may be null.

Parameters
prevElement previous element in form tab order.