Package eltos.simpledialogfragment.form

Class SimpleFormDialog

java.lang.Object

androidx.fragment.app.Fragment

androidx.fragment.app.DialogFragment

eltos.simpledialogfragment.SimpleDialog<This>

eltos.simpledialogfragment.CustomViewDialog<SimpleFormDialog>

eltos.simpledialogfragment.form.SimpleFormDialog

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnDismissListener, android.view.View.OnCreateContextMenuListener, androidx.activity.result.ActivityResultCaller, androidx.lifecycle.HasDefaultViewModelProviderFactory, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner, SimpleDialog.OnDialogResultListener

public class SimpleFormDialog
extends CustomViewDialog<SimpleFormDialog>
implements SimpleDialog.OnDialogResultListener

A form dialog to display a number of input fields to the user, such as - Input fields (Input) - Check-boxes (Check) - Dropdown-menus (Spinner) Created by eltos on 20.02.17.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SimpleFormDialog.DialogActions	A Callback Class with useful methods used by FormElementViewHolder.setUpView(android.view.View, android.content.Context, android.os.Bundle, eltos.simpledialogfragment.form.SimpleFormDialog.DialogActions)
class	SimpleFormDialog.FocusActions	A Callback Class with useful methods used by FormElementViewHolder.focus(eltos.simpledialogfragment.form.SimpleFormDialog.FocusActions)
static interface	SimpleFormDialog.InputValidator

Nested classes/interfaces inherited from class eltos.simpledialogfragment.SimpleDialog

SimpleDialog.OnDialogResultListener

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTO_FOCUS
protected static final String	INPUT_FIELDS
protected static final String	SAVE_TAG
static final String	TAG

Fields inherited from class eltos.simpledialogfragment.SimpleDialog

BUNDLE, CANCELABLE, FULLSCREEN, HTML, ICON_RESOURCE, MESSAGE, NEGATIVE_BUTTON_TEXT, NEUTRAL_BUTTON_TEXT, POSITIVE_BUTTON_TEXT, THEME, TITLE

Fields inherited from class androidx.fragment.app.DialogFragment

STYLE_NO_FRAME, STYLE_NO_INPUT, STYLE_NO_TITLE, STYLE_NORMAL

Fields inherited from interface eltos.simpledialogfragment.SimpleDialog.OnDialogResultListener

BUTTON_NEGATIVE, BUTTON_NEUTRAL, BUTTON_POSITIVE, CANCELED

Constructor Summary

Constructors

Constructor	Description
SimpleFormDialog()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptsPositiveButtonPress()	Overwrite this method to catch positive button presses, e.g. if you need to verify input by the user Note: do not call CustomViewDialog.pressPositiveButton() here!
SimpleFormDialog	autofocus(boolean enabled)	En- or disables the automatic focussing of the first field in the form when the dialog opens.
static SimpleFormDialog	build()
static SimpleFormDialog	buildEmailInput(String emailFieldKey)	Convenient method to build a form dialog with a single email input
static SimpleFormDialog	buildLogin(String userFieldKey, String passwordFieldKey)	Convenient method to build a form dialog with a plain input alongside a password input for login with username and password
static SimpleFormDialog	buildLoginEmail(String emailFieldKey, String passwordFieldKey)	Convenient method to build a form dialog with an email input alongside a password input for login with email address and password
static SimpleFormDialog	buildNumberInput(String numberFieldKey)	Convenient method to build a form dialog with a single number input
static SimpleFormDialog	buildPasswordInput(String passwordFieldKey)	Convenient method to build a form dialog with a single password input
static SimpleFormDialog	buildPinCodeInput(String pinFieldKey)	Convenient method to build a form dialog with a single pin code input
static SimpleFormDialog	buildPinCodeInput(String pinFieldKey, int digits)	Convenient method to build a form dialog with a single pin code input
SimpleFormDialog	fields(FormElement... elements)	Convenient method to populate the form with form elements
android.view.View	onCreateContentView(android.os.Bundle savedInstanceState)	Method for view creation.
protected void	onDialogShown()	Overwrite this method to take action once the dialog is shown such as settings an input focus, showing the keyboard or setting the initial positiveButtonState
android.os.Bundle	onResult(int which)	Overwrite this method to provide additional results from your custom view to be passed to the SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)
boolean	onResult(String dialogTag, int which, android.os.Bundle extras)	Let the hosting fragment or activity implement this interface to receive results from the dialog
void	onSaveInstanceState(android.os.Bundle outState)
protected String	onValidateInput(String fieldKey, String input)
protected void	populateContainer(android.view.ViewGroup container, android.os.Bundle savedInstanceState)	Creates FormElements and adds them to the container
protected boolean	posButtonEnabled()
protected void	requestFocus(int viewIndex)

Methods inherited from class eltos.simpledialogfragment.CustomViewDialog

callResultListener, extractContentView, inflate, inflate, onCreate, onCreateDialog, onNegativeButtonClick, onNeutralButtonClick, onPositiveButtonClick, pressPositiveButton, setNegativeButtonEnabled, setNeutralButtonEnabled, setPositiveButtonEnabled

Methods inherited from class eltos.simpledialogfragment.SimpleDialog

cancelable, extra, fullscreen, fullscreen, getArgs, getArgString, getContext, getExtras, getMessage, getTitle, icon, isCancelable, msg, msg, msgHtml, msgHtml, neg, neg, neg, neut, neut, neut, onCancel, onDestroyView, pos, pos, setArg, setArg, setArg, setArg, setButtonClickListener, setButtonEnabled, show, show, show, show, show, show, show, show, showKeyboard, theme, title, title

Methods inherited from class androidx.fragment.app.DialogFragment

dismiss, dismissAllowingStateLoss, getDialog, getShowsDialog, getTheme, onAttach, onDetach, onDismiss, onGetLayoutInflater, onStart, onStop, onViewStateRestored, requireDialog, setCancelable, setShowsDialog, setStyle, setupDialog, showNow

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onResume, onViewCreated, postponeEnterTransition, postponeEnterTransition, registerForActivityResult, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface androidx.lifecycle.HasDefaultViewModelProviderFactory

getDefaultViewModelCreationExtras

Field Details

TAG

public static final String TAG

See Also:

• Constant Field Values

INPUT_FIELDS

protected static final String INPUT_FIELDS

See Also:

• Constant Field Values

AUTO_FOCUS

protected static final String AUTO_FOCUS

See Also:

• Constant Field Values

SAVE_TAG

protected static final String SAVE_TAG

See Also:

• Constant Field Values

Constructor Details

SimpleFormDialog

public SimpleFormDialog()

Method Details

build

public static SimpleFormDialog build()

buildEmailInput

public static SimpleFormDialog buildEmailInput(String emailFieldKey)

Convenient method to build a form dialog with a single email input

Parameters:

emailFieldKey - the key that can be used to receive the entered text from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

buildPasswordInput

public static SimpleFormDialog buildPasswordInput(String passwordFieldKey)

Convenient method to build a form dialog with a single password input

Parameters:

passwordFieldKey - the key that can be used to receive the entered text from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

buildPinCodeInput

public static SimpleFormDialog buildPinCodeInput(String pinFieldKey)

Convenient method to build a form dialog with a single pin code input

Parameters:

pinFieldKey - the key that can be used to receive the entered text from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

buildPinCodeInput

public static SimpleFormDialog buildPinCodeInput(String pinFieldKey,
 int digits)

Convenient method to build a form dialog with a single pin code input

Parameters:

pinFieldKey - the key that can be used to receive the entered text from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

digits - the length of the pin code

Returns:

this instance

buildNumberInput

public static SimpleFormDialog buildNumberInput(String numberFieldKey)

Convenient method to build a form dialog with a single number input

Parameters:

numberFieldKey - the key that can be used to receive the entered text from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

buildLoginEmail

public static SimpleFormDialog buildLoginEmail(String emailFieldKey,
 String passwordFieldKey)

Convenient method to build a form dialog with an email input alongside a password input for login with email address and password

Parameters:

emailFieldKey - the key that can be used to receive the entered email from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

passwordFieldKey - the key that can be used to receive the entered password from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

buildLogin

public static SimpleFormDialog buildLogin(String userFieldKey,
 String passwordFieldKey)

Convenient method to build a form dialog with a plain input alongside a password input for login with username and password

Parameters:

userFieldKey - the key that can be used to receive the entered username from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

passwordFieldKey - the key that can be used to receive the entered password from the bundle in SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Returns:

this instance

fields

public SimpleFormDialog fields(FormElement... elements)

Convenient method to populate the form with form elements

Parameters:

elements - the FormElements that form should contain

Returns:

this instance

autofocus

public SimpleFormDialog autofocus(boolean enabled)

En- or disables the automatic focussing of the first field in the form when the dialog opens. This is enabled by default.

Parameters:

enabled - whether or not to autofocus the first field

Returns:

this instance

onValidateInput

protected String onValidateInput(String fieldKey,
 @Nullable
 String input)

onDialogShown

protected void onDialogShown()

Description copied from class: CustomViewDialog

Overwrite this method to take action once the dialog is shown such as settings an input focus, showing the keyboard or setting the initial positiveButtonState

Overrides:

onDialogShown in class CustomViewDialog<SimpleFormDialog>

acceptsPositiveButtonPress

protected boolean acceptsPositiveButtonPress()

Description copied from class: CustomViewDialog

Overwrite this method to catch positive button presses, e.g. if you need to verify input by the user Note: do not call CustomViewDialog.pressPositiveButton() here!

Overrides:

acceptsPositiveButtonPress in class CustomViewDialog<SimpleFormDialog>

Returns:

false to ignore the press, true to process normally

posButtonEnabled

protected boolean posButtonEnabled()

requestFocus

protected void requestFocus(int viewIndex)

onCreateContentView

public android.view.View onCreateContentView(android.os.Bundle savedInstanceState)

Method for view creation. Inflates the layout and calls populateContainer(ViewGroup, Bundle) to populate the container with the fields specified

Specified by:

onCreateContentView in class CustomViewDialog<SimpleFormDialog>

Parameters:

savedInstanceState - The last saved instance state of the Fragment, or null if this fragment is created for the first time.

Returns:

inflated view

populateContainer

protected void populateContainer(@NonNull
 android.view.ViewGroup container,
 @Nullable
 android.os.Bundle savedInstanceState)

Creates FormElements and adds them to the container

Parameters:

container - the container to hold the FormElements

savedInstanceState - saved state

onResult

public android.os.Bundle onResult(int which)

Description copied from class: CustomViewDialog

Overwrite this method to provide additional results from your custom view to be passed to the SimpleDialog.OnDialogResultListener.onResult(java.lang.String, int, android.os.Bundle)

Overrides:

onResult in class CustomViewDialog<SimpleFormDialog>

Parameters:

which - see SimpleDialog.OnDialogResultListener

Returns:

the bundle to merge with the results or null

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class androidx.fragment.app.DialogFragment

onResult

public boolean onResult(@NonNull
 String dialogTag,
 int which,
 @NonNull
 android.os.Bundle extras)

Description copied from interface: SimpleDialog.OnDialogResultListener

Let the hosting fragment or activity implement this interface to receive results from the dialog

Specified by:

onResult in interface SimpleDialog.OnDialogResultListener

Parameters:

dialogTag - the tag passed to SimpleDialog.show(androidx.fragment.app.Fragment)

which - result type, one of SimpleDialog.OnDialogResultListener.BUTTON_POSITIVE, SimpleDialog.OnDialogResultListener.BUTTON_NEGATIVE, SimpleDialog.OnDialogResultListener.BUTTON_NEUTRAL or SimpleDialog.OnDialogResultListener.CANCELED

extras - the extras passed to SimpleDialog.extra(Bundle)

Returns:

true if the result was handled, false otherwise