public interface

FormEditingController

implements FragmentSpecialModeController
com.pspdfkit.ui.special_mode.controller.FormEditingController

Class Overview

Default controller given when entering forms editing mode. Used to control form editing mode actions.

Summary

Public Methods
abstract void bindFormElementViewController(FormElementViewController controller)
Binds to the form element view controller for managing currently edited form element view.
abstract boolean canClearFormField()
Checks whether selected form element value can be cleared.
abstract boolean clearFormField()
Clears selected form element value.
abstract boolean finishEditing()
Finish form editor immediately.
abstract FormElement getCurrentlySelectedFormElement()
Returns currently selected form element (if any).
abstract FormManager getFormManager()
Returns the form manager which can be used to register form editing listeners.
abstract boolean hasNextElement()
Checks whether next element in tab order is defined.
abstract boolean hasPreviousElement()
Checks whether previous element in tab order is defined.
abstract boolean selectNextFormElement()
Selects the next form element in tab order.
abstract boolean selectPreviousFormElement()
Selects the previous form element in tab order.
abstract void unbindFormElementViewController()
Unbinds from previously bound form element view controller.
[Expand]
Inherited Methods
From interface com.pspdfkit.ui.special_mode.controller.base.FragmentSpecialModeController
From interface com.pspdfkit.ui.special_mode.controller.base.SpecialModeController

Public Methods

public abstract void bindFormElementViewController (FormElementViewController controller)

Binds to the form element view controller for managing currently edited form element view.

Parameters
controller Controller for managing form element view editing.

public abstract boolean canClearFormField ()

Checks whether selected form element value can be cleared.

Returns
  • true when selected form element can be cleared.

public abstract boolean clearFormField ()

Clears selected form element value.

Returns
  • true when form element has been cleared.

public abstract boolean finishEditing ()

Finish form editor immediately.

Returns
  • true when form editing has been exited.

public abstract FormElement getCurrentlySelectedFormElement ()

Returns currently selected form element (if any).

Returns
  • Currently edited form element, null if none is currently edited.

public abstract FormManager getFormManager ()

Returns the form manager which can be used to register form editing listeners.

Returns
  • Forms manager managing the form editing listeners.

public abstract boolean hasNextElement ()

Checks whether next element in tab order is defined.

Returns
  • true when tab order has next element.

public abstract boolean hasPreviousElement ()

Checks whether previous element in tab order is defined.

Returns
  • true when tab order has previous element.

public abstract boolean selectNextFormElement ()

Selects the next form element in tab order.

Returns
  • true if new element was selected, false otherwise.
See Also

public abstract boolean selectPreviousFormElement ()

Selects the previous form element in tab order.

Returns
  • true if new element was selected, false otherwise.
See Also

public abstract void unbindFormElementViewController ()

Unbinds from previously bound form element view controller.