Interface FormEditingController
-
- All Implemented Interfaces:
-
com.pspdfkit.ui.special_mode.controller.base.FragmentSpecialModeController
,com.pspdfkit.ui.special_mode.controller.base.SpecialModeController
public interface FormEditingController implements FragmentSpecialModeController
Default controller given when entering forms editing mode. Used to control form editing mode actions.
-
-
Method Summary
Modifier and Type Method Description 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
selectPreviousFormElement()
Selects the previous form element in tab order. abstract boolean
selectNextFormElement()
Selects the next form element in tab order. abstract boolean
hasPreviousElement()
Checks whether previous element in tab order is defined. abstract boolean
hasNextElement()
Checks whether next element in tab order is defined. 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 void
bindFormElementViewController(@NonNull() FormElementViewController controller)
Binds to the form element view controller for managing currently edited form element view. abstract void
unbindFormElementViewController()
Unbinds from previously bound form element view controller. -
-
Method Detail
-
getCurrentlySelectedFormElement
@Nullable() abstract FormElement getCurrentlySelectedFormElement()
Returns currently selected form element (if any).
- Returns:
Currently edited form element,
null
if none is currently edited.
-
getFormManager
@NonNull() abstract FormManager getFormManager()
Returns the form manager which can be used to register form editing listeners.
- Returns:
Forms manager managing the form editing listeners.
-
selectPreviousFormElement
abstract boolean selectPreviousFormElement()
Selects the previous form element in tab order.
- Returns:
true
if new element was selected,false
otherwise.
-
selectNextFormElement
abstract boolean selectNextFormElement()
Selects the next form element in tab order.
- Returns:
true
if new element was selected,false
otherwise.
-
hasPreviousElement
abstract boolean hasPreviousElement()
Checks whether previous element in tab order is defined.
- Returns:
true
when tab order has previous element.
-
hasNextElement
abstract boolean hasNextElement()
Checks whether next element in tab order is defined.
- Returns:
true
when tab order has next element.
-
canClearFormField
abstract boolean canClearFormField()
Checks whether selected form element value can be cleared.
- Returns:
true
when selected form element can be cleared.
-
clearFormField
abstract boolean clearFormField()
Clears selected form element value.
- Returns:
true
when form element has been cleared.
-
finishEditing
abstract boolean finishEditing()
Finish form editor immediately.
- Returns:
true
when form editing has been exited.
-
bindFormElementViewController
abstract void bindFormElementViewController(@NonNull() 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.
-
unbindFormElementViewController
abstract void unbindFormElementViewController()
Unbinds from previously bound form element view controller.
-
-
-
-