Constructor Detail

• FormEditingBar

  FormEditingBar(Context context)

• FormEditingBar

  FormEditingBar(Context context, AttributeSet attrs)

• FormEditingBar

  FormEditingBar(Context context, AttributeSet attrs, int defStyleAttr)

• FormEditingBar

  FormEditingBar(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Method Detail

• isDisplayed

   boolean isDisplayed()

  True when form input bar is currently displayed on the screen.

• setVisibility

   void setVisibility(int visibility)

• getBackgroundColor

   int getBackgroundColor()

  Returns background color set to the form editing bar.

  Returns:

  Background color applied to this form editing bar.

• setBackgroundColor

   void setBackgroundColor(int backgroundColor)

  Sets background color to the form editing bar.

  Parameters:

  backgroundColor - Background color to be applied to this form editing bar.

• getTextColor

   int getTextColor()

  Return color of the text on this form editing bar.

  Returns:

  Text color on form editing bar.

• setTextColor

   void setTextColor(int textColor)

  Sets color of the text on this form editing bar.

  Parameters:

  textColor - Text color on form editing bar.

• getIconsColor

   int getIconsColor()

  Returns color of the icons on this form editing bar.

  Returns:

  Tint of the icons on the bar.

• setIconsColor

   void setIconsColor(int iconColor)

  Sets color of the icons on this form editing bar.

  Parameters:

  iconColor - Tint of the icons on the bar.

• getPrevIcon

   int getPrevIcon()

  Return resource id of the icon marking navigation to the previous form.

  Returns:

  Previous form navigation button icon.

• setPrevIcon

   void setPrevIcon(int prevIconResId)

  Sets resource id of the icon marking navigation to the previous form.

  Parameters:

  prevIconResId - Previous form navigation button icon.

• getNextIcon

   int getNextIcon()

  Return resource id of the icon marking navigation to the next form.

  Returns:

  Next form navigation button icon.

• setNextIcon

   void setNextIcon(int nextIconResId)

  Sets resource id of the icon marking navigation to the next form.

  Parameters:

  nextIconResId - Next form navigation button icon.

• onClick

   void onClick(View v)

• addOnFormEditingBarLifecycleListener

   void addOnFormEditingBarLifecycleListener(@NonNull() FormEditingBar.OnFormEditingBarLifecycleListener listener)

  Adds an OnFormEditingBarLifecycleListener for listening to the form editing bar lifecycle. If the listener has already been added previously, this method will be a no-op. Passing null is not allowed and will result in an exception.

  Parameters:

  listener - OnFormEditingBarLifecycleListener that should be notified.

• removeOnFormEditingBarLifecycleListener

   void removeOnFormEditingBarLifecycleListener(@NonNull() FormEditingBar.OnFormEditingBarLifecycleListener listener)

  Removes a previously added OnFormEditingBarLifecycleListener. Upon calling this method the listener will no longer be notified of any lifecycle changes. If the listener has not been added previously, this method will be a no-op. Passing null is not allowed, and will result in an exception.

  Parameters:

  listener - OnFormEditingBarLifecycleListener that should be removed.

• bindController

   void bindController(@NonNull() FormEditingController controller)

  Binds to form editing controller. Animates form editing bar into view.

• unbindController

   void unbindController()

  Unbinds from form editing controller. Animates form editing bar out of view.

• onEnterFormElementEditingMode

   void onEnterFormElementEditingMode(@NonNull() FormEditingController controller)

  Called when form element editing mode has been entered.

  Parameters:

  controller - Controller for managing form element editing.

• onChangeFormElementEditingMode

   void onChangeFormElementEditingMode(@NonNull() FormEditingController controller)

  Called then form element editing mode changes, meaning another form element is being selected for editing.

  Parameters:

  controller - Controller for managing form element editing.

• onExitFormElementEditingMode

   void onExitFormElementEditingMode(@NonNull() FormEditingController controller)

  Called when form element editing mode has been exited.

  Parameters:

  controller - Controller for managing form element editing.

• onFormElementUpdated

   void onFormElementUpdated(@NonNull() FormElement formElement)

  Called when form element gets updated.

  Parameters:

  formElement - Form element that has been updated.

• onFormElementViewUpdated

   void onFormElementViewUpdated(@NonNull() FormElement formElement)

  Called whenever form element view gets updated, listeners should update their UI accordingly.

• onFormElementValidationSuccess

   void onFormElementValidationSuccess(@NonNull() FormElement formElement)

  Called when form element validation succeeded.

  Parameters:

  formElement - Form element that failed to validate.

• onFormElementValidationFailed

   void onFormElementValidationFailed(@NonNull() FormElement formElement, @NonNull() String validationError)

  Called when form element validation fails.

  Parameters:

  formElement - Form element that failed to validate.

  validationError - Localized validation error.