de.dimensionv.android.androdialogs

Class BaseDialogFragment<T extends ActionHandler>

java.lang.Object

android.app.Fragment

android.app.DialogFragment

de.dimensionv.android.androdialogs.BaseDialogFragment<T>

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, android.view.View.OnCreateContextMenuListener, DialogFragmentInterface

Direct Known Subclasses:

ConfirmDeletionDialogFragment, DisplayDialogFragment, HintDialogFragment, InputDialogFragment, NotificationDialogFragment

public abstract class BaseDialogFragment<T extends ActionHandler>
extends android.app.DialogFragment
implements DialogFragmentInterface

An abstract base-class for easing automated dialog creation.

This class will make use of the ConfirmationActionHandler. Should the Activity calling this dialog not implement this interface, a ClassCastException will be thrown with an appropriate error-message.

Since:

API 1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class android.app.Fragment

android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
protected FragmentDialogController<T>	controller

Fields inherited from class android.app.DialogFragment

STYLE_NO_FRAME, STYLE_NO_INPUT, STYLE_NO_TITLE, STYLE_NORMAL

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
BaseDialogFragment(Class<T> type) Default constructor, actually forwarding to BaseDialogFragment(boolean registerHandler) with registerHandler being set to true.
BaseDialogFragment(Class<T> type, boolean registerHandler) This constructor initializes the BaseDialogFragment.

Method Summary

Methods

Modifier and Type	Method and Description
protected android.view.View	callInterceptor(android.view.View view) Calls the ViewInterceptor of this BaseDialogFragment.
String	getDialogTag() Returns the tag under which this dialog can be registered with the fragment manager.
protected ViewInterceptor	getViewInterceptor() Returns the ViewInterceptor of this BaseDialogFragment.
boolean	isRegisterHandler() Returns the registerHandler flag, which is used to determine whether an ActionHandler should be registered or not.
void	onAttach(android.app.Activity activity) Called when a fragment is first attached to its activity.
android.app.Dialog	onCreateDialog(android.os.Bundle savedInstanceState) Shows an AlertDialog, set the buttons and populate the Dialog with content.
abstract void	populateDialog(android.app.AlertDialog.Builder builder, android.os.Bundle arguments) Abstract method to populate the given builder-object with appropriate content.
void	setActionHandler(T handler)
void	setRegisterHandler(boolean registerHandler) Sets the flag whether to allow registering of an ActionHandler.
void	setViewInterceptor(ViewInterceptor interceptor) Sets the ViewInterceptor for this BaseDialogFragment.

Methods inherited from class android.app.DialogFragment

dismiss, dismissAllowingStateLoss, dump, getDialog, getShowsDialog, getTheme, isCancelable, onActivityCreated, onCancel, onCreate, onDestroyView, onDetach, onDismiss, onSaveInstanceState, onStart, onStop, setCancelable, setShowsDialog, setStyle, show, show

Methods inherited from class android.app.Fragment

equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getEnterTransition, getExitTransition, getFragmentManager, getId, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isVisible, onActivityResult, onConfigurationChanged, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onResume, onTrimMemory, onViewCreated, onViewStateRestored, registerForContextMenu, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.dimensionv.android.androdialogs.common.DialogFragmentInterface

getActivity, getArguments

Methods inherited from interface android.content.DialogInterface.OnCancelListener

onCancel

Methods inherited from interface android.content.DialogInterface.OnClickListener

onClick

Field Detail

controller

protected FragmentDialogController<T extends ActionHandler> controller

Constructor Detail

BaseDialogFragment

public BaseDialogFragment(Class<T> type)

Default constructor, actually forwarding to BaseDialogFragment(boolean registerHandler) with registerHandler being set to true.

BaseDialogFragment

public BaseDialogFragment(Class<T> type,
                  boolean registerHandler)

This constructor initializes the BaseDialogFragment. All descendents must call through to either this or the default constructor.

The registerHandler parameter is used to allow or forbid registering the parent Activity as an ActionHandler.

In case it is forbidden, the method setActionHandler() can (and should) be used to set an ActionHandler manually that can actually be any class, not just the parent Activity.

Parameters:

registerHandler - Flag whether to register an ActionHandler or not.

Method Detail

onCreateDialog

public android.app.Dialog onCreateDialog(android.os.Bundle savedInstanceState)

Shows an AlertDialog, set the buttons and populate the Dialog with content.

Overrides:

onCreateDialog in class android.app.DialogFragment

Parameters:

savedInstanceState - The last saved instance state of the Fragment, or null if this is a freshly created Fragment.

Returns:

Return a new Dialog instance to be displayed by the Fragment.

onAttach

public void onAttach(android.app.Activity activity)

Called when a fragment is first attached to its activity. onCreate(Bundle) will be called after this.

Overrides:

onAttach in class android.app.DialogFragment

Parameters:

activity - the Activity this dialog is attached to.

populateDialog

public abstract void populateDialog(android.app.AlertDialog.Builder builder,
                  android.os.Bundle arguments)

Abstract method to populate the given builder-object with appropriate content.

Specified by:

populateDialog in interface DialogFragmentInterface

Parameters:

builder - The Builder-object that should be populated and represents the actual dialog

arguments - The arguments of the DialogFragment, as retrievable via getArguments().

setActionHandler

public void setActionHandler(T handler)

Parameters:

handler - the handler to set

isRegisterHandler

public boolean isRegisterHandler()

Returns the registerHandler flag, which is used to determine whether an ActionHandler should be registered or not.

Returns:

the registerHandler

setRegisterHandler

public void setRegisterHandler(boolean registerHandler)

Sets the flag whether to allow registering of an ActionHandler.

Parameters:

registerHandler - Flag whether to register a handler or not.

See Also:

ActionHandler

setViewInterceptor

public void setViewInterceptor(ViewInterceptor interceptor)

Sets the ViewInterceptor for this BaseDialogFragment.

Parameters:

interceptor - The ViewInterceptor for this BaseDialogFragment.

See Also:

ViewInterceptor

getViewInterceptor

protected ViewInterceptor getViewInterceptor()

Returns the ViewInterceptor of this BaseDialogFragment.

Returns:

The ViewInterceptor of this BaseDialogFragment.

callInterceptor

protected android.view.View callInterceptor(android.view.View view)

Calls the ViewInterceptor of this BaseDialogFragment.

Parameters:

view - The View containing this dialog's UI elements

Returns:

The view that's been handed over to this method.

getDialogTag

public String getDialogTag()

Returns the tag under which this dialog can be registered with the fragment manager.

Returns:

The default tag under which the dialog can be registered with the FragmentManager.