pspdfkit/com.pspdfkit.ui.forms/FormEditingBar

FormEditingBar

open class FormEditingBar : FrameLayout, View.OnClickListener, FormManager.OnFormElementUpdatedListener, FormManager.OnFormElementEditingModeChangeListener, FormManager.OnFormElementViewUpdatedListener

Bottom auxiliary bar displayed when filling forms. Provides buttons for navigating between form fields in tab order, clearing form field and finishing with form editing.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int)

Types

Link copied to clipboard
interface OnFormEditingBarLifecycleListener
Listener for the lifecycle of the FormEditingBar.

Properties

Link copied to clipboard
open val isDisplayed: Boolean

Functions

Link copied to clipboard
open fun addOnFormEditingBarLifecycleListener(@NonNull listener: FormEditingBar.OnFormEditingBarLifecycleListener)
Adds an OnFormEditingBarLifecycleListener for listening to the form editing bar lifecycle.
Link copied to clipboard
open fun bindController(@NonNull controller: FormEditingController)
Binds to form editing controller.
Link copied to clipboard
open fun getBackgroundColor(): Int
Returns background color set to the form editing bar.
Link copied to clipboard
open fun getIconsColor(): Int
Returns color of the icons on this form editing bar.
Link copied to clipboard
open fun getNextIcon(): Int
Return resource id of the icon marking navigation to the next form.
Link copied to clipboard
open fun getPrevIcon(): Int
Return resource id of the icon marking navigation to the previous form.
Link copied to clipboard
open fun getTextColor(): Int
Return color of the text on this form editing bar.
Link copied to clipboard
open fun onChangeFormElementEditingMode(@NonNull controller: FormEditingController)
Called then form element editing mode changes, meaning another form element is being selected for editing.
Link copied to clipboard
open fun onClick(v: View)
Link copied to clipboard
open fun onEnterFormElementEditingMode(@NonNull controller: FormEditingController)
Called when form element editing mode has been entered.
Link copied to clipboard
open fun onExitFormElementEditingMode(@NonNull controller: FormEditingController)
Called when form element editing mode has been exited.
Link copied to clipboard
open fun onFormElementUpdated(@NonNull formElement: FormElement)
Called when form element gets updated.
Link copied to clipboard
open fun onFormElementValidationFailed(@NonNull formElement: FormElement, @NonNull validationError: String)
Called when form element validation fails.
Link copied to clipboard
open fun onFormElementValidationSuccess(@NonNull formElement: FormElement)
Called when form element validation succeeded.
Link copied to clipboard
open fun onFormElementViewUpdated(@NonNull formElement: FormElement)
Called whenever form element view gets updated, listeners should update their UI accordingly.
Link copied to clipboard
Link copied to clipboard
open fun setBackgroundColor(backgroundColor: Int)
Sets background color to the form editing bar.
Link copied to clipboard
open fun setIconsColor(iconColor: Int)
Sets color of the icons on this form editing bar.
Link copied to clipboard
open fun setNextIcon(nextIconResId: Int)
Sets resource id of the icon marking navigation to the next form.
Link copied to clipboard
open fun setPrevIcon(prevIconResId: Int)
Sets resource id of the icon marking navigation to the previous form.
Link copied to clipboard
open fun setTextColor(textColor: Int)
Sets color of the text on this form editing bar.
Link copied to clipboard
open fun setVisibility(visibility: Int)
Link copied to clipboard
open fun unbindController()
Unbinds from form editing controller.